Перейти к содержимому
Логотип htmx Логотип htmx htmx по-русски
Поставьте ⭐️ проекту перевода GitHub

Свойство htmx.config()

Свойство, содержащее конфигурацию, которую htmx использует во время выполнения.

Обратите внимание, что использование мета-тега является предпочтительным способом установки этих свойств.

Свойства

Заголовок раздела «Свойства»
  • attributesToSettle: ["class", "style", "width", "height"] — массив строк: атрибуты, которые нужно установить во время фазы установки.
  • refreshOnHistoryMiss: false — булевое значение: если установлено в true, htmx выполнит полное обновление страницы при пропуске истории, а не использует AJAX-запрос.
  • defaultSettleDelay: 20 — целое число: задержка по умолчанию между завершением замены контента и установкой атрибутов.
  • defaultSwapDelay: 0 — целое число: задержка по умолчанию между получением ответа от сервера и выполнением замены.
  • defaultSwapStyle: 'innerHTML' — строка: стиль замены по умолчанию, который будет использоваться, если hx-swap опущен.
  • historyCacheSize: 10 — целое число: количество страниц, которые нужно хранить в localStorage для поддержки истории.
  • historyEnabled: true — булевое значение: использовать ли историю или нет.
  • includeIndicatorStyles: true — булевое значение: если true, htmx добавит небольшое количество CSS на страницу, чтобы сделать индикаторы невидимыми, если класс htmx-indicator отсутствует.
  • indicatorClass: 'htmx-indicator' — строка: класс, который будет присвоен индикаторам, когда запрос выполняется.
  • requestClass: 'htmx-request' — строка: класс, который будет присвоен триггерным элементам, когда запрос выполняется.
  • addedClass: 'htmx-added' — строка: класс, который временно присваивается элементам, добавленным htmx в DOM.
  • settlingClass: 'htmx-settling' — строка: класс, который присваивается целевым элементам, когда htmx находится в фазе установки.
  • swappingClass: 'htmx-swapping' — строка: класс, который присваивается целевым элементам, когда htmx находится в фазе замены.
  • allowEval: true — булевое значение: разрешает использование функциональности, подобной eval, в htmx, чтобы включить hx-vars, триггерные условия и оценку тегов script. Может быть установлено в false для совместимости с CSP.
  • allowScriptTags: true — булевое значение: разрешает оценку тегов script в новом контенте.
  • inlineScriptNonce: '' — строка: nonce, который добавляется к встроенным скриптам.
  • inlineStyleNonce: '' — строка: nonce, который добавляется к встроенным стилям.
  • withCredentials: false — булевое значение: разрешает кросс-доменные запросы Access-Control с использованием учётных данных, таких как cookies, заголовки авторизации или клиентские сертификаты TLS.
  • timeout: 0 — целое число: количество миллисекунд, которое запрос может занимать, прежде чем будет автоматически завершен.
  • wsReconnectDelay: 'full-jitter' — строка/функция: реализация по умолчанию getWebSocketReconnectDelay для повторного подключения после неожиданной потери соединения по коду события Abnormal Closure, Service Restart или Try Again Later.
  • wsBinaryType: 'blob' — строка: тип двоичных данных, получаемых через соединение WebSocket.
  • disableSelector: "[hx-disable], [data-hx-disable]" — массив строк: htmx не будет обрабатывать элементы с этим атрибутом или родителем.
  • disableInheritance: false — булевое значение: если установлено в true, наследование атрибутов полностью отключено, и вы можете явно указать наследование с помощью атрибута hx-inherit.
  • scrollBehavior: 'instant' — строка: поведение прокрутки при использовании модификатора show с hx-swap. Допустимые значения: instant (прокрутка должна происходить мгновенно в одном прыжке), smooth (прокрутка должна анимироваться плавно) и auto (поведение прокрутки определяется вычисленным значением scroll-behavior).
  • defaultFocusScroll: false — булевое значение: должен ли фокусированный элемент прокручиваться в видимую область, может быть переопределено с помощью модификатора замены focus-scroll.
  • getCacheBusterParam: false — булевое значение: если установлено в true, htmx добавит элемент цели к GET-запросу в формате org.htmx.cache-buster=targetElementId.
  • globalViewTransitions: false — булевое значение: если установлено в true, htmx будет использовать View Transitions API при замене нового контента.
  • methodsThatUseUrlParams: ["get", "delete"] — массив строк: htmx будет форматировать запросы с этими методами, кодируя их параметры в URL, а не в теле запроса.
  • selfRequestsOnly: true — булевое значение: разрешать ли только AJAX-запросы к тому же домену, что и текущий документ.
  • ignoreTitle: false — булевое значение: если установлено в true, htmx не будет обновлять заголовок документа, когда в новом контенте найден тег title.
  • scrollIntoViewOnBoost: true — булевое значение: должно ли целевое значение усиленного элемента прокручиваться в область видимости. Если hx-target опущен на усиленном элементе, цель по умолчанию будет body, что приведет к прокрутке страницы вверх.
  • triggerSpecsCache: null — объект: кэш для хранения оцененных спецификаций триггеров, что улучшает производительность парсинга за счет большего использования памяти. Вы можете определить простой объект для использования кэша, который никогда не очищается, или реализовать свою собственную систему с использованием прокси-объекта.
  • htmx.config.responseHandling: [...] — HtmxResponseHandlingConfig[]: поведение обработки ответов по умолчанию для кодов состояния ответа можно настроить здесь, чтобы либо заменить, либо выдать ошибку.
  • htmx.config.allowNestedOobSwaps: true — булевое значение: разрешать ли обработку OOB замен на элементах, которые вложены в основной элемент ответа. См. Вложенные OOB замены.

Пример

Заголовок раздела «Пример»
// обновляем размер кэша истории до 30
htmx.config.historyCacheSize = 30;