Class Navigation<ElementType>

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

Type Parameters

  • ElementType = TElementType

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

Hierarchy

  • Navigation

Constructors

constructor

Properties

STANDARD_NEXT_TEXT STANDARD_OLD_TEXT elements isUsedStandardText maxVisibleElements nextText oldText thisPage

Methods

_nextPage _oldPage getMaxPage getPageElements getPageInfo getPageNav isNext isOld numberPage selectedElement

Constructors

constructor

  • 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 Value

5

nextText

nextText: string[]

Массив с возможными командами для навигации вперед. Стоит использовать в том случае, если есть необходимость дополнить список существующих команд для навигации вперед

oldText

oldText: string[]

Массив с возможными командами для навигации назад. Стоит использовать в том случае, если есть необходимость дополнить список существующих команд для навигации назад

thisPage

thisPage: number

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

Default Value

0

Methods

Protected _nextPage

  • _nextPage(text: string): boolean

  • Осуществляет переход на следующую страницу. В случае успешного перехода вернет true.

    Returns

    boolean

    Parameters

    • text: string

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

    Returns boolean

Protected _oldPage

  • _oldPage(text: string): boolean

  • Осуществляет переход на предыдущую страницу. В случае успешного перехода вернет true.

    Returns

    boolean

    Parameters

    • text: string

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

    Returns boolean

getMaxPage

  • Возвращает максимальное количество страниц.

    Returns

    number

    Api

    Parameters

    • elements: null | ElementType[] = null

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

    Returns number

getPageElements

  • Возвращает новый массив данных, с учетом текущей страницы пользователя пользователя.

    Returns

    ElementType[]

    Api

    Parameters

    • elements: null | ElementType[] = null

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

    • text: string = ''

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

    Returns ElementType[]

getPageInfo

  • Возвращает информацию о текущей позиции пользователя.

    Returns

    string

    Api

    Returns string

getPageNav

  • Возвращает кнопки для навигации.

    Returns

    string[]

    Api

    Parameters

    • isNumber: boolean = false

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

    Returns string[]

isNext

  • Определяет желание пользователя двигаться вперед.

    Returns

    boolean

    Api

    Parameters

    • text: string

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

    Returns boolean

isOld

  • Определяет желание пользователя двигаться назад.

    Returns

    boolean

    Api

    Parameters

    • text: string

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

    Returns boolean

numberPage

  • Определяет желание пользователя перейти на определенную страницу. В случае успешного определения вернет true.

    Returns

    boolean

    Parameters

    • text: string

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

    Returns boolean

selectedElement

  • Выбор определенного элемента списка на нужной или текущей странице.

    Returns

    any

    Api

    Parameters

    • elements: null | ElementType[] = null

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

    • text: string = ''

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

    • keys: null | TKeys = null

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

    • thisPage: null | number = null

      Текущая страница. Если в аргумент ничего не передано, то используется текущая страница

    Returns null | ElementType

Settings

Member Visibility

Theme

Generated using TypeDoc