Card Refresh 插件

卡刷新插件提供了将 ajax 内容加载到卡中的功能。

使用方法

此插件可以作为 jQuery 插件激活,或使用数据 API 激活。

数据 API

通过在 cards 中添加带有 data-card-widget="card-refresh" 的按钮并提供必需的 data-source="/URL-TO-CONTENT" 选项来激活此插件。这样做,插件会自动向提供的 URL 发起 GET 请求,并将返回的响应渲染到卡片的 .card-body 部分。如果您需要在渲染之前处理返回的响应,则应使用 jQuery API,它提供了处理响应的挂钩。

jQuery

jQuery API 提供更多可自定义选项,允许开发人员在渲染之前预处理请求,并在渲染之后对其进行后处理。

("#my-card").refreshBox(options)
选项
名称 类型 默认值 说明
source 字符串   ’’ 源 URL。
sourceSelector 字符串   ’’ 只获取选择器内容的一个选择器。
params 对象   {} GET 参数(示例:{search_term: 'layout'},渲染为 URL/?search_term=layout)
trigger 字符串   [data-card-widget="card-refresh"] 刷新按钮的 CSS 选择器
content 字符串   .card-body 应在其中渲染内容的目标 CSS 选择器。此选择器应存在于卡中。
loadInContent 布尔值   TRUE 是否自动渲染内容。
loadOnInit 布尔值   TRUE 在页面加载时初始化插件。
responseType 字符串   ’’ 响应类型(例如:“json”或“html”)
overlayTemplate 字符串   TRUE Ajax spinner 的 HTML 模板
onLoadStart 函数   匿名函数 在发出 ajax 请求之前调用
onLoadDone 函数   匿名函数 在发起 ajax 请求后调用。一个 response 参数传递给保存服务器响应的函数。
事件
事件类型  说明
loaded.lte.cardrefresh  在更新卡片后触发。
overlay.added.lte.cardrefresh  向卡片添加 overlay 后触发。
overlay.removed.lte.cardrefresh  从卡片中移除 overlay 后触发。

示例:$('#my-card [data-card-widget="card-refresh"]').on('loaded.lte.cardrefresh', handleLoadedEvent)

方法
方法 说明
load 重新加载内容并运行 onLoadStartonLoadDone 挂钩

示例:$('#my-card-widget').Widget('toggle')