DocSpace-buildtools/web/ASC.Web.Storybook/stories/input/combobox/README.md

65 lines
2.3 KiB
Markdown
Raw Normal View History

2019-07-18 08:00:54 +00:00
# ComboBox
#### Description
Custom combo box input
Options have options:
key - Item key, may be a string or a number,
label - Display text,
icon - Optional name of icon that will be displayed before label
2019-07-18 08:00:54 +00:00
#### Usage
```js
import { ComboBox } from 'asc-web-components';
2019-07-31 18:42:23 +00:00
const options = [
{
key: 1,
icon: 'CatalogEmployeeIcon',
label: 'Option 1'
},
{
key: 2,
icon: 'CatalogGuestIcon',
label: 'Option 2',
},
{
key: 3,
label: 'Option 3'
2019-07-31 18:42:23 +00:00
},
{
key: 4,
label: 'Option 4'
2019-07-31 18:42:23 +00:00
},
{
key: 5,
icon: 'CopyIcon',
label: 'Option 5'
2019-07-31 18:42:23 +00:00
}
];
<ComboBox options={options}
isDisabled={false}
selectedOption={25}
dropDownMaxHeight='200px'
scale={true}
size='content'
onSelect={option => console.log('selected', option)}
/>
2019-07-18 08:00:54 +00:00
```
#### Properties
| Props | Type | Required | Values | Default | Description |
| ---------------------- | ----------------- | :------: | ---------------------------- | ------- | -------------------------------------------- |
| `options` | `array` | ✅ | - | - | Combo box options |
| `isDisabled` | `bool` | - | - | `false` | Indicates that component is disabled |
| `selectedOption` | `string`,`number` | - | - | `0` | Index of option selected by default |
| `onSelect` | `func` | - | - | - | Will be triggered whenever an ComboBox is selected option |
| `dropDownMaxHeight` | `string` | - | - | - | Height of Dropdown |
| `scaled` | `bool` | - | - | `true` | Indicates that component is scaled by parent |
| `size` | `oneOf` | - | `base`, `middle`, `big`, `huge`, `content` | `base` | Select component width, one of default |
| `emptyOptionsPlaceholder`| `string` | - | - | `Select`| Label displayed in absence of options |