Class NavigableItemsStore

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

Public

Index

Constructors

Properties

Accessors

isScrollingInAction

Methods

addNavigableItem getCurrentItem getNavigableItemsByType removeAllNavigableItems removeNavigableItem scrollTo setCurrentItem setIsScrolling

Constructors

constructor

new NavigableItemsStore(): NavigableItemsStore
Returns NavigableItemsStore

Properties

`Protected`isScrolling

isScrolling: boolean

Accessors

isScrollingInAction

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

Returns boolean
- Defined in app-sdk/index.d.ts:11027

Methods

addNavigableItem

addNavigableItem(
    type: string,
    id: string,
    displayName: string,
    parent: undefined | string,
    ref: RefObject<HTMLElement | Component<{}, {}, any>>,
): void
Метод регистрации элемента навигации
Parameters
- type: string
  Тип элемента
- id: string
  Идентификатор элемента
- displayName: string
  Отображаемое имя элемента
- parent: undefined | string
  Идентификатор родительского элемента
- ref: RefObject<HTMLElement | Component<{}, {}, any>>
  Ссылка на компонент, соответствующий элементу навигации
Returns void
- Defined in app-sdk/index.d.ts:11047

getCurrentItem

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

Returns undefined | string
- Defined in app-sdk/index.d.ts:11037

getNavigableItemsByType

getNavigableItemsByType(type: string): NavigableItem[]
Метод получения списка элементов навигации определенного типа
Parameters
- type: string
  Тип элемента
Returns NavigableItem[]
- Defined in app-sdk/index.d.ts:11060

removeAllNavigableItems

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

Returns void
- Defined in app-sdk/index.d.ts:11064

removeNavigableItem

removeNavigableItem(type: string, id: string): void
Метод удаления элемента навигации
Parameters
- type: string
  Тип элемента
- id: string
  Идентификатор элемента
Returns void
- Defined in app-sdk/index.d.ts:11054

scrollTo

scrollTo(ref: RefObject<any>): void
Метод прокрутки страницы до элемента
Parameters
- ref: RefObject<any>
Returns void
- Defined in app-sdk/index.d.ts:11068

setCurrentItem

setCurrentItem(id: string): void
Метод, сохраняющий идентификатор текущего элемента
Parameters
- id: string
  Идентификатор элемента
Returns void
- Defined in app-sdk/index.d.ts:11033

`Protected`setIsScrolling

setIsScrolling(isScrolling: boolean): void
Parameters
- isScrolling: boolean
Returns void
- Defined in app-sdk/index.d.ts:11069