mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-10-23 03:36:18 +02: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
103 lines
2.6 KiB
Plaintext
103 lines
2.6 KiB
Plaintext
import { Story, Canvas, ArgsTable } from '@storybook/addon-docs';
|
|
|
|
import { TextFieldBase, TextField } from '..';
|
|
|
|
import { TextFieldSearch } from './text-field-search';
|
|
|
|
# TextFieldSearch
|
|
|
|
The `TextFieldSearch` allows users to enter text to search
|
|
|
|
<Canvas>
|
|
<Story id="components-componentlibrary-textfieldsearch--default-story" />
|
|
</Canvas>
|
|
|
|
## Props
|
|
|
|
The `TextFieldSearch` accepts all props below as well as all [Box](/docs/components-ui-box--default-story#props) component props
|
|
|
|
<ArgsTable of={TextFieldSearch} />
|
|
|
|
`TextFieldSearch` accepts all [TextField](/docs/components-componentlibrary-textfield--default-story#props)
|
|
component props
|
|
|
|
<ArgsTable of={TextField} />
|
|
|
|
`TextFieldSearch` accepts all [TextFieldBase](/docs/components-componentlibrary-textfieldbase--default-story#props)
|
|
component props
|
|
|
|
<ArgsTable of={TextFieldBase} />
|
|
|
|
### Clear Button On Click
|
|
|
|
`TextFieldSearch` displays a clear button when text is entered into the input. Use the `clearButtonOnClick` prop to pass an `onClick` event handler to clear the value of the input. To hide the clear button, pass `false` to the `showClearButton` prop.
|
|
|
|
The clear button uses [ButtonIcon](/docs/components-componentlibrary-buttonicon--default-story) and accepts all props from that component.
|
|
|
|
**NOTE: The `showClearButton` only works with a controlled input.**
|
|
|
|
<Canvas>
|
|
<Story id="components-componentlibrary-textfieldsearch--clear-button-on-click" />
|
|
</Canvas>
|
|
|
|
```jsx
|
|
import { TextFieldSearch } from '../../component-library';
|
|
|
|
const [value, setValue] = useState('show clear');
|
|
|
|
const handleOnChange = (e) => {
|
|
setValue(e.target.value);
|
|
};
|
|
|
|
const handleOnClear = () => {
|
|
setValue('');
|
|
};
|
|
|
|
<TextFieldSearch
|
|
placeholder="Enter text to show clear"
|
|
value={value}
|
|
onChange={handleOnChange}
|
|
clearButtonOnClick={handleOnClear}
|
|
/>;
|
|
```
|
|
|
|
### Clear Button Props
|
|
|
|
Use the `clearButtonProps` to access other props of the clear button.
|
|
|
|
<Canvas>
|
|
<Story id="components-componentlibrary-textfieldsearch--clear-button-props" />
|
|
</Canvas>
|
|
|
|
```jsx
|
|
import React, { useState } from 'react';
|
|
import {
|
|
SIZES,
|
|
COLORS,
|
|
BORDER_RADIUS,
|
|
} from '../../../helpers/constants/design-system';
|
|
|
|
import { TextFieldSearch } from '../../component-library';
|
|
|
|
const [value, setValue] = useState('show clear');
|
|
|
|
const handleOnChange = (e) => {
|
|
setValue(e.target.value);
|
|
};
|
|
|
|
const handleOnClear = () => {
|
|
setValue('');
|
|
};
|
|
|
|
<TextFieldSearch
|
|
value={value}
|
|
onChange={handleOnChange}
|
|
clearButtonOnClick={handleOnClear}
|
|
clearButtonProps={{
|
|
backgroundColor: COLORS.BACKGROUND_ALTERNATIVE,
|
|
borderRadius: BORDER_RADIUS.XS,
|
|
'data-testid': 'clear-button',
|
|
}}
|
|
/>;
|
|
```
|