From 3e008710a77fef1c6ff5f275741c693dfae218ab Mon Sep 17 00:00:00 2001 From: Pavel Klibani Date: Wed, 16 Oct 2024 16:39:11 +0200 Subject: [PATCH] BREAKING CHANGE(web-twig): Toast JS Plugin docs updated - `isUnderlined` changed to `underlined` in documentation of `Toast` JS plugin to better reflect changes in react and twig `Link` component and changes in web plugin - Removed isUnderlined prop from ToastBarLink test fixture because this prop does not exist on this component - solves #DS-1509 --- docs/migrations/web-twig/MIGRATION-v4.md | 8 ++++++++ packages/web-twig/DEPRECATIONS.md | 13 ++----------- .../src/Resources/components/Toast/README.md | 2 +- .../Toast/__tests__/__fixtures__/toastBarLink.twig | 1 - 4 files changed, 11 insertions(+), 13 deletions(-) diff --git a/docs/migrations/web-twig/MIGRATION-v4.md b/docs/migrations/web-twig/MIGRATION-v4.md index 1443125495..a00b54de9d 100644 --- a/docs/migrations/web-twig/MIGRATION-v4.md +++ b/docs/migrations/web-twig/MIGRATION-v4.md @@ -32,6 +32,14 @@ We've removed this default to encourage developers to explicitly choose a more a - `` → `` +### Link `isUnderlined` + +The `isUnderlined` property was removed, please use `underlined` instead. + +#### Migration Guide + +- `` → `` + --- Please refer back to this guide or reach out to our team if you encounter any issues during migration. diff --git a/packages/web-twig/DEPRECATIONS.md b/packages/web-twig/DEPRECATIONS.md index be13f50ca4..233069a4b4 100644 --- a/packages/web-twig/DEPRECATIONS.md +++ b/packages/web-twig/DEPRECATIONS.md @@ -6,17 +6,8 @@ This document lists all deprecations that will be removed in the next major vers ## Deprecations -👉 [What are deprecations?][readme-deprecations] - -### Link `isUnderlined` - -`isUnderlined` property will be replaced in the next major version. Please use `underlined` instead. +Nothing here right now! 🎉 -#### Migration Guide - -```diff -- -+ -``` +👉 [What are deprecations?][readme-deprecations] [readme-deprecations]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-twig/README.md#deprecations diff --git a/packages/web-twig/src/Resources/components/Toast/README.md b/packages/web-twig/src/Resources/components/Toast/README.md index 21b4575f74..b659285040 100644 --- a/packages/web-twig/src/Resources/components/Toast/README.md +++ b/packages/web-twig/src/Resources/components/Toast/README.md @@ -370,7 +370,7 @@ const toast = new Toast(null, { 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, Optional link underlining, one of ['always' (default), 'hover', 'never'] isDisabled: false, // Optional link disabling, default: false elementType: 'a', // Optional link element type, default: 'a' }, diff --git a/packages/web-twig/src/Resources/components/Toast/__tests__/__fixtures__/toastBarLink.twig b/packages/web-twig/src/Resources/components/Toast/__tests__/__fixtures__/toastBarLink.twig index cdb35be6af..925e653523 100644 --- a/packages/web-twig/src/Resources/components/Toast/__tests__/__fixtures__/toastBarLink.twig +++ b/packages/web-twig/src/Resources/components/Toast/__tests__/__fixtures__/toastBarLink.twig @@ -4,7 +4,6 @@