Table Cookie
Table Cookie extension of Bootstrap Table.
Usage
<script src="extensions/cookie/bootstrap-table-cookie.js"></script>
Example
Options
cookie
-
Attribute:
data-cookie
-
type:
Boolean
-
Detail:
Set
true
to save the state of a table (its paging position, ordering state, records per page). -
Default:
false
cookieExpire
-
Attribute:
data-cookie-expire
-
type:
String
-
Detail:
You must set this property if cookie option is enable to know when will expire the cookie created. Must use this format:
'number{letter}'
like'2h'
, in the letter position you can use:'s'
,'mi'
,'h'
,'d'
,'m'
,'y'
, these means:'seconds'
,'minutes'
,'hours'
,'days'
,'months'
,'years'
. -
Default:
2h
cookiePath
-
Attribute:
data-cookie-path
-
type:
String
-
Detail:
you can tell the browser what path the cookie belongs to. By default, the cookie belongs to the current page.
-
Default:
null
cookieDomain
-
Attribute:
data-cookie-domain
-
type:
String
-
Detail:
This is the website domain, with the www. prefix removed.
-
Default:
null
cookieSecure
-
Attribute:
data-cookie-secure
-
type:
Boolean
-
Detail:
This property keeps cookie communication limited to encrypted transmission, directing browsers to use cookies only via secure/encrypted connections.
-
Default:
null
cookieIdTable
-
Attribute:
data-cookie-id-table
-
type:
String
-
Detail:
You must set this property if the cookie property is enabled to set an unique cookie with an identifier for each table in your page or project. You must set this property because we need create cookies with an identifier.
-
Default:
''
cookieStorage
-
Attribute:
data-cookie-storage
-
type:
String
-
Detail:
Set the storage that this extension will use. Use
cookieStorage
orlocalStorage
orsessionStorage
orcustomStorage
.Info for
customStorage
:
You have usecookieCustomStorageGet
,cookieCustomStorageSet
andcookieCustomStorageDelete
. -
Default:
cookieStorage
cookiesEnabled
-
Attribute:
data-cookies-enabled
-
type:
Array
-
Detail:
Set this array with the table properties (sortOrder, sortName, pageNumber, pageList, columns, searchText, filterControl) that you want to save
-
Default:
['bs.table.sortOrder', 'bs.table.sortName', 'bs.table.pageNumber', 'bs.table.pageList', 'bs.table.columns', 'bs.table.searchText', 'bs.table.filterControl']
cookieCustomStorageGet
-
Attribute:
data-cookie-custom-storage-get
-
type:
function
- parameter
- cookieName - The name of the value e.g. the search
-
Detail:
This option allows to get the saved value from your custom function.
This option is only required if you usecustomStorage
on thecookieStorage
option! - Default:
undefined
cookieCustomStorageSet
-
Attribute:
data-cookie-custom-storage-set
-
type:
function
- parameter
- cookieName - The name of the value e.g. the search
- value - The value which will be saved
-
Detail:
This option allows to save values with your custom function.
This option is only required if you usecustomStorage
on thecookieStorage
option! - Default:
undefined
cookieCustomStorageDelete
-
Attribute:
data-cookie-custom-storage-delete
-
type:
function
- parameter
- cookieName - The name of the value e.g. the search
-
Detail:
This option allows to delete values with your custom function.
This option is only required if you usecustomStorage
on thecookieStorage
option! - Default:
undefined
Methods
getCookies
-
parameters:
undefined
-
Detail:
Return the saved cookies.
deleteCookie
-
parameters:
cookieName
-
Detail:
Delete the saved cookie by cookie name.
This plugin saves
- Sort order
- Page number
- Page number from the list
- Visible columns
- Search text