Interface: FocusGroupController

Defined in: src/widgets/utility/focusGroup.tsx:158

Controller to manipulate the focus inside the FocusGroup.

Properties

Property	Modifier	Type	Description
defaultClick	readonly	(e) => void	Default implementation for onClick handler which focuses on the clicked item.
defaultKeyDown	readonly	(e) => void	Default implementation for onKeyDown handler which focuses on the next/previous items on ArrowDown/ArrowUp keys.

Methods

ensureFocusable()

ensureFocusable(params?): void

Defined in: src/widgets/utility/focusGroup.tsx:187

Ensures that the group has a reachable via Tab key focusable item otherwise (or always if reset is true) makes the first active focusable item as such.

Parameters

Parameter	Type
params?	{ reset?: boolean; }
params.reset?	boolean

Returns

void

---

focusAt()

focusAt(leaf): void

Defined in: src/widgets/utility/focusGroup.tsx:166

Tries to focus on active item containing specified leaf child.

Parameters

Parameter	Type
leaf	HTMLElement

Returns

void

---

focusNext()

focusNext(params): void

Defined in: src/widgets/utility/focusGroup.tsx:176

Tries to focus on a next active item closest to item with specified from child.

Parameters

Parameter	Type
params	{ from: Element; }
params.from	Element

Returns

void

---

focusParent()

focusParent(params): void

Defined in: src/widgets/utility/focusGroup.tsx:181

Tries to focus on a parent active item closest to item with specified from child.

Parameters

Parameter	Type
params	{ from: Element; }
params.from	Element

Returns

void

---

focusPrevious()

focusPrevious(params): void

Defined in: src/widgets/utility/focusGroup.tsx:171

Tries to focus on a previous active item closest to item with specified from child.

Parameters

Parameter	Type
params	{ from: Element; }
params.from	Element

Returns

void

---

getRoot()

getRoot(): null | HTMLElement

Defined in: src/widgets/utility/focusGroup.tsx:162

Gets current focus group root DOM element.

Returns

null | HTMLElement