Class SpatialNavigation

Hierarchy

SpatialNavigation

Constructors

`Private` constructor

new SpatialNavigation(): SpatialNavigation
Returns SpatialNavigation
- Defined in core/SpatialNavigation.ts:33

Properties

`Private` allFocusableItems

allFocusableItems: null | HTMLCollectionOf<HTMLElement> = null

`Private` boundedOnFocus

boundedOnFocus: ((event: FocusEvent) => void) = ...

Type declaration

- (event: FocusEvent): void
- Parameters
  - event: FocusEvent
  Returns void

`Private` boundedOnKeyDown

boundedOnKeyDown: ((event: KeyboardEvent) => boolean) = ...

Type declaration

- (event: KeyboardEvent): boolean
- Parameters
  - event: KeyboardEvent
  Returns boolean

`Private` defaultSectionId

defaultSectionId: null | string = null

`Private` `Readonly` globalConfig

globalConfig: Config = ...

`Private` intersectionObserver

intersectionObserver: null | IntersectionObserver = null

`Private` lastSectionId

lastSectionId: null | string = null

`Private` mutationObserver

mutationObserver: null | MutationObserver = null

`Private` pause

pause: boolean = false

`Private` ready

ready: boolean = false

`Private` sections

sections: Map<string, Section> = ...

`Private` throttleKeyDown

throttleKeyDown: boolean = false

`Private` visibleItems

visibleItems: Set<HTMLElement> = ...

`Static` `Private` instance

instance: null | SpatialNavigation = null

Methods

add

add(sectionId: string, config?: Partial<Config>): void
Добавляет секцию в spatnav instance. После добавления она сразу доступна для навигации.

Returns
секция
Parameters
- sectionId: string
- Optional config: Partial<Config>
Returns void
- Defined in core/SpatialNavigation.ts:548

customizeGlobalConfig

customizeGlobalConfig(config: Config): void
Кастомизация глобального конфига SpatialNavigation
Parameters
- config: Config
Returns void
- Defined in core/SpatialNavigation.ts:500

disable

disable(sectionId: string): boolean
Выключает навигацию в данной секции.

Returns
true если секция была выключена
Parameters
- sectionId: string
Returns boolean
- Defined in core/SpatialNavigation.ts:619

enable

enable(sectionId: string): boolean
Включает навигацию в данной секции.

Returns
true если секция была включена
Parameters
- sectionId: string
Returns boolean
- Defined in core/SpatialNavigation.ts:638

focus

focus(sectionId?: null | string): boolean
Фокусирует секцию с указанным sectionId или на defaultSection.
Parameters
- sectionId: null | string = ...
Returns boolean
- Defined in core/SpatialNavigation.ts:669

`Private` focusNext

focusNext(direction: Direction, currentFocusedElement: HTMLElement, currentSectionId: string): boolean
Parameters
- direction: Direction
- currentFocusedElement: HTMLElement
- currentSectionId: string
Returns boolean
- Defined in core/SpatialNavigation.ts:90

`Private` focusSection

focusSection(sectionId: string): boolean
Parameters
- sectionId: string
Returns boolean
- Defined in core/SpatialNavigation.ts:84

forgetLastElementInSection

forgetLastElementInSection(sectionId: string): void
Забыть последний элемент в данной секции
Parameters
- sectionId: string
Returns void
- Defined in core/SpatialNavigation.ts:719

get

get(sectionId: string): null | Section
Returns
Section или undefined если секции с таким id нет
Parameters
- sectionId: string
Returns null | Section
- Defined in core/SpatialNavigation.ts:520

has

has(sectionId: string): boolean
Проверяет существует ли секция в spatnav instance.

Returns
true если секция существует
Parameters
- sectionId: string
Returns boolean
- Defined in core/SpatialNavigation.ts:511

init

init(defaultSectionId?: null | string): void
Включает навигацию:
- устанавливает секцию по умолчанию, если был передан параметр
- добавляет EventListener'ы на window для работы навигации
- включает IntersectionObserver и MutationObserver, следящие за видимыми элементами на экране
Parameters
- defaultSectionId: null | string = null
Returns void
- Defined in core/SpatialNavigation.ts:412

move

move(direction: Direction): boolean
Перемещает фокус в указанном направлении как будто была нажата кнопка (вверх, вниз итд.) от текущего активного элемента

Returns
- произошёл ли переход
Parameters
- direction: Direction
  
  направление перехода
Returns boolean
- Defined in core/SpatialNavigation.ts:684

`Private` onFocus

onFocus(event: FocusEvent): void
Parameters
- event: FocusEvent
Returns void
- Defined in core/SpatialNavigation.ts:378

`Private` onKeyDown

onKeyDown(event: KeyboardEvent): boolean
Parameters
- event: KeyboardEvent
Returns boolean
- Defined in core/SpatialNavigation.ts:322

pauseNavigation

pauseNavigation(): void
Выключает навигацию полностью.

Returns void
- Defined in core/SpatialNavigation.ts:653

remove

remove(sectionId: string): boolean
Удаляет секцию из spatnavInstance.

Returns
true если секция была удалена
Parameters
- sectionId: string
Returns boolean
- Defined in core/SpatialNavigation.ts:598

resumeNavigation

resumeNavigation(): void
Включает навигацию полностью.

Returns void
- Defined in core/SpatialNavigation.ts:660

set

set(sectionId: string, config?: Partial<Config>): void
Перезаписывает конфиг секции с помощью Object.assign
Parameters
- sectionId: string
- config: Partial<Config> = {}
Returns void
- Defined in core/SpatialNavigation.ts:531

setDefaultSection

setDefaultSection(sectionId: string): void
Устанавливает секцию по умолчанию
Parameters
- sectionId: string
Returns void
- Defined in core/SpatialNavigation.ts:705

`Private` setThrottleKeyDown

setThrottleKeyDown(): void
Returns void
- Defined in core/SpatialNavigation.ts:318

unInit

unInit(): void
Выключает навигацию:
- удаляет все секции
- удаляет все EventListener'ы из window
- удаляет секцию по умолчанию
- удаляет последнюю активную секцию
- выключает IntersectionObserver и MutationObserver, следящие за элементами видимыми на экране
Returns void
- Defined in core/SpatialNavigation.ts:474

`Static` getInstance

getInstance(): SpatialNavigation
Returns SpatialNavigation
- Defined in core/SpatialNavigation.ts:39

Class SpatialNavigation

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Private constructor

Returns SpatialNavigation

Properties

Private allFocusableItems

Private boundedOnFocus

Type declaration

Parameters

event: FocusEvent

Returns void

Private boundedOnKeyDown

Type declaration

Parameters

event: KeyboardEvent

Returns boolean

Private defaultSectionId

Private Readonly globalConfig

Private intersectionObserver

Private lastSectionId

Private mutationObserver

Private pause

Private ready

Private sections

Private throttleKeyDown

Private visibleItems

Static Private instance

Methods

add

Returns

Parameters

sectionId: string

Optional config: Partial<Config>

Returns void

customizeGlobalConfig

Parameters

config: Config

Returns void

disable

Returns

Parameters

sectionId: string

Returns boolean

enable

Returns

Parameters

sectionId: string

Returns boolean

focus

Parameters

sectionId: null | string = ...

Returns boolean

Private focusNext

Parameters

direction: Direction

currentFocusedElement: HTMLElement

currentSectionId: string

Returns boolean

Private focusSection

Parameters

sectionId: string

Returns boolean

forgetLastElementInSection

Parameters

sectionId: string

Returns void

get

Returns

Parameters

sectionId: string

Returns null | Section

has

Returns

Parameters

sectionId: string

`Private` constructor

`Private` allFocusableItems

`Private` boundedOnFocus

`Private` boundedOnKeyDown

`Private` defaultSectionId

`Private` `Readonly` globalConfig

`Private` intersectionObserver

`Private` lastSectionId

`Private` mutationObserver

`Private` pause

`Private` ready

`Private` sections

`Private` throttleKeyDown

`Private` visibleItems

`Static` `Private` instance

`Optional` config: Partial<Config>

`Private` focusNext

`Private` focusSection

`Private` onFocus

`Private` onKeyDown

`Private` setThrottleKeyDown

`Static` getInstance