mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-12-02 06:07:06 +01:00
9821c59e11
* Updating showClearButton prop name and making component dumber * Docs update * Adding missing proptype * Fixing casing on tests * Replacing clear button placeholder with ButtonIcon and docs update * Fixing linting issues * Adding note about controlled only for showClearButton to work and fixing some tests * Updating test to include controlled testing setup function for clearButton tests
94 lines
2.5 KiB
Plaintext
94 lines
2.5 KiB
Plaintext
import { Story, Canvas, ArgsTable } from '@storybook/addon-docs';
|
|
|
|
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) and [TextFieldBase](/docs/ui-components-component-library-text-field-base-text-field-base-stories-js--default-story#props) component props
|
|
|
|
<ArgsTable of={TextField} />
|
|
|
|
### 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.
|
|
|
|
The clear button uses [ButtonIcon](/docs/ui-components-component-library-button-icon-button-icon-stories-js--default-story) and accepts all props from that component.
|
|
|
|
**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 '../../ui/component-library/text-field';
|
|
|
|
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 '../../ui/component-library/text-field';
|
|
|
|
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',
|
|
}}
|
|
/>;
|
|
```
|