@gravity-ui/uikit
Version:
Gravity UI base styling and components
35 lines (28 loc) • 2 kB
Markdown
# useSelect
```tsx
import {useSelect} from '@gravity-ui/uikit';
```
The `useSelect` hook used to handle items selection in list
## Properties
| Name | Description | Type | Default |
| :----------- | :-------------------------------------------------------- | :--------: | :-----: |
| value | Values that represent selected items | `string[]` | |
| defaultValue | Default values used in case of uncontrolled usage | `string[]` | `[]` |
| multiple | Indicates that multiple items can be selected in the list | `boolean` | `false` |
| disabled | Disables selection changes | `boolean` | |
| onUpdate | Invokes inside of `handleSelection` function | `function` | |
| defaultOpen | Initial value for `open` property | `boolean` | `false` |
| open | Controlled `open` property | `boolean` | |
| onOpenChange | Invokes while `open` property changes | `function` | |
| onClose | Invokes when the list closes | `function` | |
## Result
| Name | Description | Type |
| :--------------- | :------------------------------------ | :--------: |
| value | Values that represent selected items | `string[]` |
| setValue | Sets value directly | `function` |
| open | List container visibility state | `boolean` |
| toggleOpen | Invert the value of `open` | `function` |
| activeIndex | Index of active option | `number` |
| setActiveIndex | Sets value for `activeIndex` property | `function` |
| handleSelection | Handles item selection | `function` |
| handleClearValue | Clears selected values | `function` |