Skip to content

Commit

Permalink
Merge pull request #381 from Infineon/378-documentation-number-indicator
Browse files Browse the repository at this point in the history
Documentation: number indicator
  • Loading branch information
verena-ifx committed Aug 18, 2023
2 parents fd3eb9a + b548e29 commit bbcc1d0
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 0 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
32 changes: 32 additions & 0 deletions packages/components/src/components/number-indicator/Usage.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@

import { Meta } from '@storybook/blocks';
import * as NumberIndicatorStories from './number-indicator.stories';
import NumberIndicatorStyle from '../../../public-storybook/images/number-indicator/number-indicator-style.png';
import NumberIndicatorUse from '../../../public-storybook/images/number-indicator/number-indicator-use.png';


<Meta of={NumberIndicatorStories} />

# Number Indicator
The number indicator component refers to some of our UI elements that visually represents or displays numeric information to users.

## When to use
- If you want to display the count of items in a list or container, like the number of items in a shopping cart or the unread emails in an inbox.
- If you want to inform the user about new notification e.g. messages.
- If the user has selected many options and these can no longer be displayed due to lack of space.

## When not to use
- If you want to use it as different style for a numbered list. Use an icon or native numbered list style instead.

## Variants
The number indicator component can be used in different use cases. As a counter in a shopping cart, or as indicator for unseen items. The "+" affix communicates to users that there are additional selected options beyond what's currently visible.
<img src={NumberIndicatorUse} alt="Number Indicator Variants" />

## Style
The number indicator is available in two different styles: default and inverted.
<img src={NumberIndicatorStyle} alt="Number Indicator Style" />


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

0 comments on commit bbcc1d0

Please sign in to comment.