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.

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

added badge doc #294

Merged
merged 3 commits into from
Jul 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 25 additions & 0 deletions packages/components/src/components/badge/Usage.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
import { Meta } from '@storybook/blocks';
import * as BadgeStories from './badge.stories';
import BadgeDafault from '../../../public-storybook/images/badge/badge-default.png';

<Meta of={BadgeStories} />

# Badge
Badges are small non-clickable visual indicators used to highlight and convey information such as categories of our products, topics or any other relevant data within our applications. It can be applied to different types of content.

## Usage

### When to use
- To give users a quick way to understand the meaning or status of a component e.g. in product lists or in cards.

### When not to use
- If you're using long lines of label text.
- If you want to highlight critical information or warnings that require immediate attention.

## Icon support
The badge is also available with an icon.
<img src={BadgeDafault} alt="Badge Default" />

***
Check out the Figma component: **[Badge](https://www.figma.com/file/zPvPwPgb4EsYFXKC2nhzSG/Infineon-DDS-%7C-Main?type=design&node-id=23904-14546&mode=design&t=UQ0Dm7ueLiXMURK1-4)**
***