Class FocusTrap

Ensures that the user can only focus on elements within a specified container ("trap").

When enabled, the user will not be able to interact with elements outside the trap.

Be sure to disable when done to prevent memory leaks.

Index

Constructors

Properties

container direction focusMemory isActive

Methods

activate deactivate

Constructors

constructor

new FocusTrap(container: Elemental, options?: FocusTrapOptions): FocusTrap
Parameters
- container: Elemental
  The element to trap focus within
- options: FocusTrapOptions = {}
  Options to provide to the FocusTrap
Returns FocusTrap
- Defined in src/managers/FocusTrap.ts:27

Properties

container

container: Elemental

direction

direction: -1 | 1 = 1

focusMemory

focusMemory: FocusMemory = ...

isActive

isActive: boolean = false

Methods

activate

activate(): void
Enables the FocusTrap

Returns void
- Defined in src/managers/FocusTrap.ts:44

deactivate

deactivate(): void
Disables the FocusTrap

Returns void
- Defined in src/managers/FocusTrap.ts:55