mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-12-23 09:52:26 +01:00
c5368c152b
* added storybook test runner * added test runner in ci * updated test for ci and fixed lint error * updated lavamoat policy * updated test command * updated playwright * changed command to storybook;ci * updated command * updated instance for test-storybook * updated playwright * added playwright step * replaced concurrently with start-server-and-test * updated the static storybook directory * replaced first with last * updated lock file * replaced first with last * updated test-storybook with maxworkers * updated .depchechrc * updated yml * removed id from banner base * replaced broken stories with .stories-to-do.js extesnsion * updated token allowance story * removed duplicacies from yarn * fixed lavamoat * removed filename comment * updated links for docs * fixed file extension for stories * updated path for stories.json * updated stories.json path * yarn updated * updated stories * updated yarn * updated wait on
90 lines
2.3 KiB
Plaintext
90 lines
2.3 KiB
Plaintext
import { Story, Canvas, ArgsTable } from '@storybook/addon-docs';
|
|
|
|
import { Text } from '..';
|
|
|
|
import { HelpText } from './help-text';
|
|
|
|
# HelpText
|
|
|
|
The `HelpText` is intended to be used as the help or error text under a form element
|
|
|
|
<Canvas>
|
|
<Story id="components-componentlibrary-helptext--default-story" />
|
|
</Canvas>
|
|
|
|
## Props
|
|
|
|
The `HelpText` accepts all props below as well as all [Box](/docs/components-ui-box--default-story#props) component props
|
|
|
|
<ArgsTable of={HelpText} />
|
|
|
|
`HelpText` accepts all [Text](/docs/components-componentlibrary-text--default-story#props) component props
|
|
|
|
<ArgsTable of={Text} />
|
|
|
|
### Children
|
|
|
|
The `children` of the `HelpText` can be plain text or react nodes
|
|
|
|
<Canvas>
|
|
<Story id="components-componentlibrary-helptext--children" />
|
|
</Canvas>
|
|
|
|
```jsx
|
|
import { SIZES, COLORS } from '../../../helpers/constants/design-system';
|
|
import { HelpText, Icon, ICON_NAMES } from '../../component-library';
|
|
|
|
<HelpText>Plain text</HelpText>
|
|
<HelpText>
|
|
Text and icon
|
|
<Icon
|
|
marginLeft={1}
|
|
color={COLORS.INHERIT}
|
|
name={ICON_NAMES.WARNING_FILLED}
|
|
size={SIZES.AUTO}
|
|
/>
|
|
</HelpText>
|
|
```
|
|
|
|
### Error
|
|
|
|
Use the `error` prop to show the `HelpText` in error state
|
|
|
|
<Canvas>
|
|
<Story id="components-componentlibrary-helptext--error-story" />
|
|
</Canvas>
|
|
|
|
```jsx
|
|
import { HelpText } from '../../component-library';
|
|
|
|
<HelpText error>This HelpText in error state</HelpText>;
|
|
```
|
|
|
|
### Color
|
|
|
|
It may be useful to change the color of the `HelpText`. Use the `color` prop and the `COLORS` object to change the color of the `HelpText`. Defaults to `COLORS.TEXT_DEFAULT`.
|
|
|
|
<Canvas>
|
|
<Story id="components-componentlibrary-helptext--color" />
|
|
</Canvas>
|
|
|
|
```jsx
|
|
import { COLORS } from '../../../helpers/constants/design-system';
|
|
import { HelpText } from '../../component-library';
|
|
|
|
<Box display={DISPLAY.FLEX} flexDirection={FLEX_DIRECTION.COLUMN} gap={2}>
|
|
<HelpText color={COLORS.TEXT_DEFAULT}>
|
|
The HelpText default color is COLORS.TEXT_DEFAULT
|
|
</HelpText>
|
|
<HelpText color={COLORS.INFO_DEFAULT}>
|
|
This HelpText color is COLORS.INFO_DEFAULT
|
|
</HelpText>
|
|
<HelpText color={COLORS.WARNING_DEFAULT}>
|
|
This HelpText color is COLORS.WARNING_DEFAULT
|
|
</HelpText>
|
|
<HelpText color={COLORS.SUCCESS_DEFAULT}>
|
|
This HelpText color is COLORS.SUCCESS_DEFAULT
|
|
</HelpText>
|
|
</Box>;
|
|
```
|