-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #435 from Infineon/434-documentation-status
Documentation: status
- Loading branch information
Showing
5 changed files
with
45 additions
and
0 deletions.
There are no files selected for viewing
Binary file added
BIN
+41.5 KB
packages/components/public-storybook/images/status/status-usage-info.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+47.4 KB
packages/components/public-storybook/images/status/status-usage-table.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+17.3 KB
packages/components/public-storybook/images/status/status-variant-outline.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+6.93 KB
packages/components/public-storybook/images/status/status-variant-simple.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
import { Meta } from '@storybook/blocks'; | ||
import * as StatusStories from './status.stories'; | ||
import StatusVariantOutline from '../../../public-storybook/images/status/status-variant-outline.png'; | ||
import StatusVariantSimple from '../../../public-storybook/images/status/status-variant-simple.png'; | ||
import StatusUsageInfo from '../../../public-storybook/images/status/status-usage-info.png'; | ||
import StatusUsageTable from '../../../public-storybook/images/status/status-usage-table.png'; | ||
|
||
|
||
<Meta of={StatusStories} /> | ||
|
||
# Status | ||
The status component serves as a visual indicator to convey additional information about an element on the interface. It is often used to highlight the status of processes to enhance the user's understanding of the content. | ||
|
||
## Usage | ||
|
||
### When to use | ||
- If you want to visually highlight past, current or upcoming events. | ||
- If you want to provide supplementary information to a product inside a table. | ||
|
||
### When not to use | ||
- Avoid using status components for elements that do not carry significant importance or meaning. | ||
- Do not use status components solely for decorative purposes, especially if they do not serve a functional or informative role. | ||
- Avoid using status components to display redundant or duplicative information. | ||
- Avoid to use long label names. Be precise and concise. | ||
|
||
## Variants | ||
|
||
### With Outline | ||
This variant offers the strongest contrast when it comes to displaying very complex information structures at a glance. | ||
<img src={StatusVariantOutline} alt="Status Variant Outline" /> | ||
|
||
#### Example | ||
<img src={StatusUsageTable} alt="Status Usage Table" /> | ||
|
||
### Simple | ||
This variant can be placed singly next to the corresponding element. | ||
<img src={StatusVariantSimple} alt="Status Variant Simple" /> | ||
|
||
#### Example | ||
<img src={StatusUsageInfo} alt="Status Usage Simple" /> | ||
|
||
|
||
*** | ||
Check out the Figma component: **[Status](https://www.figma.com/file/zPvPwPgb4EsYFXKC2nhzSG/Infineon-DDS-%7C-Main?type=design&node-id=22477-15125&mode=design&t=N3jewrmlr18EfHS8-4)** | ||
*** |