From c5a2817e7e6e4cd1b6fcbaed1e6c422e5a5d170c Mon Sep 17 00:00:00 2001
From: b1aserlu <141234680+b1aserlu@users.noreply.github.com>
Date: Thu, 14 Dec 2023 11:32:32 +0100
Subject: [PATCH 1/6] feat(documentation): adds deprecation message to badge
---
.changeset/strange-coins-hammer.md | 5 +++++
.../src/stories/components/badge/badge.docs.mdx | 13 +++++++++++++
2 files changed, 18 insertions(+)
create mode 100644 .changeset/strange-coins-hammer.md
diff --git a/.changeset/strange-coins-hammer.md b/.changeset/strange-coins-hammer.md
new file mode 100644
index 0000000000..60e655d46c
--- /dev/null
+++ b/.changeset/strange-coins-hammer.md
@@ -0,0 +1,5 @@
+---
+'@swisspost/design-system-documentation': minor
+---
+
+Added a deprecation message to the badge documentation.
diff --git a/packages/documentation/src/stories/components/badge/badge.docs.mdx b/packages/documentation/src/stories/components/badge/badge.docs.mdx
index ba16852b30..690d3c525c 100644
--- a/packages/documentation/src/stories/components/badge/badge.docs.mdx
+++ b/packages/documentation/src/stories/components/badge/badge.docs.mdx
@@ -1,9 +1,22 @@
import { Canvas, Controls, Meta } from '@storybook/blocks';
+import { PostAlert } from '@swisspost/design-system-components-react';
import * as badgeStories from './badge.stories';
import StylesPackageImport from '../../../shared/styles-package-import.mdx';
+
+ Badge is deprecated
+ The current badge will be deprecated in favour of a new chip component that looks similar to it. There will also be a new badge component
+ that looks similar to the current nested badge.
+ Check out the new components in figma:
+ [Chip](https://www.figma.com/file/xZ0IW0MJO0vnFicmrHiKaY/Components-Post?type=design&node-id=11194-50777&mode=design&t=SeiMf2Vt3dmUnpMT-0)
+ /
+ [Badge](https://www.figma.com/file/xZ0IW0MJO0vnFicmrHiKaY/Components-Post?type=design&node-id=11038-51303&mode=design&t=SeiMf2Vt3dmUnpMT-0)
+
Badge is deprecated
- The current badge will be deprecated in favour of a new chip component that looks similar to it. There will also be a new badge component
- that looks similar to the current nested badge.
- Check out the new components in figma:
+ The current badge will be deprecated in favour of a new chip component that looks similar to it.
+ There will also be a new badge component that looks similar to the current nested badge. Check
+ out the new components in figma:
[Chip](https://www.figma.com/file/xZ0IW0MJO0vnFicmrHiKaY/Components-Post?type=design&node-id=11194-50777&mode=design&t=SeiMf2Vt3dmUnpMT-0)
/
[Badge](https://www.figma.com/file/xZ0IW0MJO0vnFicmrHiKaY/Components-Post?type=design&node-id=11038-51303&mode=design&t=SeiMf2Vt3dmUnpMT-0)
@@ -28,7 +27,7 @@ import StylesPackageImport from '../../../shared/styles-package-import.mdx';
Badge is deprecated
- The current badge will be deprecated in favour of a new chip component that looks similar to it. - There will also be a new badge component that looks similar to the current nested badge. Check - out the new components in figma: + The current badge is deprecated and will be replaced with the new chip component that will look + and work similar like the current badge component. There will also be a new badge component, but + with a different behavior. Check out the new components in figma: [Chip](https://www.figma.com/file/xZ0IW0MJO0vnFicmrHiKaY/Components-Post?type=design&node-id=11194-50777&mode=design&t=SeiMf2Vt3dmUnpMT-0) / [Badge](https://www.figma.com/file/xZ0IW0MJO0vnFicmrHiKaY/Components-Post?type=design&node-id=11038-51303&mode=design&t=SeiMf2Vt3dmUnpMT-0) From 338ac8e6cdcd82830a86fd222a821ff4f747ccc0 Mon Sep 17 00:00:00 2001 From: b1aserlu <141234680+b1aserlu@users.noreply.github.com> Date: Wed, 17 Jan 2024 16:14:33 +0100 Subject: [PATCH 4/6] revert change to .vscode setings --- .vscode/settings.json | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.vscode/settings.json b/.vscode/settings.json index 85f30022d9..71682566a6 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,5 +1,9 @@ { "editor.formatOnSave": true, "editor.defaultFormatter": "esbenp.prettier-vscode", + "[mdx]": { + "editor.defaultFormatter": null, + "editor.formatOnSave": false + }, "files.eol": "\n" } From 863af66b228a059a3556a625fc820053b63c0967 Mon Sep 17 00:00:00 2001 From: b1aserlu <141234680+b1aserlu@users.noreply.github.com> Date: Thu, 18 Jan 2024 09:36:17 +0100 Subject: [PATCH 5/6] applies changes from review --- .../src/stories/components/badge/badge.docs.mdx | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/packages/documentation/src/stories/components/badge/badge.docs.mdx b/packages/documentation/src/stories/components/badge/badge.docs.mdx index b81a62083f..b32835f467 100644 --- a/packages/documentation/src/stories/components/badge/badge.docs.mdx +++ b/packages/documentation/src/stories/components/badge/badge.docs.mdx @@ -5,22 +5,22 @@ import StylesPackageImport from '../../../shared/styles-package-import.mdx'; +# Badge + +
Badge is deprecated
- The current badge is deprecated and will be replaced with the new chip component that will look - and work similar like the current badge component. There will also be a new badge component, but - with a different behavior. Check out the new components in figma: + The current badge is deprecated and will be replaced with the chip component which will behave similarly as the current badge component. + There will also be a new badge component, but with a different behavior. Check out the new components in figma: [Chip](https://www.figma.com/file/xZ0IW0MJO0vnFicmrHiKaY/Components-Post?type=design&node-id=11194-50777&mode=design&t=SeiMf2Vt3dmUnpMT-0) / [Badge](https://www.figma.com/file/xZ0IW0MJO0vnFicmrHiKaY/Components-Post?type=design&node-id=11038-51303&mode=design&t=SeiMf2Vt3dmUnpMT-0)
Badge is deprecated
- The current badge is deprecated and will be replaced with the chip component which will behave similarly as the current badge component. - There will also be a new badge component, but with a different behavior. Check out the new components in figma: + The current `badge` component is deprecated and will be replaced with the `chip` component which will behave similarly to the current `badge` component. + There will also be a new `badge` component, but with a different behavior. Check out the new components in figma: [Chip](https://www.figma.com/file/xZ0IW0MJO0vnFicmrHiKaY/Components-Post?type=design&node-id=11194-50777&mode=design&t=SeiMf2Vt3dmUnpMT-0) / [Badge](https://www.figma.com/file/xZ0IW0MJO0vnFicmrHiKaY/Components-Post?type=design&node-id=11038-51303&mode=design&t=SeiMf2Vt3dmUnpMT-0)