Add auto refresh extension

src/extensions/auto-refresh/README.md

@@ -0,0 +1,47 @@
+# Table Auto Refresh
+
+Use Plugin: [bootstrap-table-auto-refresh](https://github.com/wenzhixin/bootstrap-table/tree/master/src/extensions/auto-refresh)
+
+## Usage
+
+```html
+<link rel="stylesheet" href="extensions/auto-refresh/bootstrap-table-auto-refresh.css">
+<script src="extensions/auto-refresh/bootstrap-table-auto-refresh.js"></script>
+```
+
+## Options
+
+### autoRefresh
+
+* type: Boolean
+* description: 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.
+* default: `false`
+
+## autoRefreshStatus
+
+* type: Boolean
+* description: Set true to enable auto refresh. This is the state auto refresh will be in when the table loads. Clicking the button toggles this property. This is simply the default state of auto refresh as the user can always change it by clicking the button.
+* default: `true`
+
+## autoRefreshInterval
+
+* type: Integer
+* description: Time in seconds for auto refresh to occur every.
+* default: `60`
+
+## autoRefreshSilent
+
+* type: Boolean
+* description: Set true to auto refresh silently.
+* default: `true`
+
+## Column options
+
+None
+
+### Icons
+* autoRefresh: 'glyphicon-time icon-time'
+
+## Events
+
+None

src/extensions/auto-refresh/bootstrap-table-auto-refresh.css

@@ -0,0 +1,3 @@
+.btn.enabled {
+  background-color: #5bc0de;
+}

src/extensions/auto-refresh/bootstrap-table-auto-refresh.js

@@ -0,0 +1,84 @@
+/**
+ * @author: Alec Fenichel
+ * @webSite: https://fenichelar.com
+ * @version: v1.0.0
+ */
+
+(function ($) {
+
+  'use strict';
+
+  $.extend($.fn.bootstrapTable.defaults, {
+    autoRefresh: false,
+    autoRefreshInterval: 60,
+    autoRefreshSilent: true,
+    autoRefreshStatus: true,
+    autoRefreshFunction: null
+  });
+
+  $.extend($.fn.bootstrapTable.defaults.icons, {
+    autoRefresh: 'glyphicon-time icon-time'
+  });
+
+  $.extend($.fn.bootstrapTable.locales, {
+    formatAutoRefresh: function() {
+      return 'Auto Refresh';
+    }
+  });
+
+  $.extend($.fn.bootstrapTable.defaults, $.fn.bootstrapTable.locales);
+
+  var BootstrapTable = $.fn.bootstrapTable.Constructor;
+  var _init = BootstrapTable.prototype.init;
+  var _initToolbar = BootstrapTable.prototype.initToolbar;
+  var sprintf = $.fn.bootstrapTable.utils.sprintf;
+
+  BootstrapTable.prototype.init = function () {
+    _init.apply(this, Array.prototype.slice.apply(arguments));
+
+    if (this.options.autoRefresh && this.options.autoRefreshStatus) {
+      var that = this;
+      this.options.autoRefreshFunction = setInterval(function () {
+        that.refresh({silent: that.options.autoRefreshSilent});
+      }, this.options.autoRefreshInterval*1000);
+    }
+  };
+
+  BootstrapTable.prototype.initToolbar = function() {
+    _initToolbar.apply(this, Array.prototype.slice.apply(arguments));
+
+    if (this.options.autoRefresh) {
+      var $btnGroup = this.$toolbar.find('>.btn-group');
+      var $btnAutoRefresh = $btnGroup.find('.auto-refresh');
+
+      if (!$btnAutoRefresh.length) {
+        $btnAutoRefresh = $([
+          sprintf('<button class="btn btn-default auto-refresh %s" ', this.options.autoRefreshStatus ? 'enabled' : ''),
+          'type="button" ',
+          sprintf('title="%s">', this.options.formatAutoRefresh()),
+          sprintf('<i class="%s %s"></i>', this.options.iconsPrefix, this.options.icons.autoRefresh),
+          '</button>'
+        ].join('')).appendTo($btnGroup);
+
+        $btnAutoRefresh.on('click', $.proxy(this.toggleAutoRefresh, this));
+      }
+    }
+  };
+
+  BootstrapTable.prototype.toggleAutoRefresh = function() {
+    if (this.options.autoRefresh) {
+      if (this.options.autoRefreshStatus) {
+        clearInterval(this.options.autoRefreshFunction);
+        this.$toolbar.find('>.btn-group').find('.auto-refresh').removeClass('enabled');
+      } else {
+        var that = this;
+        this.options.autoRefreshFunction = setInterval(function () {
+          that.refresh({silent: that.options.autoRefreshSilent});
+        }, this.options.autoRefreshInterval*1000);
+        this.$toolbar.find('>.btn-group').find('.auto-refresh').addClass('enabled');
+      }
+      this.options.autoRefreshStatus = !this.options.autoRefreshStatus;
+    }
+  };
+
+})(jQuery);

src/extensions/auto-refresh/extension.json

@@ -0,0 +1,17 @@
+{
+  "name": "Auto Refresh",
+  "version": "1.0.0",
+  "description": "Plugin to automatically refresh the table on an interval.",
+  "url": "https://github.com/wenzhixin/bootstrap-table/tree/master/src/extensions/auto-refresh",
+  "example": "#",
+
+  "plugins": [{
+    "name": "bootstrap-table-auto-refresh",
+    "url": "https://github.com/wenzhixin/bootstrap-table/tree/master/src/extensions/auto-refresh"
+  }],
+
+  "author": {
+    "name": "fenichaler",
+    "image": "https://avatars.githubusercontent.com/u/3437075"
+  }
+}