Interface FocusScopeModel

Headless focus capture, navigation, and restoration state.

interface FocusScopeModel {
    activate(previousFocusId?: string): string | undefined;
    deactivate(): string | undefined;
    current(): string | undefined;
    focus(id: string): string | undefined;
    next(): string | undefined;
    previous(): string | undefined;
}

Index

Methods

activate deactivate current focus next previous

Methods

activate

activate(previousFocusId?: string): string | undefined
Activates the scope and captures the identifier that should regain focus.
Parameters
- OptionalpreviousFocusId: string
Returns string | undefined
The item that should receive initial focus.
- Defined in primitives/focus-scope/index.ts:36

deactivate

deactivate(): string | undefined
Deactivates the scope.

Returns string | undefined
The captured identifier that should regain focus.
- Defined in primitives/focus-scope/index.ts:43

current

current(): string | undefined
Returns the current focus identifier while active.

Returns string | undefined
- Defined in primitives/focus-scope/index.ts:46

focus

focus(id: string): string | undefined
Moves focus to an enabled item while active.
Parameters
- id: string
Returns string | undefined
- Defined in primitives/focus-scope/index.ts:49

next

next(): string | undefined
Moves focus forward according to the trap policy.

Returns string | undefined
- Defined in primitives/focus-scope/index.ts:52

previous

previous(): string | undefined
Moves focus backward according to the trap policy.

Returns string | undefined
- Defined in primitives/focus-scope/index.ts:55