SelectStatus API
API reference docs for the Stash SelectStatus component. Learn about the props, CSS, and other APIs of this exported module.
Import
ts
import SelectStatus from '@leaflink/stash/SelectStatus.vue';Props
| Name | Type | Default | Description |
|---|---|---|---|
| modelValue | number | string | boolean | - | Sets the currently-selected option for the component |
| statusOptions | Array | - | The list of all options to select the status from each object must have the following structure: { id: number | string, name: string, color?: string } |
| disabled | boolean | false | Disables the component, if true |
| displayBy | string | 'name' | Which key of the prop option to use for display |
| label | string | undefined | Shows a label above the select |
| noTruncate | boolean | false | Allows option text to wrap to next line when set to true |
| placeholder | string | 'Select Status' | Placeholder text |
| secondary | boolean | false | Sets the background color of the component to the color of the selected option |
| trackBy | string | 'id' | Default field to track the selected status by |
| value | number | string | boolean | null | null |
Slots
None
Events
| Name | Description |
|---|---|
| update:model-value | Emitted when the model value changes |