浏览代码

Imprvoded the documentation for the auto refresh extension

Dustin Utecht 4 年之前
父节点
当前提交
4ea1e73dc7
共有 2 个文件被更改,包括 14 次插入1 次删除
  1. 13 1
      site/docs/extensions/auto-refresh.md
  2. 1 0
      src/extensions/auto-refresh/bootstrap-table-auto-refresh.js

+ 13 - 1
site/docs/extensions/auto-refresh.md

@@ -26,7 +26,7 @@ toc: true
 
 - **Detail:**
 
-   Set `true` to enable auto refresh plugin. **This does not mean enable auto refresh.** This allows the user to enable/disable auto refresh by clicking the button.
+   Set `true` to enable auto refresh plugin.
 
 - **Default:** `false`
 
@@ -66,6 +66,18 @@ toc: true
 
 - **Default:** `true`
 
+### showAutoRefresh
+
+- **Attribute:** `data-show-auto-refresh`
+
+- **type:** `Boolean`
+
+- **Detail:**
+
+  Set `false` to hide the auto refresh button, as example if you want to disallow deactivating the auto fresh by the user.
+
+- **Default:** `true`
+
 ### Icons
 
 - autoRefresh: 'fa-clock'

+ 1 - 0
src/extensions/auto-refresh/bootstrap-table-auto-refresh.js

@@ -8,6 +8,7 @@ const Utils = $.fn.bootstrapTable.utils
 
 $.extend($.fn.bootstrapTable.defaults, {
   autoRefresh: false,
+  showAutoRefresh: true,
   autoRefreshInterval: 60,
   autoRefreshSilent: true,
   autoRefreshStatus: true,