Multiple Select
A flexible dropdown input that enables users to select multiple options, ideal for tagging, categorization, and filtering tasks.
Basic
The basic multiple select component lets you select multiple options from a list. It displays selected options with Tag components.
Installation
If you hit any issues, make sure you check out the installation guide here for more information.
Composed Components
When you install this component via the CLI, it automatically loads all composed components, so you don’t need to add them individually.
The Multiple Select comes packed with several components to enhance functionality and provide a seamless experience.
Manual Installation
Make sure you also install the composed components and the required packages for the component to function properly.
Anatomy
Intent
By default, the multiple select component uses the primary
intent. But it has a secondary
intent as well.
Shape
Customize the tag field’s shape using the shape
prop.
Controlled
This component lets you select tags dynamically, updating the list with callbacks on add and remove. It displays selected tags with Tag components and logs each action.
Max Items
You can limit the number of selected items using the maxItems
prop.
Invalid
When the component is invalid, it displays an error message.
Disabled
When the component is disabled, it prevents the user from adding or removing tags.
Props
Here's the fixed table:
Prop | Type | Default | Description |
---|---|---|---|
label | string | - | The label of the multiple select |
description | string | - | The description of the multiple select |
placeholder | string | - | The placeholder of the multiple select |
className | string | - | The class name of the multiple select |
name | string | - | The name of the multiple select |
items | array of objects | - | The list of multiple select items (options) |
selectedKeys | Selection | - | The selected keys of the multiple select |
onSelectionChange | function | - | The callback function for selection |
maxItems | number | - | The max number of items that can be selected |
isDisabled | boolean | - | The disabled state of the multiple select |
isInvalid | boolean | - | The invalid state of the multiple select |
errorMessage | string | - | The error message if invalid |
intent | string | 'primary' | 'primary', 'secondary' |
shape | string | 'square' | 'square', 'circle' |