metamask-extension/ui/components/component-library/text-field/README.mdx

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

import { TextFieldBase } from '../text-field-base';

import { TextField } from './text-field';

# TextField

The `TextField` component lets users enter and edit text as well as adding a show clear button option. It wraps `TextFieldBase` and functions only as a controlled input.

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

## Props

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

<ArgsTable of={TextField} />

`TextField` accepts all [TextFieldBase](/docs/ui-components-component-library-text-field-base-text-field-base-stories-js--default-story#props)
component props

<ArgsTable of={TextFieldBase} />

### Show Clear Button

Use the `showClearButton` prop to display a clear button when `TextField` has a value. Use the `clearButtonOnClick` prop to pass an `onClick` event handler to clear the value of the input. Otherwise the clear button will not do anything.

The clear button uses [ButtonIcon](/docs/ui-components-component-library-button-icon-button-icon-stories-js--default-story) and accepts all `ButtonIcon` props.

**NOTE: The `showClearButton` only works with a controlled input.**

<Canvas>
  <Story id="ui-components-component-library-text-field-text-field-stories-js--show-clear-button" />
</Canvas>

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

const [value, setValue] = useState('show clear');

const handleOnChange = (e) => {
  setValue(e.target.value);
};

const handleOnClear = () => {
  setValue('');
};

<TextField
  placeholder="Enter text to show clear"
  value={value}
  onChange={handleOnChange}
  showClearButton
  clearButtonOnClick={handleOnClear}
/>;
```

### Clear Button Props

Use the `clearButtonProps` to access other props of the clear button.

<Canvas>
  <Story id="ui-components-component-library-text-field-text-field-stories-js--clear-button-props" />
</Canvas>

```jsx
import React, { useState } from 'react';
import {
  SIZES,
  COLORS,
  BORDER_RADIUS,
} from '../../../helpers/constants/design-system';

import { TextField } from '../../component-library';

const [value, setValue] = useState('show clear');

const handleOnChange = (e) => {
  setValue(e.target.value);
};

const handleOnClear = () => {
  setValue('');
};

<TextField
  placeholder="Enter text to show clear"
  value={value}
  onChange={handleOnChange}
  showClearButton
  clearButtonOnClick={handleOnClear}
  clearButtonProps={{
    backgroundColor: COLORS.BACKGROUND_ALTERNATIVE,
    borderRadius: BORDER_RADIUS.XS,
    'data-testid': 'clear-button',
  }}
/>;
```