Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Navigation<ElementType>

Класс отвечающий за корректную навигацию по элементам меню.

Type parameters

  • ElementType = TElementType

    тип элементов, по которым будет происходить навигация

Hierarchy

  • Navigation

Index

Constructors

constructor

  • new Navigation<ElementType>(maxVisibleElements?: number): Navigation<ElementType>
  • Navigation constructor.

    Type parameters

    • ElementType = any

    Parameters

    • maxVisibleElements: number = 5

      Максимально количество отображаемых элементов.

    Returns Navigation<ElementType>

Properties

STANDARD_NEXT_TEXT

STANDARD_NEXT_TEXT: string[] = ...

STANDARD_OLD_TEXT

STANDARD_OLD_TEXT: string[] = ...

elements

elements: ElementType[]

Массив элементов для обработки.

isUsedStandardText

isUsedStandardText: boolean

Использование стандартных команд навигации Если true, тогда используются стандартные команды.

maxVisibleElements

maxVisibleElements: number

(default 5) Максимальное количество отображаемых элементов.

nextText

nextText: string[]

Массив с возможными командами для навигации вперед.

oldText

oldText: string[]

Массив с возможными командами для навигации назад.

thisPage

thisPage: number

(default 0) Текущая страница. Рекомендуется получать это значение после завершения всех операция.

Methods

Protected _nextPage

  • _nextPage(text: string): boolean
  • Осуществляет переход на следующую страницу. В случае успешного перехода вернет true.

    Parameters

    • text: string

      Пользовательский запрос.

    Returns boolean

    boolean

Protected _oldPage

  • _oldPage(text: string): boolean
  • Осуществляет переход на предыдущую страницу. В случае успешного перехода вернет true.

    Parameters

    • text: string

      Пользовательский запрос.

    Returns boolean

    boolean

getMaxPage

  • getMaxPage(elements?: null | ElementType[]): number
  • Возвращает максимальное количество страниц.

    api

    Parameters

    • elements: null | ElementType[] = null

      Элемент для обработки.

    Returns number

    number

getPageInfo

  • getPageInfo(): string

getPageNav

  • getPageNav(isNumber?: boolean): string[]
  • Возвращает кнопки навигации.

    api

    Parameters

    • isNumber: boolean = false

      Использование числовой навигации. Если true, тогда будут отображаться кнопки с числовой навигацией.

    Returns string[]

    string[]

isNext

  • isNext(text: string): boolean
  • Определяет желание пользователя двигаться вперед.

    api

    Parameters

    • text: string

      Пользовательский запрос.

    Returns boolean

    boolean

isOld

  • isOld(text: string): boolean
  • Определяет желание пользователя двигаться назад.

    api

    Parameters

    • text: string

      Пользовательский запрос.

    Returns boolean

    boolean

nav

  • nav(elements?: null | ElementType[], text?: string): ElementType[]
  • Возвращает новый массив данных, с учетом текущего положения пользователя.

    api

    Parameters

    • elements: null | ElementType[] = null

      Элемент для обработки.

    • text: string = ''

      Пользовательский запрос.

    Returns ElementType[]

    ElementType[]

numberPage

  • numberPage(text: string): boolean
  • Определяет желание пользователя перейти на определенную страницу. В случае успешного перехода вернет true.

    Parameters

    • text: string

      Пользовательский запрос.

    Returns boolean

    boolean

selectedElement

  • selectedElement(elements?: null | ElementType[], text?: string, keys?: null | string | string[], thisPage?: null | number): null | ElementType
  • Выбор определенного элемента списка на нужной странице.

    api

    Parameters

    • elements: null | ElementType[] = null

      Элемент для обработки.

    • text: string = ''

      Пользовательский запрос.

    • keys: null | string | string[] = null

      Поиск элемента по ключу массива. Если null, тогда подразумевается, что передан массив из строк.

    • thisPage: null | number = null

      Текущая страница.

    Returns null | ElementType

    any

Generated using TypeDoc