You are viewing Pre-Alpha documentation. Some features may not work as expected.

useSelection API

API reference for the useSelection composable.

Options

`disabled`

MaybeRef<boolean>

When true, the entire selection instance is disabled.

`enroll`

boolean

When true, newly registered items are automatically selected if not disabled. Useful for pre-selecting items in multi-select scenarios.

`mandatory`

boolean | "force"

Controls mandatory selection behavior: - `false` (default): No mandatory selection enforcement - `true`: Prevents deselecting the last selected item (user must always have one selected) - `'force'`: Automatically selects the first non-disabled item on registration

`multiple`

boolean

When true, treats the selection as an array

Properties

`selectedIds`

Reactive<Set<ID>>

Set of selected ticket IDs

`selectedItems`

ComputedRef<Set<Z>>

Set of selected ticket instances

`selectedValues`

ComputedRef<Set<unknown>>

Set of selected ticket values

`disabled`

MaybeRef<boolean>

Disable state for the entire selection instance

Methods

`reset`

() => void

Clear all selected IDs and reindexes

`select`

(id: ID) => void

Select a ticket by ID (Toggle ON)

`unselect`

(id: ID) => void

Unselect a ticket by ID (Toggle OFF)

`toggle`

(id: ID) => void

Toggles a ticket ON and OFF by ID

`selected`

(id: ID) => boolean

Check if a ticket is selected by ID

`mandate`

() => void

Mandates selected ID based on "mandatory" Option