Skip to content

Commit

Permalink
Docs(web-twig): Introduce Migration Guide to version 4
Browse files Browse the repository at this point in the history
  • Loading branch information
crishpeen committed Nov 5, 2024
1 parent cde6a97 commit d0f1f55
Showing 1 changed file with 77 additions and 10 deletions.
87 changes: 77 additions & 10 deletions docs/migrations/web-twig/MIGRATION-v4.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,21 @@ Introducing version 4 of the _spirit-web-twig_ package.
## Overview

- [Component Changes](#component-changes)
- [Button and ButtonLink: `isSquare` prop](#button-and-buttonlink-issquare-prop-renamed-to-issymmetrical)
- [Heading elementType prop is now mandatory](#heading-elementtype-prop-is-now-mandatory)
- [Link `hasVisitedStyleAllowed`](#link-hasvisitedstyleallowed)
- [Link `isUnderlined`](#link-isunderlined)
- [Button and ButtonLink: `isSquare` Prop Renamed to `isSymmetrical`](#button-and-buttonlink-issquare-prop-renamed-to-issymmetrical)
- [Button and ButtonLink: Removed `inverted` Variant](#button-and-buttonlink-removed-inverted-variant)
- [Header: Removed `inverted` Variant](#header-removed-inverted-variant)
- [Heading: `elementType` Prop is Now Mandatory](#heading-elementtype-prop-is-now-mandatory)
- [Link: Removed `isUnderlined` Prop](#link-removed-isunderlined-prop)
- [Link: Removed `inverted` Variant](#link-removed-inverted-variant)
- [Link: The`hasVisitedStyleAllowed` Props](#link-the-hasvisitedstyleallowed-prop)
- [Pill: Update Color Palette](#pill-update-color-palette)
- [ProductLogo: Removed `inverted` Variant](#productlogo-removed-inverted-variant)
- [Toast: Link `underlined` Prop](#toast-link-underlined-prop)
- [Toast: Renamed Color Variant `inverted` to `neutral` in `ToastBar`](#toast-renamed-color-variant-inverted-to-neutral-in-toastbar)

## Component Changes

### Button and ButtonLink: `isSquare` prop renamed to `isSymmetrical`
### Button and ButtonLink: `isSquare` Prop Renamed to `isSymmetrical`

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

Expand All @@ -26,7 +33,17 @@ Button `isSquare` prop was renamed to `isSymmetrical`.
- `<Button isSquare … />``<Button isSymmetrical … />`
- `<ButtonLink isSquare … />``<ButtonLink isSymmetrical … />`

### Heading elementType prop is now mandatory
### Button and ButtonLink: Removed `inverted` Variant

The `inverted` variant was removed from the `Button` and `ButtonLink` components.
Use themes instead to switch the color scheme.

### Header: Removed `inverted` Variant

The `inverted` variant was removed from the `Header` component. Instead the `primary` variant
was introduced. Use themes to switch the color scheme.

### Heading: `elementType` Prop is Now Mandatory

The `Heading` component previously had a default `elementType` of `"div"`.
We've removed this default to encourage developers to explicitly choose a more appropriate semantic HTML element.
Expand All @@ -35,7 +52,20 @@ We've removed this default to encourage developers to explicitly choose a more a

- `<Heading … />``<Heading elementType="{/* Your semantic HTML element here */}" … />`

### Link: The `hasVisitedStyleAllowed` prop was added
### Link: Removed `isUnderlined` Prop

The `isUnderlined` property was removed, please use `underlined` instead.

#### Migration Guide

- `<Link isUnderlined … />``<Link underlined="always" … />`

### Link: Removed `inverted` Variant

The `inverted` variant was removed from the `Link` component.
Use themes instead to switch the color scheme.

### Link: The `hasVisitedStyleAllowed` Prop

The `hasVisitedStyleAllowed` property was added. This property allows the link to have visited state style. There is also a change in the use of the visited state style for the `Heading` component, which had previously this state set by default.
Now a prop `hasVisitedStyleAllowed` has to be added to enable the visited state.
Expand All @@ -46,13 +76,50 @@ If you want to enable the visited state style for the `Link` component, please m

- `<Link … />``<Link hasVisitedStyleAllowed … />`

### Link `isUnderlined`
### Pill: Update Color Palette

The `isUnderlined` property was removed, please use `underlined` instead.
The `color` prop of the `Pill` component no longer supports `primary`, `secondary`, `tertiary`, `inverted`
and `unselected` variants. Instead, the `neutral` variant was added. The current list of variants is:

- `neutral`
- `danger`
- `informative`
- `success`
- `warning`

### ProductLogo: Removed `inverted` Variant

The `inverted` variant was removed from the `ProductLogo` component.

### Toast: Link `underlined` Prop

The `isUnderlined` prop was removed from the `Link` component therefore it is not available in the `Toast` component
JS plugin. Use `underlined` instead.

#### Migration Guide

- `<Link isUnderlined … />``<Link underlined="always" … />`
Replace the `isUnderlined` prop with `underlined` in the JS plugin configuration:

```diff
linkProps: {
href: 'https://example.com', // Link URL
target: '_blank', // Optional link target attribute
- isUnderlined: false, // Optional link underlining, default: true
+ underlined: 'never', // Optional link underlining, one of ['always' (default), 'hover', 'never']
isDisabled: false, // Optional link disabling, default: false
elementType: 'a', // Optional link element type, default: 'a'
},
```

### Toast: Renamed Color Variant `inverted` to `neutral` in `ToastBar`

The `ToastBar` `color` prop variant `inverted` was renamed to `neutral`.

#### Migration Guide

Replace the `inverted` variant with `neutral`:

- `<ToastBar color="inverted" … />``<ToastBar color="neutral" … />`

---

Expand Down

0 comments on commit d0f1f55

Please sign in to comment.