# useStack API

> Auto-generated API reference for `useStack` from @vuetify/v0 (Vuetify0).
> Source of truth: https://0.vuetifyjs.com/api/use-stack

## Related

- https://0.vuetifyjs.com/composables/plugins/use-stack
- https://0.vuetifyjs.com/components/providers/scrim
- https://0.vuetifyjs.com/composables/registration/create-registry
- https://0.vuetifyjs.com/composables/registration/create-queue

## Functions

### createStack

Creates a new stack instance for managing overlay z-indexes.

```ts
(_options?: StackOptions) => StackContext<StackTicketInput, StackTicket<StackTicketInput>>
```

### createStackContext

Creates a stack context trinity for provide/inject usage.

```ts
(_options?: StackContextOptions) => ContextTrinity<StackContext<StackTicketInput, StackTicket<StackTicketInput>>>
```

### createStackPlugin

Creates a Vue plugin to provide stack context at app level.

```ts
(_options?: StackPluginOptions) => import("/home/runner/work/0/0/packages/0/src/composables/createPlugin/index").Plugin
```

### useStack

Returns the current stack context.

```ts
(namespace?: string) => StackContext<StackTicketInput, StackTicket<StackTicketInput>>
```

## Options

| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| `events` | `boolean \| undefined` | `false` | no | Enable event emission for registry operations |
| `reactive` | `boolean \| undefined` | `false` | no | Enable reactive behavior for registry operations |
| `disabled` | `MaybeRefOrGetter<boolean> \| undefined` | `false` | no | Disabled state for the entire model instance |
| `enroll` | `MaybeRefOrGetter<boolean> \| undefined` | `true` | no | Auto-select tickets on registration |
| `multiple` | `MaybeRefOrGetter<boolean> \| undefined` | `false` | no | Allow multiple tickets to be selected simultaneously |
| `mandatory` | `MaybeRefOrGetter<boolean \| "force"> \| undefined` | — | no | Controls mandatory selection behavior: - `false` (default): No mandatory selection enforcement - `true`: Prevents deselecting the last selected item - `'force'`: Automatically selects the first non-disabled item on registration |
| `baseZIndex` | `number \| undefined` | `2000` | no | Base z-index when stack is empty |
| `increment` | `number \| undefined` | `10` | no | Z-index increment between overlays |

## Methods

| Name | Type | Description |
|---|---|---|
| `clear` | `() => void` | Clear the entire registry |
| `has` | `(id: ID) => boolean` | Check if a ticket exists by ID |
| `keys` | `() => readonly ID[]` | Get all registered IDs |
| `browse` | `(value: E["value"]) => readonly ID[] \| undefined` | Browse for an ID(s) by value |
| `lookup` | `(index: number) => ID \| undefined` | Lookup a ticket by index number |
| `get` | `(id: ID) => E \| undefined` | Get a ticket by ID |
| `upsert` | `(id: ID, ticket?: Partial<Z>, event?: string) => E` | Update or insert a ticket by ID |
| `values` | `() => readonly E[]` | Get all values of registered tickets |
| `entries` | `() => readonly [ID, E][]` | Get all entries of registered tickets |
| `unregister` | `(id: ID) => void` | Unregister a ticket by ID |
| `reindex` | `() => void` | Reset the index directory and update all tickets |
| `move` | `(id: ID, toIndex: number) => E \| undefined` | Move a ticket to a new index position |
| `reorder` | `(ids: ID[]) => void` | Reorder the registry to match a canonical permutation of ids in one pass. |
| `seek` | `(direction?: "first" \| "last", from?: number, predicate?: (ticket: E) => boolean) => E \| undefined` | Seek for a ticket based on direction and optional predicate |
| `on` | `<K extends Extensible<RegistryEventName>>(event: K, cb: RegistryEventCallback<E, K>) => void` | Listen for registry events |
| `off` | `<K extends Extensible<RegistryEventName>>(event: K, cb: RegistryEventCallback<E, K>) => void` | Stop listening for registry events |
| `emit` | `<K extends Extensible<RegistryEventName>>(event: K, data: EventPayload<E, K>) => void` | Emit an event with data |
| `dispose` | `() => void` | Clears the registry and removes all listeners |
| `onboard` | `(registrations: Partial<Z & RegistryTicket>[]) => E[]` | Onboard multiple tickets at once |
| `offboard` | `(ids: ID[]) => Partial<Z>[]` | Offboard multiple tickets at once, returning the input shapes that were removed. |
| `batch` | `<R>(fn: () => R) => R` | Execute operations in a batch, deferring cache invalidation and event emission until complete |
| `reset` | `() => void` | Reset selection state without destroying the registry |
| `select` | `(id: ID) => void` | Select a ticket by ID |
| `unselect` | `(id: ID) => void` | Unselect a ticket by ID |
| `toggle` | `(id: ID) => void` | Toggle a ticket's selection state |
| `selected` | `(id: ID) => boolean` | Check if a ticket is currently selected |
| `apply` | `(values: unknown[], options?: { multiple?: boolean; }) => void` | Apply external values to the model |
| `mandate` | `() => void` | Mandate selected ID based on "mandatory" option |
| `register` | `(input?: Partial<Z>) => E` | Register an overlay ticket |

## Properties

| Name | Type | Description |
|---|---|---|
| `collection` | `ReadonlyMap<ID, E>` | The collection of tickets in the registry |
| `size` | `number` | The number of tickets in the registry |
| `selectedIds` | `Reactive<Set<ID>>` | Set of currently selected ticket IDs |
| `selectedItems` | `ComputedRef<Set<E>>` | Computed Set of selected ticket instances |
| `selectedValues` | `ComputedRef<Set<E["value"] extends Ref<infer U, infer U> ? U : E["value"]>>` | Computed Set of selected ticket values |
| `disabled` | `MaybeRefOrGetter<boolean>` | Disabled state for the entire model instance |
| `multiple` | `MaybeRefOrGetter<boolean>` | Whether the selection allows multiple selections |
| `isActive` | `Readonly<Ref<boolean, boolean>>` | Whether any overlays are selected (active) |
| `top` | `Readonly<Ref<E \| undefined, E \| undefined>>` | The topmost selected overlay ticket |
| `scrimZIndex` | `Readonly<Ref<number, number>>` | Z-index for the scrim (one below top overlay) |
| `isBlocking` | `Readonly<Ref<boolean, boolean>>` | Whether the topmost overlay blocks scrim clicks |
| `topElement` | `Readonly<Ref<Element \| null, Element \| null>>` | Element of the topmost selected modal overlay that has a resolvable DOM element (a top-layer `<dialog>`), or `null`. |