Class KeyNavBoard

Hierarchy

KeyNavBoard

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new KeyNavBoard(options?: KeyNavBoardConstructorOptions): KeyNavBoard

- Defined in KeyNavBoard.ts:89
Parameters
- options: KeyNavBoardConstructorOptions = ...
Returns KeyNavBoard

Properties

activeItem

activeItem: null | NavItem

id

id: string

items

items: {}

Type declaration

[key: string]: NavItem | undefined

listHead

listHead: undefined | NavItem

listTail

listTail: undefined | NavItem

remember

remember: boolean

Static id

id: number = 1

Methods

addItem

addItem(item: NavItem): void

- Defined in KeyNavBoard.ts:101
add item to the board

Parameters
- item: NavItem
Returns void

getActiveItem

getActiveItem(): null | NavItem

- Defined in KeyNavBoard.ts:169
Returns null | NavItem

Protected getCoordinates

getCoordinates(item: any): Coordinates

- Defined in KeyNavBoard.ts:172
Parameters
- item: any
Returns Coordinates

Protected getIntersectionVal

getIntersectionVal(head: number, foot: number, itemHead: number, itemFoot: number): number

- Defined in KeyNavBoard.ts:249
Parameters
- head: number
- foot: number
- itemHead: number
- itemFoot: number
Returns number

Protected getMatchResult

getMatchResult(currentItem: NavItem, direction: Direction, memoryItem?: NavItem): null | NavItem

- Defined in KeyNavBoard.ts:176
Parameters
- currentItem: NavItem
- direction: Direction
- Optional memoryItem: NavItem
Returns null | NavItem

getNext

getNext(direction: Direction): undefined | null | NavItem

- Defined in KeyNavBoard.ts:310
Parameters
- direction: Direction
Returns undefined | null | NavItem

navigate

navigate(direction: Direction): undefined | NavItem

- Defined in KeyNavBoard.ts:300
Parameters
- direction: Direction
Returns undefined | NavItem

removeItem

removeItem(item: NavItem): void

- Defined in KeyNavBoard.ts:123
remove item from board

Parameters
- item: NavItem
Returns void

setActiveItem

setActiveItem(item: NavItem): void

- Defined in KeyNavBoard.ts:158
Parameters
- item: NavItem
Returns void

Generated using TypeDoc