-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Docs: Button and ButtonLink have isSymmetrical prop instead of isSqua…
…re #DS-1484
- Loading branch information
Showing
3 changed files
with
100 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
# Migration Guide | ||
|
||
Introducing version 3 of the _spirit-web-react_ package. | ||
|
||
> Please follow these steps to safely upgrade to Spirit Design System v3 components. | ||
> ℹ️ Don't forget to check the [migration guide of the _spirit-web_ package][migration-guide-web] for general changes in | ||
> available feature flags, CSS, and other changes that might affect your project. | ||
## Overview | ||
|
||
- [Component Changes](#component-changes) | ||
- [Button and ButtonLink: `isSquare` prop](#button-and-buttonlink-issquare-prop-renamed-to-issymmetrical) | ||
|
||
## Component Changes | ||
|
||
### Button and ButtonLink: `isSquare` prop renamed to `isSymmetrical` | ||
|
||
Button `isSquare` prop was renamed to `isSymmetrical`. | ||
|
||
#### Migration Guide | ||
|
||
🪄 Use codemods to automatically update your codebase: | ||
|
||
```sh | ||
npx @lmc-eu/spirit-codemods -p <path> -t v3/web-react/button-isSquare-prop-name | ||
npx @lmc-eu/spirit-codemods -p <path> -t v3/web-react/buttonLink-isSquare-prop-name | ||
``` | ||
|
||
👉 See [Codemods documentation][readme-codemods] for more details. | ||
|
||
<details> | ||
<summary>🔧 Manual Migration Steps</summary> | ||
|
||
Manually replace the props in your project. | ||
|
||
- `<Button isSquare … />` → `<Button isSymmetrical … />` | ||
- `<ButtonLink isSquare … />` → `<ButtonLink isSymmetrical … />` | ||
</details> | ||
|
||
--- | ||
|
||
Please refer back to these instructions or reach out to our team if you encounter any issues during migration. | ||
|
||
[migration-guide-web]: https://github.com/lmc-eu/spirit-design-system/blob/main/docs/migrations/web/MIGRATION-v3.md | ||
[readme-codemods]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/codemods/README.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# Migration Guide | ||
|
||
Introducing version 4 of the _spirit-web-twig_ package. | ||
|
||
> Please follow these steps to safely upgrade to Spirit Design System v4 components. | ||
> ℹ️ Don't forget to check the [migration guide of the _spirit-web_ package][migration-guide-web] for general changes in | ||
> available feature flags, CSS, JavaScript plugins, and other changes that might affect your project. | ||
## Overview | ||
|
||
- [Component Changes](#component-changes) | ||
- [Button and ButtonLink: `isSquare` prop](#button-and-buttonlink-issquare-prop-renamed-to-issymmetrical) | ||
|
||
## Component Changes | ||
|
||
### Button and ButtonLink: `isSquare` prop renamed to `isSymmetrical` | ||
|
||
Button `isSquare` prop was renamed to `isSymmetrical`. | ||
|
||
#### Migration Guide | ||
|
||
- `<Button isSquare … />` → `<Button isSymmetrical … />` | ||
- `<ButtonLink isSquare … />` → `<ButtonLink isSymmetrical … />` | ||
|
||
--- | ||
|
||
Please refer back to this guide or reach out to our team if you encounter any issues during migration. | ||
|
||
[migration-guide-web]: https://github.com/lmc-eu/spirit-design-system/blob/main/docs/migrations/web/MIGRATION-v3.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# Migration Guide | ||
|
||
Introducing version 3 of the _spirit-web_ package. | ||
|
||
> Please follow these steps to safely upgrade to Spirit Design System v3 components. | ||
## Overview | ||
|
||
- [Component Changes](#component-changes) | ||
- [Button: renamed modifier `square`](#button-square-modifier-renamed-to-symmetrical) | ||
|
||
## Component Changes | ||
|
||
### Button: `square` modifier renamed to `symmetrical` | ||
|
||
Button `square` modifier was renamed to `symmetrical`. | ||
|
||
#### Migration Guide | ||
|
||
Instead of using `.Button--square`, use a `.Button--symmetrical`. | ||
|
||
- `.Button--square` → `.Button--symmetrical` | ||
|
||
--- |