Class FocusTrap

Class that represents the focus trap.

Export

Hierarchy

FocusTrap

Properties

`Private` _firstFocusableElement

_firstFocusableElement: HTMLElement

`Private` _focusBottomCallback

_focusBottomCallback: Generic

`Private` _focusTopCallback

_focusTopCallback: Generic

`Private` _focusableElements

_focusableElements: HTMLElement[]

`Private` _isFocusTrap

_isFocusTrap: boolean

`Private` _lastFocusableElement

_lastFocusableElement: HTMLElement

`Private` _predictableBottomElement

_predictableBottomElement: HTMLElement

`Private` _predictableTopElement

_predictableTopElement: HTMLElement

`Private` _targetElement

_targetElement: HTMLElement

Constructors

constructor

new FocusTrap(opts: FocusTrapParams): FocusTrap
Parameters
- opts: FocusTrapParams
Returns FocusTrap
- Defined in OSFramework/Behaviors/FocusTrap.ts:28

Methods

`Private` _buildPredictableElements

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

`Private` _focusBottomHandler

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

`Private` _focusHandler

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

`Private` _focusTopHandler

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

`Private` _removeEventListeners

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

`Private` _setEventListeners

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

`Private` _setFocusOnElement

_setFocusOnElement(focusableElement: HTMLElement, selfElement: HTMLElement): void
Parameters
- focusableElement: HTMLElement
- selfElement: HTMLElement
Returns void
- Defined in OSFramework/Behaviors/FocusTrap.ts:107

`Private` _setFocusableElements

_setFocusableElements(): void
Returns void
- Defined in OSFramework/Behaviors/FocusTrap.ts:116

`Private` _setFocusableProperties

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

`Private` _unsetCallbacks

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

disableForA11y

disableForA11y(): void
Set element disabled for A11Y

Memberof
OSFramework.Behaviors.FocusTrap

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

dispose

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

Memberof
OSFramework.Behaviors.FocusTrap

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

enableForA11y

enableForA11y(): void
Set element enabled for A11Y

Memberof
OSFramework.Behaviors.FocusTrap

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

Accessors

bottomElement

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

Memberof
OSFramework.Behaviors.FocusTrap

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

topElement

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

Memberof
OSFramework.Behaviors.FocusTrap

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

focusableElements

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

Memberof
OSFramework.Behaviors.FocusTrap

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