Interface IFocusable

Interface representing a focusable element.

interface IFocusable {
    _hid?: string;
    canReceiveFocus: boolean;
    contentId?: string;
    id: string;
    isFocused: boolean;
    parent?: IFocusable;
    findNextFocusable(
        event: INextFocusResolutionEvent,
    ): undefined | IFocusable | NextViewFocus;
    onBlur(): void;
    onFocus(event?: INextFocusResolutionEvent): void;
    onFocusedChildChange(childId: string): void;
    onInputEvent(inputEvent: HsInputEvent): void;
}

Hierarchy

IIdentifiable
- IFocusable

Index

Properties

_hid? canReceiveFocus contentId? id isFocused parent?

Methods

findNextFocusable? onBlur onFocus onFocusedChildChange? onInputEvent?

Properties

`Optional`_hid

_hid?: string

canReceiveFocus

canReceiveFocus: boolean

Indicates whether the element can receive focus.

`Optional`contentId

contentId?: string

id

id: string

isFocused

isFocused: boolean

Indicates whether the element is currently focused.

`Optional`parent

parent?: IFocusable

The parent focusable element, if any.

Methods

`Optional`findNextFocusable

findNextFocusable(
event: INextFocusResolutionEvent,
): undefined | IFocusable | NextViewFocus
Resolves the next focusable element in the given direction.
Parameters
- event: INextFocusResolutionEvent
  The event containing details about the focus transition.
Returns undefined | IFocusable | NextViewFocus
The next focusable element, or undefined if none exists.

onBlur

onBlur(): void
Called when the element loses focus.

Returns void

onFocus

onFocus(event?: INextFocusResolutionEvent): void
Called when the element receives focus.
Parameters
- Optionalevent: INextFocusResolutionEvent
  The event associated with the focus change.
Returns void

`Optional`onFocusedChildChange

onFocusedChildChange(childId: string): void
Called when a child element's focus state changes.
Parameters
- childId: string
  The ID of the child element.
Returns void

`Optional`onInputEvent

onInputEvent(inputEvent: HsInputEvent): void
Handles an input event.
Parameters
- inputEvent: HsInputEvent
Returns void