bootstrap-table-cookie.js 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512
  1. (function (global, factory) {
  2. if (typeof define === "function" && define.amd) {
  3. define([], factory);
  4. } else if (typeof exports !== "undefined") {
  5. factory();
  6. } else {
  7. var mod = {
  8. exports: {}
  9. };
  10. factory();
  11. global.bootstrapTableCookie = mod.exports;
  12. }
  13. })(this, function () {
  14. 'use strict';
  15. function _classCallCheck(instance, Constructor) {
  16. if (!(instance instanceof Constructor)) {
  17. throw new TypeError("Cannot call a class as a function");
  18. }
  19. }
  20. var _createClass = function () {
  21. function defineProperties(target, props) {
  22. for (var i = 0; i < props.length; i++) {
  23. var descriptor = props[i];
  24. descriptor.enumerable = descriptor.enumerable || false;
  25. descriptor.configurable = true;
  26. if ("value" in descriptor) descriptor.writable = true;
  27. Object.defineProperty(target, descriptor.key, descriptor);
  28. }
  29. }
  30. return function (Constructor, protoProps, staticProps) {
  31. if (protoProps) defineProperties(Constructor.prototype, protoProps);
  32. if (staticProps) defineProperties(Constructor, staticProps);
  33. return Constructor;
  34. };
  35. }();
  36. function _possibleConstructorReturn(self, call) {
  37. if (!self) {
  38. throw new ReferenceError("this hasn't been initialised - super() hasn't been called");
  39. }
  40. return call && (typeof call === "object" || typeof call === "function") ? call : self;
  41. }
  42. var _get = function get(object, property, receiver) {
  43. if (object === null) object = Function.prototype;
  44. var desc = Object.getOwnPropertyDescriptor(object, property);
  45. if (desc === undefined) {
  46. var parent = Object.getPrototypeOf(object);
  47. if (parent === null) {
  48. return undefined;
  49. } else {
  50. return get(parent, property, receiver);
  51. }
  52. } else if ("value" in desc) {
  53. return desc.value;
  54. } else {
  55. var getter = desc.get;
  56. if (getter === undefined) {
  57. return undefined;
  58. }
  59. return getter.call(receiver);
  60. }
  61. };
  62. function _inherits(subClass, superClass) {
  63. if (typeof superClass !== "function" && superClass !== null) {
  64. throw new TypeError("Super expression must either be null or a function, not " + typeof superClass);
  65. }
  66. subClass.prototype = Object.create(superClass && superClass.prototype, {
  67. constructor: {
  68. value: subClass,
  69. enumerable: false,
  70. writable: true,
  71. configurable: true
  72. }
  73. });
  74. if (superClass) Object.setPrototypeOf ? Object.setPrototypeOf(subClass, superClass) : subClass.__proto__ = superClass;
  75. }
  76. /**
  77. * @author: Dennis Hernández
  78. * @webSite: http://djhvscf.github.io/Blog
  79. * @version: v1.2.4
  80. *
  81. * @update zhixin wen <wenzhixin2010@gmail.com>
  82. */
  83. (function ($) {
  84. var UtilsCookie = {
  85. cookieIds: {
  86. sortOrder: 'bs.table.sortOrder',
  87. sortName: 'bs.table.sortName',
  88. pageNumber: 'bs.table.pageNumber',
  89. pageList: 'bs.table.pageList',
  90. columns: 'bs.table.columns',
  91. searchText: 'bs.table.searchText',
  92. filterControl: 'bs.table.filterControl',
  93. filterBy: 'bs.table.filterBy'
  94. },
  95. getCurrentHeader: function getCurrentHeader(that) {
  96. var header = that.$header;
  97. if (that.options.height) {
  98. header = that.$tableHeader;
  99. }
  100. return header;
  101. },
  102. getCurrentSearchControls: function getCurrentSearchControls(that) {
  103. var searchControls = 'select, input';
  104. if (that.options.height) {
  105. searchControls = 'table select, table input';
  106. }
  107. return searchControls;
  108. },
  109. cookieEnabled: function cookieEnabled() {
  110. return !!navigator.cookieEnabled;
  111. },
  112. inArrayCookiesEnabled: function inArrayCookiesEnabled(cookieName, cookiesEnabled) {
  113. var index = -1;
  114. for (var i = 0; i < cookiesEnabled.length; i++) {
  115. if (cookieName.toLowerCase() === cookiesEnabled[i].toLowerCase()) {
  116. index = i;
  117. break;
  118. }
  119. }
  120. return index;
  121. },
  122. setCookie: function setCookie(that, cookieName, cookieValue) {
  123. if (!that.options.cookie || !UtilsCookie.cookieEnabled() || that.options.cookieIdTable === '') {
  124. return;
  125. }
  126. if (UtilsCookie.inArrayCookiesEnabled(cookieName, that.options.cookiesEnabled) === -1) {
  127. return;
  128. }
  129. cookieName = that.options.cookieIdTable + '.' + cookieName;
  130. switch (that.options.cookieStorage) {
  131. case 'cookieStorage':
  132. document.cookie = [cookieName, '=', cookieValue, '; expires=' + UtilsCookie.calculateExpiration(that.options.cookieExpire), that.options.cookiePath ? '; path=' + that.options.cookiePath : '', that.options.cookieDomain ? '; domain=' + that.options.cookieDomain : '', that.options.cookieSecure ? '; secure' : ''].join('');
  133. break;
  134. case 'localStorage':
  135. localStorage.setItem(cookieName, cookieValue);
  136. break;
  137. case 'sessionStorage':
  138. sessionStorage.setItem(cookieName, cookieValue);
  139. break;
  140. default:
  141. return false;
  142. }
  143. return true;
  144. },
  145. getCookie: function getCookie(that, tableName, cookieName) {
  146. if (!cookieName) {
  147. return null;
  148. }
  149. if (UtilsCookie.inArrayCookiesEnabled(cookieName, that.options.cookiesEnabled) === -1) {
  150. return null;
  151. }
  152. cookieName = tableName + '.' + cookieName;
  153. switch (that.options.cookieStorage) {
  154. case 'cookieStorage':
  155. var value = '; ' + document.cookie;
  156. var parts = value.split('; ' + cookieName + '=');
  157. return parts.length === 2 ? parts.pop().split(';').shift() : null;
  158. case 'localStorage':
  159. return localStorage.getItem(cookieName);
  160. case 'sessionStorage':
  161. return sessionStorage.getItem(cookieName);
  162. default:
  163. return null;
  164. }
  165. },
  166. deleteCookie: function deleteCookie(that, tableName, cookieName) {
  167. cookieName = tableName + '.' + cookieName;
  168. switch (that.options.cookieStorage) {
  169. case 'cookieStorage':
  170. document.cookie = [encodeURIComponent(cookieName), '=', '; expires=Thu, 01 Jan 1970 00:00:00 GMT', that.options.cookiePath ? '; path=' + that.options.cookiePath : '', that.options.cookieDomain ? '; domain=' + that.options.cookieDomain : ''].join('');
  171. break;
  172. case 'localStorage':
  173. localStorage.removeItem(cookieName);
  174. break;
  175. case 'sessionStorage':
  176. sessionStorage.removeItem(cookieName);
  177. break;
  178. default:
  179. return false;
  180. }
  181. return true;
  182. },
  183. calculateExpiration: function calculateExpiration(cookieExpire) {
  184. var time = cookieExpire.replace(/[0-9]*/, ''); // s,mi,h,d,m,y
  185. cookieExpire = cookieExpire.replace(/[A-Za-z]{1,2}/, ''); // number
  186. switch (time.toLowerCase()) {
  187. case 's':
  188. cookieExpire = +cookieExpire;
  189. break;
  190. case 'mi':
  191. cookieExpire *= 60;
  192. break;
  193. case 'h':
  194. cookieExpire = cookieExpire * 60 * 60;
  195. break;
  196. case 'd':
  197. cookieExpire = cookieExpire * 24 * 60 * 60;
  198. break;
  199. case 'm':
  200. cookieExpire = cookieExpire * 30 * 24 * 60 * 60;
  201. break;
  202. case 'y':
  203. cookieExpire = cookieExpire * 365 * 24 * 60 * 60;
  204. break;
  205. default:
  206. cookieExpire = undefined;
  207. break;
  208. }
  209. if (!cookieExpire) {
  210. return '';
  211. }
  212. var d = new Date();
  213. d.setTime(d.getTime() + cookieExpire * 1000);
  214. return d.toGMTString();
  215. },
  216. initCookieFilters: function initCookieFilters(bootstrapTable) {
  217. setTimeout(function () {
  218. var parsedCookieFilters = JSON.parse(UtilsCookie.getCookie(bootstrapTable, bootstrapTable.options.cookieIdTable, UtilsCookie.cookieIds.filterControl));
  219. if (!bootstrapTable.options.filterControlValuesLoaded && parsedCookieFilters) {
  220. var cachedFilters = {};
  221. var header = UtilsCookie.getCurrentHeader(bootstrapTable);
  222. var searchControls = UtilsCookie.getCurrentSearchControls(bootstrapTable);
  223. var applyCookieFilters = function applyCookieFilters(element, filteredCookies) {
  224. $(filteredCookies).each(function (i, cookie) {
  225. if (cookie.text !== '') {
  226. $(element).val(cookie.text);
  227. cachedFilters[cookie.field] = cookie.text;
  228. }
  229. });
  230. };
  231. header.find(searchControls).each(function () {
  232. var field = $(this).closest('[data-field]').data('field');
  233. var filteredCookies = parsedCookieFilters.filter(function (cookie) {
  234. return cookie.field === field;
  235. });
  236. applyCookieFilters(this, filteredCookies);
  237. });
  238. bootstrapTable.initColumnSearch(cachedFilters);
  239. bootstrapTable.options.filterControlValuesLoaded = true;
  240. bootstrapTable.initServer();
  241. }
  242. }, 250);
  243. }
  244. };
  245. $.extend($.fn.bootstrapTable.defaults, {
  246. cookie: false,
  247. cookieExpire: '2h',
  248. cookiePath: null,
  249. cookieDomain: null,
  250. cookieSecure: null,
  251. cookieIdTable: '',
  252. cookiesEnabled: ['bs.table.sortOrder', 'bs.table.sortName', 'bs.table.pageNumber', 'bs.table.pageList', 'bs.table.columns', 'bs.table.searchText', 'bs.table.filterControl', 'bs.table.filterBy'],
  253. cookieStorage: 'cookieStorage', // localStorage, sessionStorage
  254. // internal variable
  255. filterControls: [],
  256. filterControlValuesLoaded: false
  257. });
  258. $.fn.bootstrapTable.methods.push('getCookies');
  259. $.fn.bootstrapTable.methods.push('deleteCookie');
  260. $.extend($.fn.bootstrapTable.utils, {
  261. setCookie: UtilsCookie.setCookie,
  262. getCookie: UtilsCookie.getCookie
  263. });
  264. $.BootstrapTable = function (_$$BootstrapTable) {
  265. _inherits(_class, _$$BootstrapTable);
  266. function _class() {
  267. _classCallCheck(this, _class);
  268. return _possibleConstructorReturn(this, (_class.__proto__ || Object.getPrototypeOf(_class)).apply(this, arguments));
  269. }
  270. _createClass(_class, [{
  271. key: 'init',
  272. value: function init() {
  273. // FilterBy logic
  274. var filterByCookie = JSON.parse(UtilsCookie.getCookie(this, this.options.cookieIdTable, UtilsCookie.cookieIds.filterBy));
  275. this.filterColumns = filterByCookie ? filterByCookie : {};
  276. // FilterControl logic
  277. this.options.filterControls = [];
  278. this.options.filterControlValuesLoaded = false;
  279. this.options.cookiesEnabled = typeof this.options.cookiesEnabled === 'string' ? this.options.cookiesEnabled.replace('[', '').replace(']', '').replace(/ /g, '').toLowerCase().split(',') : this.options.cookiesEnabled;
  280. if (this.options.filterControl) {
  281. var that = this;
  282. this.$el.on('column-search.bs.table', function (e, field, text) {
  283. var isNewField = true;
  284. for (var i = 0; i < that.options.filterControls.length; i++) {
  285. if (that.options.filterControls[i].field === field) {
  286. that.options.filterControls[i].text = text;
  287. isNewField = false;
  288. break;
  289. }
  290. }
  291. if (isNewField) {
  292. that.options.filterControls.push({
  293. field: field,
  294. text: text
  295. });
  296. }
  297. UtilsCookie.setCookie(that, UtilsCookie.cookieIds.filterControl, JSON.stringify(that.options.filterControls));
  298. }).on('created-controls.bs.table', UtilsCookie.initCookieFilters(that));
  299. }
  300. _get(_class.prototype.__proto__ || Object.getPrototypeOf(_class.prototype), 'init', this).call(this);
  301. }
  302. }, {
  303. key: 'initServer',
  304. value: function initServer() {
  305. var bootstrapTable = this;
  306. if (bootstrapTable.options.cookie && bootstrapTable.options.filterControl && !bootstrapTable.options.filterControlValuesLoaded) {
  307. var cookie = JSON.parse(UtilsCookie.getCookie(bootstrapTable, bootstrapTable.options.cookieIdTable, UtilsCookie.cookieIds.filterControl));
  308. if (cookie) {
  309. return;
  310. }
  311. }
  312. _get(_class.prototype.__proto__ || Object.getPrototypeOf(_class.prototype), 'initServer', this).call(this);
  313. }
  314. }, {
  315. key: 'initTable',
  316. value: function initTable() {
  317. _get(_class.prototype.__proto__ || Object.getPrototypeOf(_class.prototype), 'initTable', this).call(this);
  318. this.initCookie();
  319. }
  320. }, {
  321. key: 'onSort',
  322. value: function onSort() {
  323. var event = arguments.length <= 0 ? undefined : arguments[0];
  324. _get(_class.prototype.__proto__ || Object.getPrototypeOf(_class.prototype), 'onSort', this).call(this, event);
  325. UtilsCookie.setCookie(this, UtilsCookie.cookieIds.sortOrder, this.options.sortOrder);
  326. UtilsCookie.setCookie(this, UtilsCookie.cookieIds.sortName, this.options.sortName);
  327. }
  328. }, {
  329. key: 'onPageNumber',
  330. value: function onPageNumber() {
  331. var event = arguments.length <= 0 ? undefined : arguments[0];
  332. _get(_class.prototype.__proto__ || Object.getPrototypeOf(_class.prototype), 'onPageNumber', this).call(this, event);
  333. UtilsCookie.setCookie(this, UtilsCookie.cookieIds.pageNumber, this.options.pageNumber);
  334. return false;
  335. }
  336. }, {
  337. key: 'onPageListChange',
  338. value: function onPageListChange() {
  339. var event = arguments.length <= 0 ? undefined : arguments[0];
  340. _get(_class.prototype.__proto__ || Object.getPrototypeOf(_class.prototype), 'onPageListChange', this).call(this, event);
  341. UtilsCookie.setCookie(this, UtilsCookie.cookieIds.pageList, this.options.pageSize);
  342. UtilsCookie.setCookie(this, UtilsCookie.cookieIds.pageNumber, this.options.pageNumber);
  343. return false;
  344. }
  345. }, {
  346. key: 'onPagePre',
  347. value: function onPagePre() {
  348. var event = arguments.length <= 0 ? undefined : arguments[0];
  349. _get(_class.prototype.__proto__ || Object.getPrototypeOf(_class.prototype), 'onPagePre', this).call(this, event);
  350. UtilsCookie.setCookie(this, UtilsCookie.cookieIds.pageNumber, this.options.pageNumber);
  351. return false;
  352. }
  353. }, {
  354. key: 'onPageNext',
  355. value: function onPageNext() {
  356. var event = arguments.length <= 0 ? undefined : arguments[0];
  357. _get(_class.prototype.__proto__ || Object.getPrototypeOf(_class.prototype), 'onPageNext', this).call(this, event);
  358. UtilsCookie.setCookie(this, UtilsCookie.cookieIds.pageNumber, this.options.pageNumber);
  359. return false;
  360. }
  361. }, {
  362. key: 'toggleColumn',
  363. value: function toggleColumn() {
  364. _get(_class.prototype.__proto__ || Object.getPrototypeOf(_class.prototype), 'toggleColumn', this).call(this);
  365. var visibleColumns = [];
  366. $.each(this.columns, function (i, column) {
  367. if (column.visible) {
  368. visibleColumns.push(column.field);
  369. }
  370. });
  371. UtilsCookie.setCookie(this, UtilsCookie.cookieIds.columns, JSON.stringify(visibleColumns));
  372. }
  373. }, {
  374. key: 'selectPage',
  375. value: function selectPage(page) {
  376. _get(_class.prototype.__proto__ || Object.getPrototypeOf(_class.prototype), 'selectPage', this).call(this);
  377. UtilsCookie.setCookie(this, UtilsCookie.cookieIds.pageNumber, page);
  378. }
  379. }, {
  380. key: 'onSearch',
  381. value: function onSearch() {
  382. for (var _len = arguments.length, args = Array(_len), _key = 0; _key < _len; _key++) {
  383. args[_key] = arguments[_key];
  384. }
  385. var target = Array.prototype.slice.apply(args);
  386. _get(_class.prototype.__proto__ || Object.getPrototypeOf(_class.prototype), 'onSearch', this).call(this, this, target);
  387. if ($(target[0].currentTarget).parent().hasClass('search')) {
  388. UtilsCookie.setCookie(this, UtilsCookie.cookieIds.searchText, this.searchText);
  389. }
  390. UtilsCookie.setCookie(this, UtilsCookie.cookieIds.pageNumber, this.options.pageNumber);
  391. }
  392. }, {
  393. key: 'filterBy',
  394. value: function filterBy() {
  395. _get(_class.prototype.__proto__ || Object.getPrototypeOf(_class.prototype), 'filterBy', this).call(this);
  396. UtilsCookie.setCookie(this, UtilsCookie.cookieIds.filterBy, JSON.stringify(this.filterColumns));
  397. }
  398. }, {
  399. key: 'initCookie',
  400. value: function initCookie() {
  401. if (!this.options.cookie) {
  402. return;
  403. }
  404. if (this.options.cookieIdTable === '' || this.options.cookieExpire === '' || !UtilsCookie.cookieEnabled()) {
  405. console.error('Configuration error. Please review the cookieIdTable and the cookieExpire property. If the properties are correct, then this browser does not support cookies.');
  406. this.options.cookie = false; // Make sure that the cookie extension is disabled
  407. return;
  408. }
  409. var sortOrderCookie = UtilsCookie.getCookie(this, this.options.cookieIdTable, UtilsCookie.cookieIds.sortOrder);
  410. var sortOrderNameCookie = UtilsCookie.getCookie(this, this.options.cookieIdTable, UtilsCookie.cookieIds.sortName);
  411. var pageNumberCookie = UtilsCookie.getCookie(this, this.options.cookieIdTable, UtilsCookie.cookieIds.pageNumber);
  412. var pageListCookie = UtilsCookie.getCookie(this, this.options.cookieIdTable, UtilsCookie.cookieIds.pageList);
  413. var columnsCookie = JSON.parse(UtilsCookie.getCookie(this, this.options.cookieIdTable, UtilsCookie.cookieIds.columns));
  414. var searchTextCookie = UtilsCookie.getCookie(this, this.options.cookieIdTable, UtilsCookie.cookieIds.searchText);
  415. // sortOrder
  416. this.options.sortOrder = sortOrderCookie ? sortOrderCookie : this.options.sortOrder;
  417. // sortName
  418. this.options.sortName = sortOrderNameCookie ? sortOrderNameCookie : this.options.sortName;
  419. // pageNumber
  420. this.options.pageNumber = pageNumberCookie ? +pageNumberCookie : this.options.pageNumber;
  421. // pageSize
  422. this.options.pageSize = pageListCookie ? pageListCookie === this.options.formatAllRows() ? pageListCookie : +pageListCookie : this.options.pageSize;
  423. // searchText
  424. this.options.searchText = searchTextCookie ? searchTextCookie : '';
  425. if (columnsCookie) {
  426. $.each(this.columns, function (i, column) {
  427. column.visible = $.inArray(column.field, columnsCookie) !== -1;
  428. });
  429. }
  430. }
  431. }, {
  432. key: 'getCookies',
  433. value: function getCookies() {
  434. var bootstrapTable = this;
  435. var cookies = {};
  436. $.each(UtilsCookie.cookieIds, function (key, value) {
  437. cookies[key] = UtilsCookie.getCookie(bootstrapTable, bootstrapTable.options.cookieIdTable, value);
  438. if (key === 'columns') {
  439. cookies[key] = JSON.parse(cookies[key]);
  440. }
  441. });
  442. return cookies;
  443. }
  444. }, {
  445. key: 'deleteCookie',
  446. value: function deleteCookie(cookieName) {
  447. if (cookieName === '' || !UtilsCookie.cookieEnabled()) {
  448. return;
  449. }
  450. UtilsCookie.deleteCookie(this, this.options.cookieIdTable, UtilsCookie.cookieIds[cookieName]);
  451. }
  452. }]);
  453. return _class;
  454. }($.BootstrapTable);
  455. })(jQuery);
  456. });