属性 - htmx.config

保存 htmx 在运行时使用的配置的属性。

请注意，使用元标记是设置这些属性的首选机制。

特性

  • attributesToSettle:["class", "style", "width", "height"] - 字符串数组：在结算阶段要结算的属性
  • refreshOnHistoryMiss:false - 布尔值：如果设置为 true ，htmx 将在历史记录未命中时发出整页刷新，而不是使用 AJAX 请求
  • defaultSettleDelay:20 - int：完成内容交换和确定属性之间的默认延迟
  • defaultSwapDelay:0 - int：从服务器接收响应和进行交换之间的默认延迟
  • defaultSwapStyle:'innerHTML' hx-swap - 字符串：如果省略则使用的默认交换样式
  • historyCacheSize:10localStorage - int：为支持历史记录而保留的页数
  • historyEnabled:true - 布尔值：是否使用历史记录
  • includeIndicatorStyles:true - 布尔值：如果为真，则 htmx 将向页面注入少量 CSS，以使指示器不可见，除非 htmx-indicator 存在该类
  • indicatorClass:'htmx-indicator' - 字符串：请求正在进行时放置在指示器上的类
  • requestClass:'htmx-request' - 字符串：请求进行时放置在触发元素上的类
  • addedClass:'htmx-added' - 字符串：临时放置在已添加 htmx 到 DOM 的元素上的类
  • settlingClass:'htmx-settling' - string：当 htmx 处于稳定阶段时放置在目标元素上的类
  • swappingClass:'htmx-swapping' - string：当 htmx 处于交换阶段时放置在目标元素上的类
  • allowEval:true- boolean：允许在 htmx 中使用类似 eval 的功能，以启用hx-vars、触发条件和脚本标签评估。可以设置为 false 以实现 CSP 兼容性。
  • allowScriptTags:true - 布尔值：允许在新内容中评估脚本标签
  • inlineScriptNonce:'' - 字符串：添加到内联脚本的随机数
  • inlineStyleNonce:'' - 字符串：添加到内联样式的随机数
  • withCredentials:false - 布尔值：允许使用诸如 cookies、授权头或 TLS 客户端证书之类的凭证进行跨站点访问控制请求
  • timeout:0 - int：请求超时的毫秒数
  • wsReconnectDelay: 'full-jitter' getWebSocketReconnectDelay - 字符串/函数：事件代码意外丢失连接后重新连接的默认实现 Abnormal Closure，Service Restart 或 Try Again Later
  • wsBinaryType:'blob' - string：通过 WebSocket 连接接收的二进制数据类型
  • disableSelector:" [hx-disable], [data-hx-disable]" - 字符串数组：htmx 将不会处理具有此属性的元素或其父元素
  • disableInheritance:false - boolean：如果设置为true，则完全禁用属性的继承，并且您可以使用 hx-inherittrue 属性明确指定继承。
  • scrollBehavior:'instant' - 字符串：使用 hx-swap show 修饰符时的滚动行为。允许的值为instant（滚动应在一次跳转中立即发生）、smooth（滚动应流畅地进行动画处理）和（滚动行为由scroll-behaviorauto的计算值决定）。
  • defaultFocusScroll:false - 布尔值：如果焦点元素应该滚动到视图中，则可以使用焦点滚动交换修饰符进行覆盖
  • getCacheBusterParam:false - boolean: 如果设置为 true，则 htmx 将以以下格式将目标元素附加到 GET 请求中如下格式： org.htmx.cache-buster=targetElementId
  • globalViewTransitions:false - 布尔值：如果设置为 true，htmx 将在交换新内容时使用 View Transition API。
  • methodsThatUseUrlParams:["get", "delete"] - 字符串数组：htmx 将通过在 URL 中编码其参数来格式化使用这些方法的请求，而不是请求正文
  • selfRequestsOnly:true - boolean: 是否仅允许对与当前文档相同的域进行 AJAX 请求
  • ignoreTitle:false - 布尔值：如果设置为true，htmx 则在新内容中发现标签时不会更新文档的标题
  • scrollIntoViewOnBoost:true - 布尔值：增强元素的目标是否滚动到视口中。如果 hx-target 在增强元素上省略，则目标默认为body，从而使页面滚动到顶部。
  • triggerSpecsCache:null - 对象：用于存储评估的触发器规范的缓存，以更多的内存使用为代价来提高解析性能。你可以定义一个简单的对象来使用永不清除的缓存，或者使用代理对象实现您自己的系统
  • htmx.config.responseHandling:[...] - HtmxResponseHandlingConfig[]:可以在此处配置响应状态代码的默认响应处理行为，以决定交换或处理错误
  • htmx.config.allowNestedOobSwaps:true - 布尔值：是否处理嵌套在主响应元素中的元素的 OOB 交换。请参阅嵌套 OOB 交换。

例子

  // update the history cache size to 30
  htmx.config.historyCacheSize = 30;