Class FocusTrap

Class that represents the focus trap.

Export

Hierarchy

FocusTrap

Properties

`Private` _canTargetContainOtherPatts

_canTargetContainOtherPatts: boolean = false

`Private` _firstFocusableElement

_firstFocusableElement: HTMLElement

`Private` _focusBottomCallback

_focusBottomCallback: Generic

`Private` _focusBottomHandlerCallback

_focusBottomHandlerCallback: Generic

`Private` _focusTopCallback

_focusTopCallback: Generic

`Private` _focusTopHandlerCallback

_focusTopHandlerCallback: Generic

`Private` _focusableElements

_focusableElements: HTMLElement[]

`Private` _hasBeenPassThoughFirstOne

_hasBeenPassThoughFirstOne: boolean = false

`Private` _lastFocusableElement

_lastFocusableElement: HTMLElement

`Private` _predictableBottomElement

_predictableBottomElement: HTMLElement

`Private` _predictableTopElement

_predictableTopElement: HTMLElement

`Private` _targetElement

_targetElement: HTMLElement

Constructors

constructor

new FocusTrap(opts: FocusTrapParams): FocusTrap
Creates an instance of FocusTrap.

Memberof
FocusTrap
Parameters
- opts: FocusTrapParams
Returns FocusTrap
- Defined in OSFramework/OSUI/Behaviors/FocusTrap.ts:37

Methods

`Private` _buildPredictableElements

_buildPredictableElements(): void
Returns void
- Defined in OSFramework/OSUI/Behaviors/FocusTrap.ts:55

`Private` _focusBottomHandler

_focusBottomHandler(): void
Returns void
- Defined in OSFramework/OSUI/Behaviors/FocusTrap.ts:72

`Private` _focusHandler

_focusHandler(focusableElement: HTMLElement, callback: Generic): void
Parameters
- focusableElement: HTMLElement
- callback: Generic
Returns void
- Defined in OSFramework/OSUI/Behaviors/FocusTrap.ts:77

`Private` _focusTopHandler

_focusTopHandler(): void
Returns void
- Defined in OSFramework/OSUI/Behaviors/FocusTrap.ts:101

`Private` _removeEventListeners

_removeEventListeners(): void
Returns void
- Defined in OSFramework/OSUI/Behaviors/FocusTrap.ts:106

`Private` _setCallbacks

_setCallbacks(): void
Returns void
- Defined in OSFramework/OSUI/Behaviors/FocusTrap.ts:114

`Private` _setEventListeners

_setEventListeners(): void
Returns void
- Defined in OSFramework/OSUI/Behaviors/FocusTrap.ts:120

`Private` _setFocusableElements

_setFocusableElements(includeTabIndexHidden?: boolean): void
Parameters
- includeTabIndexHidden: boolean = false
Returns void
- Defined in OSFramework/OSUI/Behaviors/FocusTrap.ts:129

`Private` _setFocusableProperties

_setFocusableProperties(): void
Returns void
- Defined in OSFramework/OSUI/Behaviors/FocusTrap.ts:192

`Private` _unsetCallbacks

_unsetCallbacks(): void
Returns void
- Defined in OSFramework/OSUI/Behaviors/FocusTrap.ts:208

disableForA11y

disableForA11y(): void
Set element disabled for A11Y

Memberof
OSFramework.Behaviors.FocusTrap

Returns void
- Defined in OSFramework/OSUI/Behaviors/FocusTrap.ts:220

dispose

dispose(): void
Method to remove the event listeners and unset the callbacks

Memberof
OSFramework.Behaviors.FocusTrap

Returns void
- Defined in OSFramework/OSUI/Behaviors/FocusTrap.ts:237

enableForA11y

enableForA11y(): void
Set element enabled for A11Y

Memberof
OSFramework.Behaviors.FocusTrap

Returns void
- Defined in OSFramework/OSUI/Behaviors/FocusTrap.ts:253

Accessors

bottomElement

get bottomElement(): HTMLElement
Getter that allows to obtain the bottomElement reference

Memberof
OSFramework.Behaviors.FocusTrap

Returns HTMLElement
- Defined in OSFramework/OSUI/Behaviors/FocusTrap.ts:273

topElement

get topElement(): HTMLElement
Getter that allows to obtain the bottomElement reference

Memberof
OSFramework.Behaviors.FocusTrap

Returns HTMLElement
- Defined in OSFramework/OSUI/Behaviors/FocusTrap.ts:284

focusableElements

get focusableElements(): HTMLElement[]
Getter that allows to obtain the list of focusable elements

Memberof
OSFramework.Behaviors.FocusTrap

Returns HTMLElement[]
- Defined in OSFramework/OSUI/Behaviors/FocusTrap.ts:295

Class FocusTrap

Export

Hierarchy

Index

Properties

Constructors

Methods

Accessors

Properties

Private _canTargetContainOtherPatts

Private _firstFocusableElement

Private _focusBottomCallback

Private _focusBottomHandlerCallback

Private _focusTopCallback

Private _focusTopHandlerCallback

Private _focusableElements

Private _hasBeenPassThoughFirstOne

Private _lastFocusableElement

Private _predictableBottomElement

Private _predictableTopElement

Private _targetElement

Constructors

constructor

Memberof

Parameters

opts: FocusTrapParams

Returns FocusTrap

Methods

Private _buildPredictableElements

Returns void

Private _focusBottomHandler

Returns void

Private _focusHandler

Parameters

focusableElement: HTMLElement

callback: Generic

Returns void

Private _focusTopHandler

Returns void

Private _removeEventListeners

Returns void

Private _setCallbacks

Returns void

Private _setEventListeners

Returns void

Private _setFocusableElements

Parameters

includeTabIndexHidden: boolean = false

Returns void

Private _setFocusableProperties

Returns void

Private _unsetCallbacks

Returns void

disableForA11y

Memberof

Returns void

dispose

Memberof

Returns void

enableForA11y

Memberof

Returns void

Accessors

bottomElement

Memberof

Returns HTMLElement

topElement

Memberof

Returns HTMLElement

focusableElements

Memberof

Returns HTMLElement[]

Settings

Member Visibility

Theme

`Private` _canTargetContainOtherPatts

`Private` _firstFocusableElement

`Private` _focusBottomCallback

`Private` _focusBottomHandlerCallback

`Private` _focusTopCallback

`Private` _focusTopHandlerCallback

`Private` _focusableElements

`Private` _hasBeenPassThoughFirstOne

`Private` _lastFocusableElement

`Private` _predictableBottomElement

`Private` _predictableTopElement

`Private` _targetElement

`Private` _buildPredictableElements

`Private` _focusBottomHandler

`Private` _focusHandler

`Private` _focusTopHandler

`Private` _removeEventListeners

`Private` _setCallbacks

`Private` _setEventListeners

`Private` _setFocusableElements

`Private` _setFocusableProperties

`Private` _unsetCallbacks