Skip to content

Commit

Permalink
Docs: Button and ButtonLink have isSymmetrical prop instead of isSqua…
Browse files Browse the repository at this point in the history
…re #DS-1484
  • Loading branch information
curdaj committed Oct 4, 2024
1 parent 1b8c9fb commit 11cd047
Show file tree
Hide file tree
Showing 3 changed files with 102 additions and 0 deletions.
46 changes: 46 additions & 0 deletions docs/migrations/web-react/MIGRATION-v3.md
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 v2/web-react/button-prop-name
npx @lmc-eu/spirit-codemods -p <path> -t v2/web-react/buttonLink-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
30 changes: 30 additions & 0 deletions docs/migrations/web-twig/MIGRATION-v4.md
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
26 changes: 26 additions & 0 deletions docs/migrations/web/MIGRATION-v3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# 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 and ButtonLink: renamed modifier `square`](#button-and-buttonlink-square-modifier-renamed-to-symmetrical)

## Component Changes

### Button and ButtonLink: `square` modifier renamed to `symmetrical`

Button `isSquare` prop was renamed to `isSymmetrical`.

#### Migration Guide

Instead of using `.Button--square` or `.ButtonLink--square`, use a `.Button--symmetrical` or
`.ButtonLink--symmetrical`.

- `.Button--square``.Button--symmetrical`
- `.ButtonLink--square``.ButtonLink--symmetrical`

---

0 comments on commit 11cd047

Please sign in to comment.