IlyaSobolev/DocSpace-client
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

web: Components: Fixed SearchInput component readme

Browse Source
This commit is contained in:
Ilya Oleshko 2019-11-21 16:29:10 +03:00
parent 522a16f998
commit ab090fac8c
1 changed files with 35 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
web/ASC.Web.Components/src/components/search-input/README.md
View File

@ -1,38 +1,44 @@
# Input: SearchInput
## Usage
```js
import { SearchInput } from 'asc-web-components';
```
#### Description
# SearchInput
SearchInput description
#### Usage
### Usage
```js
<SearchInput
isNeedFilter={true}
getFilterData={() => [ { key: 'filter-example', group: 'filter-example', label: 'example group', isHeader: true },
{ key: 'filter-example-test', group: 'filter-example', label: 'Test' }]
}
onSearchClick={(result) => {console.log(result)}}
onChangeFilter={(result) => {console.log(result)}}
import { SearchInput } from "asc-web-components";
```
```jsx
<SearchInput
isNeedFilter={true}
getFilterData={() => [
{
key: "filter-example",
group: "filter-example",
label: "example group",
isHeader: true
},
{ key: "filter-example-test", group: "filter-example", label: "Test" }
]}
onSearchClick={result => {
console.log(result);
}}
onChangeFilter={result => {
console.log(result);
}}
/>
```
### Properties
| Props | Type | Required | Values | Default | Description |
| ---------------------- | -------- | :------: | ---------------------------- | ------- | ------------------------------------------------------------------------------------------------------ |
| `id` | `string` | - | - | - | Used as HTML `id` property |
| `value` | `string` | - | - | - | Value of the input |
| `onChange` | `func` | - | - | - | Called with the new value. Required when input is not read only. Parent should pass it back as `value` |
| `isDisabled` | `bool` | - | - | `false` | Indicates that the field cannot be used (e.g not authorised, or changes not saved) |
| `placeholder` | `string` | - | - | - | Placeholder text for the input |
| `size` | `string` | | `base`, `middle`, `big`, `huge`| `base` | Supported size of the input fields. |
| `scale` | `bool` | - | - | - | Indicates the input field has scale |
| `isNeedFilter` | `bool` | | | `false` | Determines if filter is needed |
| `selectedFilterData` | `array` | - | | | Selected filter data |
| Props | Type | Required | Values | Default | Description |
| -------------------- | :------: | :------: | :-----------------------------: | :-----: | ------------------------------------------------------------------------------------------------------ |
| `id` | `string` | - | - | - | Used as HTML `id` property |
| `value` | `string` | - | - | - | Value of the input |
| `onChange` | `func` | - | - | - | Called with the new value. Required when input is not read only. Parent should pass it back as `value` |
| `isDisabled` | `bool` | - | - | `false` | Indicates that the field cannot be used (e.g not authorized, or changes not saved) |
| `placeholder` | `string` | - | - | - | Placeholder text for the input |
| `size` | `string` | - | `base`, `middle`, `big`, `huge` | `base` | Supported size of the input fields. |
| `scale` | `bool` | - | - | - | Indicates the input field has scale |
| `isNeedFilter` | `bool` | - | - | `false` | Determines if filter is needed |
| `selectedFilterData` | `array` | - | - | - | Selected filter data |