Класс NavigableItemsStore

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

Индекс

Конструкторы

Свойства

Акцессоры

isScrollingInAction

Методы

addNavigableItem getCurrentItem getNavigableItemsByType removeAllNavigableItems removeNavigableItem scrollTo setCurrentItem setIsScrolling

Конструкторы

constructor

new NavigableItemsStore(): NavigableItemsStore
Возвращает NavigableItemsStore

Свойства

`Protected`isScrolling

isScrolling: boolean

Акцессоры

isScrollingInAction

get isScrollingInAction(): boolean
Геттер, определяющий осуществляется ли в текущий момент прокрутка

Возвращает boolean

Методы

addNavigableItem

addNavigableItem(
    type: string,
    id: string,
    displayName: string,
    parent: string | undefined,
    ref: RefObject<HTMLElement | Component<{}, {}, any>>,
    orderIndex?: number,
): void
Метод регистрации элемента навигации
Параметры
- type: string
  Тип элемента
- id: string
  Идентификатор элемента
- displayName: string
  Отображаемое имя элемента
- parent: string | undefined
  Идентификатор родительского элемента
- ref: RefObject<HTMLElement | Component<{}, {}, any>>
  Ссылка на компонент, соответствующий элементу навигации
- OptionalorderIndex: number
  Порядковый номер элемента
Возвращает void

getCurrentItem

getCurrentItem(): string | undefined
Метод получения идентификатора текущего элемента

Возвращает string | undefined

getNavigableItemsByType

getNavigableItemsByType(type: string): NavigableItem[]
Метод получения списка элементов навигации определенного типа
Параметры
- type: string
  Тип элемента
Возвращает NavigableItem[]

removeAllNavigableItems

removeAllNavigableItems(): void
Метод удаления всех элементов навигации

Возвращает void

removeNavigableItem

removeNavigableItem(type: string, id: string): void
Метод удаления элемента навигации
Параметры
- type: string
  Тип элемента
- id: string
  Идентификатор элемента
Возвращает void

scrollTo

scrollTo(ref: RefObject<any>): void
Метод прокрутки страницы до элемента
Параметры
- ref: RefObject<any>
Возвращает void

setCurrentItem

setCurrentItem(id: string): void
Метод, сохраняющий идентификатор текущего элемента
Параметры
- id: string
  Идентификатор элемента
Возвращает void

`Protected`setIsScrolling

setIsScrolling(isScrolling: boolean): void
Параметры
- isScrolling: boolean
Возвращает void

© Авторские права 2025, Юниверс Дата.