Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs(web): List Deprecations in the web package #DS-1043 #1301

Merged
merged 1 commit into from
Mar 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions DEPRECATIONS-v2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Deprecations

Introducing deprecations and feature flags to be removed in the version 2 lists.

💁 Please follow these steps to safely upgrade your Design System to Spirit Design System v2 components.
crishpeen marked this conversation as resolved.
Show resolved Hide resolved

## spirit-web v2
crishpeen marked this conversation as resolved.
Show resolved Hide resolved

- [Deprecations][web-deprecations-v2]

## spirit-web-react v2

- [Deprecations][web-react-deprecations-v2]

## spirit-web-twig v2

- _spirit-web-twig_ was released as version 2 already. See the [CHANGELOG][twig-changelog] for more details or refer to the [migration guide][twig-migration-v2].

---

Please refer back to this list or reach out to our team if you encounter any issues during migration.

[web-deprecations-v2]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web/DEPRECATIONS-v2.md
[web-react-deprecations-v2]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/DEPRECATIONS-v2.md
[twig-changelog]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-twig/CHANGELOG.md
[twig-migration-v2]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-twig/MIGRATION-v2.md
13 changes: 13 additions & 0 deletions DEPRECATIONS-v3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Deprecations

Introducing deprecations and feature flags to be removed in the version 3 lists.

💁 Please follow these steps to safely upgrade your Design System to Spirit Design System v3 components.

## spirit-web-twig v3

- [Deprecations](./packages/web-twig/DEPRECATIONS-v3.md)

---

Please refer back to this list or reach out to our team if you encounter any issues during migration.
101 changes: 101 additions & 0 deletions packages/web/DEPRECATIONS-v2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
# Deprecations List

Following deprecations and feature flags will be removed in version 2 of the _spirit-web_ package.

> Please follow these steps to safely upgrade your design system to Spirit Design System v2 components.

[What are deprecations?][readme-deprecations]

[What are feature flags?][readme-feature-flags]

## Feature Flags

### Dropdown Shadow

The feature flag enabling the dropdown shadow will be removed and the enhanced
shadow will be enabled by default.

### Modal Uniform Variant

The feature flag enabling the uniform variant of modal will be removed and the
uniform variant will be enabled by default.

### Tooltip Data Selector Controlled Placement

The feature flag enabling the data selector controlled placement (`data-spirit-placement-controlled`)
for tooltip will be removed and the data selector controlled placement will be enabled by default.

### Alert Bordered

The feature flag enabling the bordered variant of alert will be removed and the bordered variant will
be enabled by default.

## Deprecations

### Tooltip and Dropdown Placements

The `Tooltip` and `Dropdown` components will no longer support non-flows relative placements.

Also, placement classes for Tooltip and Dropdown will be removed.

#### Migration Guide

Instead of using `Tooltip--top`/`Dropdown--top` or `Tooltip--topLeft`/`Dropdown--topLeft`,
use data attribute like`data-spirit-placement="top"` or `data-spirit-placement="top-start"`.
See [Placement dictionary][dictionary-placement] for more details.

- `.Tooltip--topLeft` → `data-spirit-placement="top-start"`
- `.Tooltip--top` → `data-spirit-placement="top"`
- `.Tooltip--topRight` → `data-spirit-placement="top-end"`
- `.Tooltip--rightTop` → `data-spirit-placement="right-start"`
- `.Tooltip--right` → `data-spirit-placement="right"`
- `.Tooltip--rightBottom` → `data-spirit-placement="right-end"`
- `.Tooltip--bottomRight` → `data-spirit-placement="bottom-end"`
- `.Tooltip--bottom` → `data-spirit-placement="bottom"`
- `.Tooltip--bottomLeft` → `data-spirit-placement="bottom-start"`
- `.Tooltip--leftBottom` → `data-spirit-placement="left-end"`
- `.Tooltip--left` → `data-spirit-placement="left"`
- `.Tooltip--leftTop` → `data-spirit-placement="left-start"`
- `.Dropdown--topLeft` → `data-spirit-placement="top-start"`
- `.Dropdown--top` → `data-spirit-placement="top"`
- `.Dropdown--topRight` → `data-spirit-placement="top-end"`
- `.Dropdown--rightTop` → `data-spirit-placement="right-start"`
- `.Dropdown--right` → `data-spirit-placement="right"`
- `.Dropdown--rightBottom` → `data-spirit-placement="right-end"`
- `.Dropdown--bottomRight` → `data-spirit-placement="bottom-end"`
- `.Dropdown--bottom` → `data-spirit-placement="bottom"`
- `.Dropdown--bottomLeft` → `data-spirit-placement="bottom-start"`
- `.Dropdown--leftBottom` → `data-spirit-placement="left-end"`
- `.Dropdown--left` → `data-spirit-placement="left"`
- `.Dropdown--leftTop` → `data-spirit-placement="left-start"`

### Dropdown Combined Placements

Combined placement classes for dropdown will be removed.

#### Migration Guide

Instead of using `.Dropdown--bottom.Dropdown--left`, use combination `bottom-start` in placement data attribute.

- `.Dropdown--top.Dropdown--left` → `data-spirit-placement="top-start"`
- `.Dropdown--top.Dropdown--right` → `data-spirit-placement="top-end"`
- `.Dropdown--bottom.Dropdown--left` → `data-spirit-placement="bottom-start"`
- `.Dropdown--bottom.Dropdown--right` → `data-spirit-placement="bottom-end"`
- `.Dropdown--left.Dropdown--top` → `data-spirit-placement="left-start"`
- `.Dropdown--left.Dropdown--bottom` → `data-spirit-placement="left-end"`
- `.Dropdown--right.Dropdown--top` → `data-spirit-placement="right-start"`
- `.Dropdown--right.Dropdown--bottom` → `data-spirit-placement="right-end"`

### Modal (Non)Scrollable

The `.ModalDialog--nonScrollable` modifier will be removed and the ModalDialog will be made non-scrollable by default.

#### Migration Guide

In the new version, use the `.ModalDialog--scrollable` modifier class to make the ModalDialog scrollable.

- `.ModalDialog` → `.ModalDialog .ModalDialog--scrollable`

[readme-deprecations]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web/README.md#deprecations
[readme-feature-flags]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web/README.md#feature-flags
[dictionary-placement]: https://github.com/lmc-eu/spirit-design-system/blob/main/docs/DICTIONARIES.md#placement
Loading