tuil
ReferencePackages@mwillbanks/tuil-focusAPI

FocusScopeDefinition

interface exported by @mwillbanks/tuil-focus.

View rawEdit

interface

Public interface exported by @mwillbanks/tuil-focus.

export interface FocusScopeDefinition {
  readonly id: string;
  readonly parentId?: string;
  readonly orientation?: "horizontal" | "vertical" | "grid";
  readonly loop?: boolean;
  readonly restoreFocus?: boolean;
  readonly trapped?: boolean;
}

Members

MemberTypeRequiredDescriptionRelated types
idstringYesThe id member uses the string contract.
parentIdstring | undefinedNoThe parentId member uses the string | undefined contract.
orientation"horizontal" | "vertical" | "grid" | undefinedNoThe orientation member uses the "horizontal" | "vertical" | "grid" | undefined contract.
loopboolean | undefinedNoThe loop member uses the boolean | undefined contract.
restoreFocusboolean | undefinedNoThe restoreFocus member uses the boolean | undefined contract.
trappedboolean | undefinedNoThe trapped member uses the boolean | undefined contract.

Parameters

This declaration has no public members.

Returns

This declaration does not return a value.

Throws

No thrown errors are documented for this declaration.

No package-local related types.

Source

View the secondary source reference

Package

@mwillbanks/tuil-focus

On this page