Документация для разработчиков
Темная тема

Фронтенд роутера

Представляет собой часть сервиса роутинга на фронтенде.

Перед использованием этот объект должен быть инициализирован шаблонами ссылок.

Происходит это в методе \Bitrix\Crm\Component\Base::addJsRouter(), который необходимо вызвать в шаблоне компонента.

/** @see \Bitrix\Crm\Component\Base::addJsRouter() */
$this->getComponent()->addJsRouter($this);

На стороне фронтенда доступ к объекту осуществляется через статическое свойство Instance, где находится актуальный инициализированный объект.


Методы

setUrlTemplates(params: UrlTemplatesSettings): Router
Метод Описание С версии
constructor(data: {}, params: {})
Установит шаблоны ссылок.
setCurrentListView
(entityTypeId: number, view: string): Router
Установит тип представления view списка элементов (список или канбан) для типа сущности entityTypeId.
getCurrentListView(entityTypeId: number): string
Вернет текущий тип представления списка элементов для типа entityTypeId.
static openSlider(url, options): 
Promise
Статический метод, который отроет слайдер по адресу url с параметрами options.
Вернет Promise, который будет разрешен после закрытия этого слайдера. В resolve придет объект BX.SidePanel.Slider слайдера.
Этот метод вызывается внутри других методов этого класса, которые открывают слайдер.
openTypeDetail(typeId: number, options: ?{}): 
?Promise
Откроет слайдер настроек смарт-процесса.
getTemplate(component: string, 
entityTypeId: number = 0): ?string
Вернет шаблон ссылки для компонента component для типа entityTypeId, если такой шаблон есть.
getTypeDetailUrl(entityTypeId: number = 0): ?Uri
Вернет ссылку на страницу настроек смарт-процесса с идентификатором entityTypeId.
getTypeListUrl(): ?Uri
Вернет ссылку на страницу списка смарт-процессов.
getItemListUrlInCurrentView(entityTypeId: 
number, categoryId: ?number = 0): ?Uri
Вернет ссылку на список элементов типа entityTypeId в направлении categoryId в текущем представлении.
getKanbanUrl(entityTypeId: 
number, categoryId: ?number = 0): ?Uri
Вернет ссылку на список элементов типа entityTypeId в направлении categoryId в представлении "канбан".
getItemListUrl(entityTypeId: 
number, categoryId: ?number = 0): ?Uri
Вернет ссылку на список элементов типа entityTypeId в направлении categoryId в представлении "список".


© «Битрикс», 2001-2024, «1С-Битрикс», 2024