metamask-extension/ui/components/component-library/label/README.mdx

import { Story, Canvas, ArgsTable } from '@storybook/addon-docs';

import { Text } from '..';

import { Label } from './label';

# Label

The `Label` is a component used to label form inputs

<Canvas>
  <Story id="ui-components-component-library-label-label-stories-js--default-story" />
</Canvas>

## Props

The `Label` accepts all props below as well as all [Box](/docs/ui-components-ui-box-box-stories-js--default-story#props) component props

<ArgsTable of={Label} />

`Label` accepts all [Text](/docs/ui-components-component-library-text-text-stories-js--default-story#props) component props

<ArgsTable of={Text} />

### Children

The `children` of the label can be text or a react node

<Canvas>
  <Story id="ui-components-component-library-label-label-stories-js--children" />
</Canvas>

```jsx
import { DISPLAY, ALIGN_ITEMS, FLEX_DIRECTION, SIZES, COLORS } from '../../../helpers/constants/design-system';
import { Label, TextField, Icon, ICON_NAMES } from '../../component-library';

<Label>Plain text</Label>
<Label display={DISPLAY.FLEX} alignItems={ALIGN_ITEMS.FLEX_START}>
  Text and icon
  <Icon
    color={COLORS.ICON_ALTERNATIVE}
    name={ICON_NAMES.INFO_FILLED}
    size={SIZES.AUTO}
  />
</Label>
<Label
  display={DISPLAY.INLINE_FLEX}
  flexDirection={FLEX_DIRECTION.COLUMN}
  alignItems={ALIGN_ITEMS.FLEX_START}
>
  Label that wraps an input
  <TextField placeholder="Click label to focus" />
</Label>
```

### Html For

Use the `htmlFor` prop to allow the `Label` to focus on an input with the same id when clicked. The cursor will also change to a `pointer` when the `htmlFor` has a value.

<Canvas>
  <Story id="ui-components-component-library-label-label-stories-js--html-for" />
</Canvas>

```jsx
import { Label, TextFieldBase } from '../../component-library';

<Label htmlFor="add-network">Add network</Label>
<TextField id="add-network" placeholder="Enter network name" />
```

### Required

Use the `required` prop to add a required red asterisk next to the `children` of the `Label`. Note the required asterisk will always render after the `children`.

<Canvas>
  <Story id="ui-components-component-library-label-label-stories-js--required" />
</Canvas>

```jsx
import { Label } from '../../component-library';

<Label required>Label</Label>;
```

### Disabled

Use the `disabled` prop to set the `Label` in disabled state

<Canvas>
  <Story id="ui-components-component-library-label-label-stories-js--disabled" />
</Canvas>

```jsx
import { Label } from '../../component-library';

<Label disabled>Label</Label>;
```