Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(documentation): adds deprecation message to badge #2410

Merged
merged 8 commits into from
Jan 18, 2024
Merged

feat(documentation): adds deprecation message to badge #2410

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c5a2817
feat(documentation): adds deprecation message to badge
b1aserlu Dec 14, 2023
3834861
removes format problems
b1aserlu Jan 16, 2024
4fe3b8c
Merge branch 'main' into 2196-deprecate-current-badge
b1aserlu Jan 16, 2024
bbbe96a
changes text according to change request
b1aserlu Jan 17, 2024
338ac8e
revert change to .vscode setings
b1aserlu Jan 17, 2024
863af66
applies changes from review
b1aserlu Jan 18, 2024
76a634a
implements suggested changes from code review
b1aserlu Jan 18, 2024
0abe8ec
Merge branch 'main' into 2196-deprecate-current-badge
b1aserlu Jan 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/strange-coins-hammer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@swisspost/design-system-documentation': minor
---

Added a deprecation message to the badge documentation.
14 changes: 13 additions & 1 deletion packages/documentation/src/stories/components/badge/badge.docs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
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';

Expand All @@ -10,12 +11,23 @@ import StylesPackageImport from '../../../shared/styles-package-import.mdx';
Documentation and examples for badges, our small count and labeling component.
</div>

<PostAlert type="warning">
b1aserlu marked this conversation as resolved.
Show resolved Hide resolved
<p slot="heading">Badge is deprecated</p>
<p>
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)
</p>
</PostAlert>

<Canvas sourceState="shown" of={badgeStories.Default} />
<div className="hide-col-default">
<Controls of={badgeStories.Default} />
</div>

<StylesPackageImport components={["badge"]} />
<StylesPackageImport components={['badge']} />

## Examples

Expand Down
Loading