卡片刷新插件提供将ajax内容加载到卡片中的功能。
此插件可以作为 jQuery 插件或使用数据 API 激活。
通过向卡片中添加一个带有data-card-widget="card-refresh"
的按钮并提供所需的data-source="/URL-TO-CONTENT"
选项来激活插件。这样做后,插件将自动向提供的URL创建一个GET请求,并将返回的响应渲染到.card-body
卡片的区域。如果您需要在渲染之前处理返回的响应,您应该使用jQuery API,它提供了处理响应的钩子。
jQuery API 提供了更多可定制的选项,允许开发者在渲染前预处理请求,并在渲染后进行后处理。
$('#my-card [data-card-widget="card-refresh"]').CardRefresh(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 | 在页面加载时初始化插件。 |
loadErrorTemplate | 布尔值 | TRUE | 当发生ajax错误时,是否将errorTemplate 添加到卡片中。 |
responseType | 字符串 | ’’ | 响应类型(例如:‘json’或‘html’) |
overlayTemplate | 字符串 | TRUE | 用于ajax旋转器的HTML模板 |
errorTemplate | 字符串 | '<span class="text-danger"></span>' |
用于ajax错误消息的HTML模板 |
onLoadStart | 函数 | 匿名函数 | 在发起ajax请求之前被调用 |
onLoadDone | 函数 | 匿名函数 | 在发起ajax请求后被调用。一个response 参数被传递给该函数,该参数包含服务器响应。 |
onLoadFail | 函数 | 匿名函数 | 如果ajax请求失败,则被调用。jqXHR , textStatus 和errorThrown 参数被传递给该函数。 |
事件类型 | 描述 |
---|---|
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 | 重新加载内容并运行onLoadStart 和onLoadDone 钩子 |
示例:$('#my-card [data-card-widget="card-refresh"]').CardRefresh('load')