Class Navigation<ElementType>

constructor

• new Navigation<ElementType = unknown>(
      maxVisibleElements?: number,
  ): Navigation<ElementType>

  Создает экземпляр класса Navigation.

  Type Parameters

  • ElementType = unknown

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

  Parameters

  • OptionalmaxVisibleElements: number = 5

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

  Returns Navigation<ElementType>

  Example

  // Создание с 3 элементами на странице
  const navigation = new Navigation(3);
  
  // Создание с 10 элементами на странице
  const navigation = new Navigation(10);
  Copy

elements

[]
Copy

isUsedStandardText

true
Copy

maxVisibleElements

5
Copy

nextText

[]
Copy

navigation.nextText = ['следующая', 'продолжить'];
Copy

oldText

[]
Copy

navigation.oldText = ['предыдущая', 'вернуться'];
Copy

STANDARD_NEXT_TEXT

['дальше', 'вперед']
Copy

STANDARD_OLD_TEXT

['назад']
Copy

thisPage

0
Copy

getMaxPage

• getMaxPage(elements?: ElementType[] | null): number

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

  Parameters

  • elements: ElementType[] | null = null

    Массив элементов

  Returns number

  Максимальное количество страниц

  Example

  const elements = [
    { id: 1, name: 'Элемент 1' },
    { id: 2, name: 'Элемент 2' },
    { id: 3, name: 'Элемент 3' }
  ];
  
  const maxPage = navigation.getMaxPage(elements);
  // 2 (при maxVisibleElements = 2)
  Copy

getPageElements

• getPageElements(elements?: ElementType[] | null, text?: string): ElementType[]

  Возвращает массив элементов текущей страницы. Обрабатывает команды навигации и возвращает элементы в пределах maxVisibleElements

  При передаче text с командой навигации ("дальше"/"назад" — сравнение чувствительно к регистру, передавайте текст в нижнем регистре, как controller.userCommand) автоматически изменяет this.thisPage (текущую страницу).

  Parameters

  • elements: ElementType[] | null = null

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

  • text: string = ''

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

  Returns ElementType[]

  Массив элементов текущей страницы

  Example

  // Навигация с 3 элементами на странице:
  // const navigation = new Navigation(3);
  const elements = [
    { id: 1, name: 'Элемент 1' },
    { id: 2, name: 'Элемент 2' },
    { id: 3, name: 'Элемент 3' },
    { id: 4, name: 'Элемент 4' }
  ];
  
  // Получение элементов первой страницы (3 элемента при maxVisibleElements = 3)
  const pageElements = navigation.getPageElements(elements);
  // [{ id: 1, name: 'Элемент 1' }, { id: 2, name: 'Элемент 2' }, { id: 3, name: 'Элемент 3' }]
  
  // Переход на следующую страницу
  const nextPageElements = navigation.getPageElements(null, 'вперед');
  // [{ id: 4, name: 'Элемент 4' }]
  Copy

getPageInfo

• getPageInfo(): string

  Возвращает информацию о текущей странице. Формирует строку с информацией о текущей позиции. При единственной странице возвращает пустую строку ''.

  Returns string

  Информация о текущей странице

  Example

  const info = navigation.getPageInfo();
  // "1 страница из 3"
  Copy

getPageNav

• getPageNav(isNumber?: boolean): string[]

  Возвращает массив команд навигации. Формирует список доступных команд для навигации по страницам

  Parameters

  • OptionalisNumber: boolean = false

    Включить команды с номерами страниц

  Returns string[]

  Массив команд навигации

  Example

  // Получение базовых команд: «Назад» не отдаётся на первой странице,
  // «Дальше» — на последней; при единственной странице вернётся ['[1]']
  const commands = navigation.getPageNav();
  // ['👈 Назад', 'Дальше 👉'] (на средней странице)
  
  // Получение команд с номерами страниц (текущая выделяется скобками)
  const numbered = navigation.getPageNav(true);
  // ['[1]', '2']
  Copy

isNext

• isNext(text: string): boolean

  Определяет желание пользователя двигаться вперед. Проверяет наличие команд навигации вперед в тексте

  Parameters

  • text: string

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

  Returns boolean

  true если обнаружена команда навигации вперед

  Example

  const isNext = navigation.isNext('покажи дальше'); // true
  const isNext = navigation.isNext('вернись назад'); // false
  Copy

isOld

• isOld(text: string): boolean

  Определяет желание пользователя двигаться назад. Проверяет наличие команд навигации назад в тексте

  Parameters

  • text: string

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

  Returns boolean

  true если обнаружена команда навигации назад

  Example

  const isOld = navigation.isOld('вернись назад'); // true
  const isOld = navigation.isOld('покажи дальше'); // false
  Copy

numberPage

• numberPage(text: string): boolean

  Определяет желание пользователя перейти на определенную страницу. Ищет в тексте указание конкретной страницы в формате "N страница"

  Parameters

  • text: string

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

  Returns boolean

  true если обнаружено указание страницы

  Example

  const isNumberPage = navigation.numberPage('покажи 2 страницу'); // true
  const isNumberPage = navigation.numberPage('следующая страница'); // false
  Copy

selectedElement

• selectedElement(
      elements?: ElementType[] | null,
      text?: string,
      keys?: TKeys | null,
      thisPage?: number | null,
  ): ElementType | null

  Выбор элемента из списка по тексту или номеру. Поддерживает поиск по тексту с учетом схожести и выбор по номеру

  Parameters

  • elements: ElementType[] | null = null

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

  • text: string = ''

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

  • Optionalkeys: TKeys | null = null

    Ключи для поиска по объектам

  • OptionalthisPage: number | null = null

    Текущая страница (если передана — перезаписывает this.thisPage)

  Returns ElementType | null

  Выбранный элемент или null

  Example

  const elements = [
    { id: 1, name: 'Элемент 1' },
    { id: 2, name: 'Элемент 2' }
  ];
  
  // Выбор по номеру
  const selected = navigation.selectedElement(elements, 'выбери 1');
  // { id: 1, name: 'Элемент 1' }
  
  // Выбор по тексту
  const selected = navigation.selectedElement(elements, 'Элемент 2', ['name']);
  // { id: 2, name: 'Элемент 2' }
  Copy