- Домашняя страница
- JavaScript
- Компоненты
- Сворачиваемый контент
Сворачиваемый контент
Компонент для переключения видимости контента
Превью
Подключение
В случае если компонент поддерживает несколько способов подключения, используйте только тот, который больше подходит для проекта
Внимание!
Перед подключением компонента убедитесь, что все необходимые для требуемого компонента зависимости установлены и подключены!
Используя Bitrix
Для подключения компонента используется стандартный метод для работы с расширениями CJSCore::Init
php
CJSCore::Init(['welpodron.core.collapse']);
Прямое подключение
Для подключения компонента используется комбинация тегов script
и link
html
...
Здесь находятся подключение всех стилей, от которого зависит текущий подключаемый скрипт
...
<link rel="stylesheet" href="Путь к локально размещенному файлу стилей компонента">
...
Здесь находятся подключение всех зависимых от данного скрипта стилей
...
</head>
Использование
Компонент работает с помощью специальных HTML атрибутов, не забывайте указывать их в соответствии с документацией перед инициализацией компонента в JavaScript
HTML
Базовый HTML управляемого элемента
html
<div
data-w-collapse
[data-w-collapse-active]
data-w-collapse-id="COMPONENT_ID"
>
Содержимое управляемого элемента
</div>
Атрибут | Значения | Описание |
---|---|---|
data-w-collapse * | - | Указатель компонента |
data-w-collapse-active | - | Указатель активности компонента |
data-w-collapse-id * | - | Идентификатор компонента |
Базовый HTML управляющего элемента
html
<button
data-w-collapse-control
[data-w-collapse-control-active]
data-w-collapse-id="COMPONENT_ID"
data-w-collapse-action="ONE_OF_SUPPORTED_ACTIONS"
[data-w-collapse-action-args="ARGS_TO_PASS_TO_ACTION"]
[data-w-collapse-action-flush]
>
Содержимое управляющего элемента
</button>
Атрибут | Значения | Описание |
---|---|---|
data-w-collapse-control * | - | Указатель контрола |
data-w-collapse-control-active | - | Указатель активности контрола |
data-w-collapse-id * | - | Идентификатор компонента |
data-w-collapse-action * | toggle , show , hide | Экшен компонента |
data-w-collapse-action-args | - | Аргументы передаваемые в экшен |
data-w-collapse-action-flush | - | Не использовать event.preventDefault() |
JavaScript
Базовая инициализация экземпляра компонента
js
if (window.welpodron && window.welpodron.collapse) {
const instance = new window.welpodron.collapse({
element: document.querySelector('[data-w-collapse][data-w-collapse-id="COMPONENT_ID"]');
})
}
Доступные методы экземпляра компонента welpodron.collapse
show(options)
Переключение компонента в видимое состояние
Аргумент | Тип | Описание |
---|---|---|
options * | { args?: unknown; event?: Event } | Объект с опциями вызова метода |
hide(options)
Переключение компонента в скрытое состояние
Аргумент | Тип | Описание |
---|---|---|
options * | { args?: unknown; event?: Event } | Объект с опциями вызова метода |
toggle(options)
Переключение компонента в скрытое состояние из видимого и из видимого в скрытое
Аргумент | Тип | Описание |
---|---|---|
options * | { args?: unknown; event?: Event } | Объект с опциями вызова метода |