bootstrap-table
Version:
An extended Bootstrap table with radio, checkbox, sort, pagination, and other added features. (supports twitter bootstrap v2 and v3).
1,580 lines (1,386 loc) • 99.6 kB
JavaScript
/**
* @author zhixin wen <wenzhixin2010@gmail.com>
* version: 1.13.4
* https://github.com/wenzhixin/bootstrap-table/
*/
($ => {
// TOOLS DEFINITION
// ======================
let bootstrapVersion = 3
try {
const rawVersion = $.fn.dropdown.Constructor.VERSION
// Only try to parse VERSION if is is defined.
// It is undefined in older versions of Bootstrap (tested with 3.1.1).
if (rawVersion !== undefined) {
bootstrapVersion = parseInt(rawVersion, 10)
}
} catch (e) {
// ignore
}
const bootstrap = {
3: {
iconsPrefix: 'glyphicon',
icons: {
paginationSwitchDown: 'glyphicon-collapse-down icon-chevron-down',
paginationSwitchUp: 'glyphicon-collapse-up icon-chevron-up',
refresh: 'glyphicon-refresh icon-refresh',
toggleOff: 'glyphicon-list-alt icon-list-alt',
toggleOn: 'glyphicon-list-alt icon-list-alt',
columns: 'glyphicon-th icon-th',
detailOpen: 'glyphicon-plus icon-plus',
detailClose: 'glyphicon-minus icon-minus',
fullscreen: 'glyphicon-fullscreen'
},
classes: {
buttons: 'default',
pull: 'pull'
},
html: {
toobarDropdow: ['<ul class="dropdown-menu" role="menu">', '</ul>'],
toobarDropdowItem: '<li role="menuitem"><label>%s</label></li>',
pageDropdown: ['<ul class="dropdown-menu" role="menu">', '</ul>'],
pageDropdownItem: '<li role="menuitem" class="%s"><a href="#">%s</a></li>'
}
},
4: {
iconsPrefix: 'fa',
icons: {
paginationSwitchDown: 'fa-caret-square-down',
paginationSwitchUp: 'fa-caret-square-up',
refresh: 'fa-sync',
toggleOff: 'fa-toggle-off',
toggleOn: 'fa-toggle-on',
columns: 'fa-th-list',
detailOpen: 'fa-plus',
detailClose: 'fa-minus',
fullscreen: 'fa-arrows-alt'
},
classes: {
buttons: 'secondary',
pull: 'float'
},
html: {
toobarDropdow: ['<div class="dropdown-menu dropdown-menu-right">', '</div>'],
toobarDropdowItem: '<label class="dropdown-item">%s</label>',
pageDropdown: ['<div class="dropdown-menu">', '</div>'],
pageDropdownItem: '<a class="dropdown-item %s" href="#">%s</a>'
}
}
}[bootstrapVersion]
const Utils = {
bootstrapVersion,
// it only does '%s', and return '' when arguments are undefined
sprintf (_str, ...args) {
let flag = true
let i = 0
const str = _str.replace(/%s/g, () => {
const arg = args[i++]
if (typeof arg === 'undefined') {
flag = false
return ''
}
return arg
})
return flag ? str : ''
},
getFieldTitle (list, value) {
for (const item of list) {
if (item.field === value) {
return item.title
}
}
return ''
},
setFieldIndex (columns) {
let totalCol = 0
const flag = []
for (const column of columns[0]) {
totalCol += column.colspan || 1
}
for (let i = 0; i < columns.length; i++) {
flag[i] = []
for (let j = 0; j < totalCol; j++) {
flag[i][j] = false
}
}
for (let i = 0; i < columns.length; i++) {
for (const r of columns[i]) {
const rowspan = r.rowspan || 1
const colspan = r.colspan || 1
const index = flag[i].indexOf(false)
if (colspan === 1) {
r.fieldIndex = index
// when field is undefined, use index instead
if (typeof r.field === 'undefined') {
r.field = index
}
}
for (let k = 0; k < rowspan; k++) {
flag[i + k][index] = true
}
for (let k = 0; k < colspan; k++) {
flag[i][index + k] = true
}
}
}
},
getScrollBarWidth () {
if (this.cachedWidth === undefined) {
const $inner = $('<div/>').addClass('fixed-table-scroll-inner')
const $outer = $('<div/>').addClass('fixed-table-scroll-outer')
$outer.append($inner)
$('body').append($outer)
const w1 = $inner[0].offsetWidth
$outer.css('overflow', 'scroll')
let w2 = $inner[0].offsetWidth
if (w1 === w2) {
w2 = $outer[0].clientWidth
}
$outer.remove()
this.cachedWidth = w1 - w2
}
return this.cachedWidth
},
calculateObjectValue (self, name, args, defaultValue) {
let func = name
if (typeof name === 'string') {
// support obj.func1.func2
const names = name.split('.')
if (names.length > 1) {
func = window
for (const f of names) {
func = func[f]
}
} else {
func = window[name]
}
}
if (func !== null && typeof func === 'object') {
return func
}
if (typeof func === 'function') {
return func.apply(self, args || [])
}
if (
!func &&
typeof name === 'string' &&
this.sprintf(name, ...args)
) {
return this.sprintf(name, ...args)
}
return defaultValue
},
compareObjects (objectA, objectB, compareLength) {
const aKeys = Object.keys(objectA)
const bKeys = Object.keys(objectB)
if (compareLength && aKeys.length !== bKeys.length) {
return false
}
for (const key of aKeys) {
if (bKeys.includes(key) && objectA[key] !== objectB[key]) {
return false
}
}
return true
},
escapeHTML (text) {
if (typeof text === 'string') {
return text
.replace(/&/g, '&')
.replace(/</g, '<')
.replace(/>/g, '>')
.replace(/"/g, '"')
.replace(/'/g, ''')
.replace(/`/g, '`')
}
return text
},
getRealDataAttr (dataAttr) {
for (const [attr, value] of Object.entries(dataAttr)) {
const auxAttr = attr.split(/(?=[A-Z])/).join('-').toLowerCase()
if (auxAttr !== attr) {
dataAttr[auxAttr] = value
delete dataAttr[attr]
}
}
return dataAttr
},
getItemField (item, field, escape) {
let value = item
if (typeof field !== 'string' || item.hasOwnProperty(field)) {
return escape ? this.escapeHTML(item[field]) : item[field]
}
const props = field.split('.')
for (const p of props) {
value = value && value[p]
}
return escape ? this.escapeHTML(value) : value
},
isIEBrowser () {
return navigator.userAgent.includes('MSIE ') ||
/Trident.*rv:11\./.test(navigator.userAgent)
},
findIndex (items, item) {
for (const [i, it] of items.entries()) {
if (JSON.stringify(it) === JSON.stringify(item)) {
return i
}
}
return -1
}
}
// BOOTSTRAP TABLE CLASS DEFINITION
// ======================
const DEFAULTS = {
height: undefined,
classes: 'table table-bordered table-hover',
theadClasses: '',
rowStyle (row, index) {
return {}
},
rowAttributes (row, index) {
return {}
},
undefinedText: '-',
locale: undefined,
sortable: true,
sortClass: undefined,
silentSort: true,
sortName: undefined,
sortOrder: 'asc',
sortStable: false,
rememberOrder: false,
customSort: undefined,
columns: [
[]
],
data: [],
url: undefined,
method: 'get',
cache: true,
contentType: 'application/json',
dataType: 'json',
ajax: undefined,
ajaxOptions: {},
queryParams (params) {
return params
},
queryParamsType: 'limit', // 'limit', undefined
responseHandler (res) {
return res
},
totalField: 'total',
dataField: 'rows',
pagination: false,
onlyInfoPagination: false,
paginationLoop: true,
sidePagination: 'client', // client or server
totalRows: 0,
pageNumber: 1,
pageSize: 10,
pageList: [10, 25, 50, 100],
paginationHAlign: 'right', // right, left
paginationVAlign: 'bottom', // bottom, top, both
paginationDetailHAlign: 'left', // right, left
paginationPreText: '‹',
paginationNextText: '›',
paginationSuccessivelySize: 5, // Maximum successively number of pages in a row
paginationPagesBySide: 1, // Number of pages on each side (right, left) of the current page.
paginationUseIntermediate: false, // Calculate intermediate pages for quick access
search: false,
searchOnEnterKey: false,
strictSearch: false,
trimOnSearch: true,
searchAlign: 'right',
searchTimeOut: 500,
searchText: '',
customSearch: undefined,
showHeader: true,
showFooter: false,
footerStyle (row, index) {
return {}
},
showColumns: false,
minimumCountColumns: 1,
showPaginationSwitch: false,
showRefresh: false,
showToggle: false,
showFullscreen: false,
smartDisplay: true,
escape: false,
idField: undefined,
uniqueId: undefined,
cardView: false,
detailView: false,
detailFormatter (index, row) {
return ''
},
detailFilter (index, row) {
return true
},
selectItemName: 'btSelectItem',
clickToSelect: false,
ignoreClickToSelectOn ({tagName}) {
return ['A', 'BUTTON'].includes(tagName)
},
singleSelect: false,
checkboxHeader: true,
maintainSelected: false,
toolbar: undefined,
toolbarAlign: 'left',
buttonsToolbar: undefined,
buttonsAlign: 'right',
buttonsClass: bootstrap.classes.buttons,
icons: bootstrap.icons,
iconSize: undefined,
iconsPrefix: bootstrap.iconsPrefix, // glyphicon or fa(font-awesome)
onAll (name, args) {
return false
},
onClickCell (field, value, row, $element) {
return false
},
onDblClickCell (field, value, row, $element) {
return false
},
onClickRow (item, $element) {
return false
},
onDblClickRow (item, $element) {
return false
},
onSort (name, order) {
return false
},
onCheck (row) {
return false
},
onUncheck (row) {
return false
},
onCheckAll (rows) {
return false
},
onUncheckAll (rows) {
return false
},
onCheckSome (rows) {
return false
},
onUncheckSome (rows) {
return false
},
onLoadSuccess (data) {
return false
},
onLoadError (status) {
return false
},
onColumnSwitch (field, checked) {
return false
},
onPageChange (number, size) {
return false
},
onSearch (text) {
return false
},
onToggle (cardView) {
return false
},
onPreBody (data) {
return false
},
onPostBody () {
return false
},
onPostHeader () {
return false
},
onExpandRow (index, row, $detail) {
return false
},
onCollapseRow (index, row) {
return false
},
onRefreshOptions (options) {
return false
},
onRefresh (params) {
return false
},
onResetView () {
return false
},
onScrollBody () {
return false
}
}
const LOCALES = {}
LOCALES['en-US'] = LOCALES.en = {
formatLoadingMessage () {
return 'Loading, please wait...'
},
formatRecordsPerPage (pageNumber) {
return Utils.sprintf('%s rows per page', pageNumber)
},
formatShowingRows (pageFrom, pageTo, totalRows) {
return Utils.sprintf('Showing %s to %s of %s rows', pageFrom, pageTo, totalRows)
},
formatDetailPagination (totalRows) {
return Utils.sprintf('Showing %s rows', totalRows)
},
formatSearch () {
return 'Search'
},
formatNoMatches () {
return 'No matching records found'
},
formatPaginationSwitch () {
return 'Hide/Show pagination'
},
formatRefresh () {
return 'Refresh'
},
formatToggle () {
return 'Toggle'
},
formatFullscreen () {
return 'Fullscreen'
},
formatColumns () {
return 'Columns'
},
formatAllRows () {
return 'All'
}
}
$.extend(DEFAULTS, LOCALES['en-US'])
const COLUMN_DEFAULTS = {
radio: false,
checkbox: false,
checkboxEnabled: true,
field: undefined,
title: undefined,
titleTooltip: undefined,
'class': undefined,
align: undefined, // left, right, center
halign: undefined, // left, right, center
falign: undefined, // left, right, center
valign: undefined, // top, middle, bottom
width: undefined,
sortable: false,
order: 'asc', // asc, desc
visible: true,
switchable: true,
clickToSelect: true,
formatter: undefined,
footerFormatter: undefined,
events: undefined,
sorter: undefined,
sortName: undefined,
cellStyle: undefined,
searchable: true,
searchFormatter: true,
cardVisible: true,
escape: false,
showSelectTitle: false
}
const EVENTS = {
'all.bs.table': 'onAll',
'click-cell.bs.table': 'onClickCell',
'dbl-click-cell.bs.table': 'onDblClickCell',
'click-row.bs.table': 'onClickRow',
'dbl-click-row.bs.table': 'onDblClickRow',
'sort.bs.table': 'onSort',
'check.bs.table': 'onCheck',
'uncheck.bs.table': 'onUncheck',
'check-all.bs.table': 'onCheckAll',
'uncheck-all.bs.table': 'onUncheckAll',
'check-some.bs.table': 'onCheckSome',
'uncheck-some.bs.table': 'onUncheckSome',
'load-success.bs.table': 'onLoadSuccess',
'load-error.bs.table': 'onLoadError',
'column-switch.bs.table': 'onColumnSwitch',
'page-change.bs.table': 'onPageChange',
'search.bs.table': 'onSearch',
'toggle.bs.table': 'onToggle',
'pre-body.bs.table': 'onPreBody',
'post-body.bs.table': 'onPostBody',
'post-header.bs.table': 'onPostHeader',
'expand-row.bs.table': 'onExpandRow',
'collapse-row.bs.table': 'onCollapseRow',
'refresh-options.bs.table': 'onRefreshOptions',
'reset-view.bs.table': 'onResetView',
'refresh.bs.table': 'onRefresh',
'scroll-body.bs.table': 'onScrollBody'
}
class BootstrapTable {
constructor (el, options) {
this.options = options
this.$el = $(el)
this.$el_ = this.$el.clone()
this.timeoutId_ = 0
this.timeoutFooter_ = 0
this.init()
}
init () {
this.initLocale()
this.initContainer()
this.initTable()
this.initHeader()
this.initData()
this.initHiddenRows()
this.initFooter()
this.initToolbar()
this.initPagination()
this.initBody()
this.initSearchText()
this.initServer()
}
initLocale () {
if (this.options.locale) {
const locales = $.fn.bootstrapTable.locales
const parts = this.options.locale.split(/-|_/)
parts[0] = parts[0].toLowerCase()
if (parts[1]) {
parts[1] = parts[1].toUpperCase()
}
if (locales[this.options.locale]) {
$.extend(this.options, locales[this.options.locale])
} else if (locales[parts.join('-')]) {
$.extend(this.options, locales[parts.join('-')])
} else if (locales[parts[0]]) {
$.extend(this.options, locales[parts[0]])
}
}
}
initContainer () {
const topPagination = ['top', 'both'].includes(this.options.paginationVAlign)
? '<div class="fixed-table-pagination clearfix"></div>' : ''
const bottomPagination = ['bottom', 'both'].includes(this.options.paginationVAlign)
? '<div class="fixed-table-pagination"></div>' : ''
this.$container = $(`
<div class="bootstrap-table">
<div class="fixed-table-toolbar"></div>
${topPagination}
<div class="fixed-table-container">
<div class="fixed-table-header"><table></table></div>
<div class="fixed-table-body">
<div class="fixed-table-loading">
${this.options.formatLoadingMessage()}
</div>
</div>
<div class="fixed-table-footer"><table><tr></tr></table></div>
</div>
${bottomPagination}
</div>
`)
this.$container.insertAfter(this.$el)
this.$tableContainer = this.$container.find('.fixed-table-container')
this.$tableHeader = this.$container.find('.fixed-table-header')
this.$tableBody = this.$container.find('.fixed-table-body')
this.$tableLoading = this.$container.find('.fixed-table-loading')
this.$tableFooter = this.$container.find('.fixed-table-footer')
// checking if custom table-toolbar exists or not
if (this.options.buttonsToolbar) {
this.$toolbar = $('body').find(this.options.buttonsToolbar)
} else {
this.$toolbar = this.$container.find('.fixed-table-toolbar')
}
this.$pagination = this.$container.find('.fixed-table-pagination')
this.$tableBody.append(this.$el)
this.$container.after('<div class="clearfix"></div>')
this.$el.addClass(this.options.classes)
if (this.options.height) {
this.$tableContainer.addClass('fixed-height')
if (this.options.classes.split(' ').includes('table-bordered')) {
this.$tableBody.append('<div class="fixed-table-border"></div>')
this.$tableBorder = this.$tableBody.find('.fixed-table-border')
this.$tableLoading.addClass('fixed-table-border')
}
}
}
initTable () {
const columns = []
const data = []
this.$header = this.$el.find('>thead')
if (!this.$header.length) {
this.$header = $(`<thead class="${this.options.theadClasses}"></thead>`).appendTo(this.$el)
} else if (this.options.theadClasses) {
this.$header.addClass(this.options.theadClasses)
}
this.$header.find('tr').each((i, el) => {
const column = []
$(el).find('th').each((i, el) => {
// #2014: getFieldIndex and elsewhere assume this is string, causes issues if not
if (typeof $(el).data('field') !== 'undefined') {
$(el).data('field', `${$(el).data('field')}`)
}
column.push($.extend({}, {
title: $(el).html(),
'class': $(el).attr('class'),
titleTooltip: $(el).attr('title'),
rowspan: $(el).attr('rowspan') ? +$(el).attr('rowspan') : undefined,
colspan: $(el).attr('colspan') ? +$(el).attr('colspan') : undefined
}, $(el).data()))
})
columns.push(column)
})
if (!Array.isArray(this.options.columns[0])) {
this.options.columns = [this.options.columns]
}
this.options.columns = $.extend(true, [], columns, this.options.columns)
this.columns = []
this.fieldsColumnsIndex = []
Utils.setFieldIndex(this.options.columns)
this.options.columns.forEach((columns, i) => {
columns.forEach((_column, j) => {
const column = $.extend({}, BootstrapTable.COLUMN_DEFAULTS, _column)
if (typeof column.fieldIndex !== 'undefined') {
this.columns[column.fieldIndex] = column
this.fieldsColumnsIndex[column.field] = column.fieldIndex
}
this.options.columns[i][j] = column
})
})
// if options.data is setting, do not process tbody data
if (this.options.data.length) {
return
}
const m = []
this.$el.find('>tbody>tr').each((y, el) => {
const row = {}
// save tr's id, class and data-* attributes
row._id = $(el).attr('id')
row._class = $(el).attr('class')
row._data = Utils.getRealDataAttr($(el).data())
$(el).find('>td').each((_x, el) => {
const cspan = +$(el).attr('colspan') || 1
const rspan = +$(el).attr('rowspan') || 1
let x = _x
// skip already occupied cells in current row
for (; m[y] && m[y][x]; x++) {
// ignore
}
// mark matrix elements occupied by current cell with true
for (let tx = x; tx < x + cspan; tx++) {
for (let ty = y; ty < y + rspan; ty++) {
if (!m[ty]) { // fill missing rows
m[ty] = []
}
m[ty][tx] = true
}
}
const field = this.columns[x].field
row[field] = $(el).html()
// save td's id, class and data-* attributes
row[`_${field}_id`] = $(el).attr('id')
row[`_${field}_class`] = $(el).attr('class')
row[`_${field}_rowspan`] = $(el).attr('rowspan')
row[`_${field}_colspan`] = $(el).attr('colspan')
row[`_${field}_title`] = $(el).attr('title')
row[`_${field}_data`] = Utils.getRealDataAttr($(el).data())
})
data.push(row)
})
this.options.data = data
if (data.length) {
this.fromHtml = true
}
}
initHeader () {
const visibleColumns = {}
const html = []
this.header = {
fields: [],
styles: [],
classes: [],
formatters: [],
events: [],
sorters: [],
sortNames: [],
cellStyles: [],
searchables: []
}
this.options.columns.forEach((columns, i) => {
html.push('<tr>')
if (i === 0 && !this.options.cardView && this.options.detailView) {
html.push(`<th class="detail" rowspan="${this.options.columns.length}">
<div class="fht-cell"></div>
</th>
`)
}
columns.forEach((column, j) => {
let text = ''
let halign = '' // header align style
let align = '' // body align style
let style = ''
const class_ = Utils.sprintf(' class="%s"', column['class'])
let unitWidth = 'px'
let width = column.width
if (column.width !== undefined && (!this.options.cardView)) {
if (typeof column.width === 'string') {
if (column.width.includes('%')) {
unitWidth = '%'
}
}
}
if (column.width && typeof column.width === 'string') {
width = column.width.replace('%', '').replace('px', '')
}
halign = Utils.sprintf('text-align: %s; ', column.halign ? column.halign : column.align)
align = Utils.sprintf('text-align: %s; ', column.align)
style = Utils.sprintf('vertical-align: %s; ', column.valign)
style += Utils.sprintf('width: %s; ', (column.checkbox || column.radio) && !width
? (!column.showSelectTitle ? '36px' : undefined)
: (width ? width + unitWidth : undefined))
if (typeof column.fieldIndex !== 'undefined') {
this.header.fields[column.fieldIndex] = column.field
this.header.styles[column.fieldIndex] = align + style
this.header.classes[column.fieldIndex] = class_
this.header.formatters[column.fieldIndex] = column.formatter
this.header.events[column.fieldIndex] = column.events
this.header.sorters[column.fieldIndex] = column.sorter
this.header.sortNames[column.fieldIndex] = column.sortName
this.header.cellStyles[column.fieldIndex] = column.cellStyle
this.header.searchables[column.fieldIndex] = column.searchable
if (!column.visible) {
return
}
if (this.options.cardView && (!column.cardVisible)) {
return
}
visibleColumns[column.field] = column
}
html.push(`<th${Utils.sprintf(' title="%s"', column.titleTooltip)}`,
column.checkbox || column.radio
? Utils.sprintf(' class="bs-checkbox %s"', column['class'] || '')
: class_,
Utils.sprintf(' style="%s"', halign + style),
Utils.sprintf(' rowspan="%s"', column.rowspan),
Utils.sprintf(' colspan="%s"', column.colspan),
Utils.sprintf(' data-field="%s"', column.field),
// If `column` is not the first element of `this.options.columns[0]`, then className 'data-not-first-th' should be added.
j === 0 && i > 0 ? ' data-not-first-th' : '',
'>')
html.push(Utils.sprintf('<div class="th-inner %s">', this.options.sortable && column.sortable
? 'sortable both' : ''))
text = this.options.escape ? Utils.escapeHTML(column.title) : column.title
const title = text
if (column.checkbox) {
text = ''
if (!this.options.singleSelect && this.options.checkboxHeader) {
text = '<input name="btSelectAll" type="checkbox" />'
}
this.header.stateField = column.field
}
if (column.radio) {
text = ''
this.header.stateField = column.field
this.options.singleSelect = true
}
if (!text && column.showSelectTitle) {
text += title
}
html.push(text)
html.push('</div>')
html.push('<div class="fht-cell"></div>')
html.push('</div>')
html.push('</th>')
})
html.push('</tr>')
})
this.$header.html(html.join(''))
this.$header.find('th[data-field]').each((i, el) => {
$(el).data(visibleColumns[$(el).data('field')])
})
this.$container.off('click', '.th-inner').on('click', '.th-inner', e => {
const $this = $(e.currentTarget)
if (this.options.detailView && !$this.parent().hasClass('bs-checkbox')) {
if ($this.closest('.bootstrap-table')[0] !== this.$container[0]) {
return false
}
}
if (this.options.sortable && $this.parent().data().sortable) {
this.onSort(e)
}
})
this.$header.children().children().off('keypress').on('keypress', e => {
if (this.options.sortable && $(e.currentTarget).data().sortable) {
const code = e.keyCode || e.which
if (code === 13) { // Enter keycode
this.onSort(e)
}
}
})
$(window).off('resize.bootstrap-table')
if (!this.options.showHeader || this.options.cardView) {
this.$header.hide()
this.$tableHeader.hide()
this.$tableLoading.css('top', 0)
} else {
this.$header.show()
this.$tableHeader.show()
this.$tableLoading.css('top', this.$header.outerHeight() + 1)
// Assign the correct sortable arrow
this.getCaret()
$(window).on('resize.bootstrap-table', $.proxy(this.resetWidth, this))
}
this.$selectAll = this.$header.find('[name="btSelectAll"]')
this.$selectAll.off('click').on('click', ({currentTarget}) => {
const checked = $(currentTarget).prop('checked')
this[checked ? 'checkAll' : 'uncheckAll']()
this.updateSelected()
})
}
initFooter () {
if (!this.options.showFooter || this.options.cardView) {
this.$tableFooter.hide()
} else {
this.$tableFooter.show()
}
}
initData (data, type) {
if (type === 'append') {
this.options.data = this.options.data.concat(data)
} else if (type === 'prepend') {
this.options.data = [].concat(data).concat(this.options.data)
} else {
this.options.data = data || this.options.data
}
this.data = this.options.data
if (this.options.sidePagination === 'server') {
return
}
this.initSort()
}
initSort () {
let name = this.options.sortName
const order = this.options.sortOrder === 'desc' ? -1 : 1
const index = this.header.fields.indexOf(this.options.sortName)
let timeoutId = 0
if (index !== -1) {
if (this.options.sortStable) {
this.data.forEach((row, i) => {
if (!row.hasOwnProperty('_position')) {
row._position = i
}
})
}
if (this.options.customSort) {
Utils.calculateObjectValue(this.options, this.options.customSort, [
this.options.sortName,
this.options.sortOrder,
this.data
])
} else {
this.data.sort((a, b) => {
if (this.header.sortNames[index]) {
name = this.header.sortNames[index]
}
let aa = Utils.getItemField(a, name, this.options.escape)
let bb = Utils.getItemField(b, name, this.options.escape)
const value = Utils.calculateObjectValue(this.header, this.header.sorters[index], [aa, bb, a, b])
if (value !== undefined) {
if (this.options.sortStable && value === 0) {
return order * (a._position - b._position)
}
return order * value
}
// Fix #161: undefined or null string sort bug.
if (aa === undefined || aa === null) {
aa = ''
}
if (bb === undefined || bb === null) {
bb = ''
}
if (this.options.sortStable && aa === bb) {
aa = a._position
bb = b._position
}
// IF both values are numeric, do a numeric comparison
if ($.isNumeric(aa) && $.isNumeric(bb)) {
// Convert numerical values form string to float.
aa = parseFloat(aa)
bb = parseFloat(bb)
if (aa < bb) {
return order * -1
}
if (aa > bb) {
return order
}
return 0
}
if (aa === bb) {
return 0
}
// If value is not a string, convert to string
if (typeof aa !== 'string') {
aa = aa.toString()
}
if (aa.localeCompare(bb) === -1) {
return order * -1
}
return order
})
}
if (this.options.sortClass !== undefined) {
clearTimeout(timeoutId)
timeoutId = setTimeout(() => {
this.$el.removeClass(this.options.sortClass)
const index = this.$header.find(`[data-field="${this.options.sortName}"]`).index()
this.$el.find(`tr td:nth-child(${index + 1})`).addClass(this.options.sortClass)
}, 250)
}
}
}
onSort ({type, currentTarget}) {
const $this = type === 'keypress' ? $(currentTarget) : $(currentTarget).parent()
const $this_ = this.$header.find('th').eq($this.index())
this.$header.add(this.$header_).find('span.order').remove()
if (this.options.sortName === $this.data('field')) {
this.options.sortOrder = this.options.sortOrder === 'asc' ? 'desc' : 'asc'
} else {
this.options.sortName = $this.data('field')
if (this.options.rememberOrder) {
this.options.sortOrder = $this.data('order') === 'asc' ? 'desc' : 'asc'
} else {
this.options.sortOrder = this.columns[this.fieldsColumnsIndex[$this.data('field')]].order
}
}
this.trigger('sort', this.options.sortName, this.options.sortOrder)
$this.add($this_).data('order', this.options.sortOrder)
// Assign the correct sortable arrow
this.getCaret()
if (this.options.sidePagination === 'server') {
this.initServer(this.options.silentSort)
return
}
this.initSort()
this.initBody()
}
initToolbar () {
let html = []
let timeoutId = 0
let $keepOpen
let $search
let switchableCount = 0
if (this.$toolbar.find('.bs-bars').children().length) {
$('body').append($(this.options.toolbar))
}
this.$toolbar.html('')
if (typeof this.options.toolbar === 'string' || typeof this.options.toolbar === 'object') {
$(Utils.sprintf('<div class="bs-bars %s-%s"></div>', bootstrap.classes.pull, this.options.toolbarAlign))
.appendTo(this.$toolbar)
.append($(this.options.toolbar))
}
// showColumns, showToggle, showRefresh
html = [Utils.sprintf('<div class="columns columns-%s btn-group %s-%s">',
this.options.buttonsAlign, bootstrap.classes.pull, this.options.buttonsAlign)]
if (typeof this.options.icons === 'string') {
this.options.icons = Utils.calculateObjectValue(null, this.options.icons)
}
if (this.options.showPaginationSwitch) {
html.push(Utils.sprintf(`<button class="btn${Utils.sprintf(' btn-%s', this.options.buttonsClass)}${Utils.sprintf(' btn-%s', this.options.iconSize)}" type="button" name="paginationSwitch" aria-label="pagination Switch" title="%s">`,
this.options.formatPaginationSwitch()),
Utils.sprintf('<i class="%s %s"></i>', this.options.iconsPrefix, this.options.icons.paginationSwitchDown),
'</button>')
}
if (this.options.showFullscreen) {
this.$toolbar.find('button[name="fullscreen"]')
.off('click').on('click', $.proxy(this.toggleFullscreen, this))
}
if (this.options.showRefresh) {
html.push(Utils.sprintf(`<button class="btn${Utils.sprintf(' btn-%s', this.options.buttonsClass)}${Utils.sprintf(' btn-%s', this.options.iconSize)}" type="button" name="refresh" aria-label="refresh" title="%s">`,
this.options.formatRefresh()),
Utils.sprintf('<i class="%s %s"></i>', this.options.iconsPrefix, this.options.icons.refresh),
'</button>')
}
if (this.options.showToggle) {
html.push(Utils.sprintf(`<button class="btn${Utils.sprintf(' btn-%s', this.options.buttonsClass)}${Utils.sprintf(' btn-%s', this.options.iconSize)}" type="button" name="toggle" aria-label="toggle" title="%s">`,
this.options.formatToggle()),
Utils.sprintf('<i class="%s %s"></i>', this.options.iconsPrefix, this.options.icons.toggleOff),
'</button>')
}
if (this.options.showFullscreen) {
html.push(Utils.sprintf(`<button class="btn${Utils.sprintf(' btn-%s', this.options.buttonsClass)}${Utils.sprintf(' btn-%s', this.options.iconSize)}" type="button" name="fullscreen" aria-label="fullscreen" title="%s">`,
this.options.formatFullscreen()),
Utils.sprintf('<i class="%s %s"></i>', this.options.iconsPrefix, this.options.icons.fullscreen),
'</button>')
}
if (this.options.showColumns) {
html.push(Utils.sprintf('<div class="keep-open btn-group" title="%s">',
this.options.formatColumns()),
`<button type="button" aria-label="columns" class="btn${Utils.sprintf(' btn-%s', this.options.buttonsClass)}${Utils.sprintf(' btn-%s', this.options.iconSize)} dropdown-toggle" data-toggle="dropdown">`,
Utils.sprintf('<i class="%s %s"></i>', this.options.iconsPrefix, this.options.icons.columns),
' <span class="caret"></span>',
'</button>',
bootstrap.html.toobarDropdow[0])
this.columns.forEach((column, i) => {
if (column.radio || column.checkbox) {
return
}
if (this.options.cardView && !column.cardVisible) {
return
}
const checked = column.visible ? ' checked="checked"' : ''
if (column.switchable) {
html.push(Utils.sprintf(bootstrap.html.toobarDropdowItem,
Utils.sprintf('<input type="checkbox" data-field="%s" value="%s"%s> %s',
column.field, i, checked, column.title)))
switchableCount++
}
})
html.push(bootstrap.html.toobarDropdow[1], '</div>')
}
html.push('</div>')
// Fix #188: this.showToolbar is for extensions
if (this.showToolbar || html.length > 2) {
this.$toolbar.append(html.join(''))
}
if (this.options.showPaginationSwitch) {
this.$toolbar.find('button[name="paginationSwitch"]')
.off('click').on('click', $.proxy(this.togglePagination, this))
}
if (this.options.showRefresh) {
this.$toolbar.find('button[name="refresh"]')
.off('click').on('click', $.proxy(this.refresh, this))
}
if (this.options.showToggle) {
this.$toolbar.find('button[name="toggle"]')
.off('click').on('click', () => {
this.toggleView()
})
}
if (this.options.showColumns) {
$keepOpen = this.$toolbar.find('.keep-open')
if (switchableCount <= this.options.minimumCountColumns) {
$keepOpen.find('input').prop('disabled', true)
}
$keepOpen.find('li').off('click').on('click', e => {
e.stopImmediatePropagation()
})
$keepOpen.find('input').off('click').on('click', ({currentTarget}) => {
const $this = $(currentTarget)
this.toggleColumn($this.val(), $this.prop('checked'), false)
this.trigger('column-switch', $this.data('field'), $this.prop('checked'))
})
}
if (this.options.search) {
html = []
html.push(
Utils.sprintf('<div class="%s-%s search">', bootstrap.classes.pull, this.options.searchAlign),
Utils.sprintf(`<input class="form-control${Utils.sprintf(' input-%s', this.options.iconSize)}" type="text" placeholder="%s">`,
this.options.formatSearch()),
'</div>')
this.$toolbar.append(html.join(''))
$search = this.$toolbar.find('.search input')
$search.off('keyup drop blur').on('keyup drop blur', event => {
if (this.options.searchOnEnterKey && event.keyCode !== 13) {
return
}
if ([37, 38, 39, 40].includes(event.keyCode)) {
return
}
clearTimeout(timeoutId) // doesn't matter if it's 0
timeoutId = setTimeout(() => {
this.onSearch(event)
}, this.options.searchTimeOut)
})
if (Utils.isIEBrowser()) {
$search.off('mouseup').on('mouseup', event => {
clearTimeout(timeoutId) // doesn't matter if it's 0
timeoutId = setTimeout(() => {
this.onSearch(event)
}, this.options.searchTimeOut)
})
}
}
}
onSearch ({currentTarget, firedByInitSearchText}) {
const text = $.trim($(currentTarget).val())
// trim search input
if (this.options.trimOnSearch && $(currentTarget).val() !== text) {
$(currentTarget).val(text)
}
if (text === this.searchText) {
return
}
this.searchText = text
this.options.searchText = text
if (!firedByInitSearchText) {
this.options.pageNumber = 1
}
this.initSearch()
if (firedByInitSearchText) {
if (this.options.sidePagination === 'client') {
this.updatePagination()
}
} else {
this.updatePagination()
}
this.trigger('search', text)
}
initSearch () {
if (this.options.sidePagination !== 'server') {
if (this.options.customSearch) {
Utils.calculateObjectValue(this.options, this.options.customSearch, [this.searchText])
return
}
const s = this.searchText && (this.options.escape
? Utils.escapeHTML(this.searchText) : this.searchText).toLowerCase()
const f = $.isEmptyObject(this.filterColumns) ? null : this.filterColumns
// Check filter
this.data = f ? this.options.data.filter((item, i) => {
for (const key in f) {
if (
(Array.isArray(f[key]) &&
!f[key].includes(item[key])) ||
(!Array.isArray(f[key]) &&
item[key] !== f[key])
) {
return false
}
}
return true
}) : this.options.data
this.data = s ? this.data.filter((item, i) => {
for (let j = 0; j < this.header.fields.length; j++) {
if (!this.header.searchables[j]) {
continue
}
const key = $.isNumeric(this.header.fields[j]) ? parseInt(this.header.fields[j], 10) : this.header.fields[j]
const column = this.columns[this.fieldsColumnsIndex[key]]
let value
if (typeof key === 'string') {
value = item
const props = key.split('.')
for (let i = 0; i < props.length; i++) {
if (value[props[i]] !== null) {
value = value[props[i]]
}
}
} else {
value = item[key]
}
// Fix #142: respect searchForamtter boolean
if (column && column.searchFormatter) {
value = Utils.calculateObjectValue(column,
this.header.formatters[j], [value, item, i], value)
}
if (typeof value === 'string' || typeof value === 'number') {
if (this.options.strictSearch) {
if ((`${value}`).toLowerCase() === s) {
return true
}
} else {
if ((`${value}`).toLowerCase().includes(s)) {
return true
}
}
}
}
return false
}) : this.data
}
}
initPagination () {
if (!this.options.pagination) {
this.$pagination.hide()
return
}
this.$pagination.show()
const html = []
let $allSelected = false
let i
let from
let to
let $pageList
let $pre
let $next
let $number
const data = this.getData()
let pageList = this.options.pageList
if (this.options.sidePagination !== 'server') {
this.options.totalRows = data.length
}
this.totalPages = 0
if (this.options.totalRows) {
if (this.options.pageSize === this.options.formatAllRows()) {
this.options.pageSize = this.options.totalRows
$allSelected = true
} else if (this.options.pageSize === this.options.totalRows) {
// Fix #667 Table with pagination,
// multiple pages and a search this matches to one page throws exception
const pageLst = typeof this.options.pageList === 'string'
? this.options.pageList.replace('[', '').replace(']', '')
.replace(/ /g, '').toLowerCase().split(',') : this.options.pageList
if (pageLst.includes(this.options.formatAllRows().toLowerCase())) {
$allSelected = true
}
}
this.totalPages = ~~((this.options.totalRows - 1) / this.options.pageSize) + 1
this.options.totalPages = this.totalPages
}
if (this.totalPages > 0 && this.options.pageNumber > this.totalPages) {
this.options.pageNumber = this.totalPages
}
this.pageFrom = (this.options.pageNumber - 1) * this.options.pageSize + 1
this.pageTo = this.options.pageNumber * this.options.pageSize
if (this.pageTo > this.options.totalRows) {
this.pageTo = this.options.totalRows
}
html.push(
Utils.sprintf('<div class="%s-%s pagination-detail">', bootstrap.classes.pull, this.options.paginationDetailHAlign),
'<span class="pagination-info">',
this.options.onlyInfoPagination ? this.options.formatDetailPagination(this.options.totalRows)
: this.options.formatShowingRows(this.pageFrom, this.pageTo, this.options.totalRows),
'</span>')
if (!this.options.onlyInfoPagination) {
html.push('<span class="page-list">')
const pageNumber = [
Utils.sprintf('<span class="btn-group %s">',
this.options.paginationVAlign === 'top' || this.options.paginationVAlign === 'both'
? 'dropdown' : 'dropup'),
`<button type="button" class="btn${Utils.sprintf(' btn-%s', this.options.buttonsClass)}${Utils.sprintf(' btn-%s', this.options.iconSize)} dropdown-toggle" data-toggle="dropdown">`,
'<span class="page-size">',
$allSelected ? this.options.formatAllRows() : this.options.pageSize,
'</span>',
' <span class="caret"></span>',
'</button>',
bootstrap.html.pageDropdown[0]
]
if (typeof this.options.pageList === 'string') {
const list = this.options.pageList.replace('[', '').replace(']', '')
.replace(/ /g, '').split(',')
pageList = []
for (const value of list) {
pageList.push(
(value.toUpperCase() === this.options.formatAllRows().toUpperCase() ||
value.toUpperCase() === 'UNLIMITED')
? this.options.formatAllRows() : +value)
}
}
pageList.forEach((page, i) => {
if (!this.options.smartDisplay || i === 0 || pageList[i - 1] < this.options.totalRows) {
let active
if ($allSelected) {
active = page === this.options.formatAllRows() ? 'active' : ''
} else {
active = page === this.options.pageSize ? 'active' : ''
}
pageNumber.push(Utils.sprintf(bootstrap.html.pageDropdownItem, active, page))
}
})
pageNumber.push(`${bootstrap.html.pageDropdown[1]}</span>`)
html.push(this.options.formatRecordsPerPage(pageNumber.join('')))
html.push('</span>')
html.push('</div>',
Utils.sprintf('<div class="%s-%s pagination">', bootstrap.classes.pull, this.options.paginationHAlign),
`<ul class="pagination${Utils.sprintf(' pagination-%s', this.options.iconSize)}">`,
Utils.sprintf('<li class="page-item page-pre"><a class="page-link" href="#">%s</a></li>',
this.options.paginationPreText))
if (this.totalPages < this.options.paginationSuccessivelySize) {
from = 1
to = this.totalPages
} else {
from = this.options.pageNumber - this.options.paginationPagesBySide
to = from + (this.options.paginationPagesBySide * 2)
}
if (this.options.pageNumber < (this.options.paginationSuccessivelySize - 1)) {
to = this.options.paginationSuccessivelySize
}
if (to > this.totalPages) {
to = this.totalPages
}
if (this.options.paginationSuccessivelySize > this.totalPages - from) {
from = from - (this.options.paginationSuccessivelySize - (this.totalPages - from)) + 1
}
if (from < 1) {
from = 1
}
if (to > this.totalPages) {
to = this.totalPages
}
const middleSize = Math.round(this.options.paginationPagesBySide / 2)
const pageItem = (i, classes = '') => `
<li class="page-item${classes}${i === this.options.pageNumber ? ' active' : ''}">
<a class="page-link" href="#">${i}</a>
</li>
`
if (from > 1) {
let max = this.options.paginationPagesBySide
if (max >= from) max = from - 1
for (i = 1; i <= max; i++) {
html.push(pageItem(i))
}
if ((from - 1) === max + 1) {
i = from - 1
html.push(pageItem(i))
} else {
if ((from - 1) > max) {
if (
(from - this.options.paginationPagesBySide * 2) > this.options.paginationPagesBySide &&
this.options.paginationUseIntermediate
) {
i = Math.round(((from - middleSize) / 2) + middleSize)
html.push(pageItem(i, ' page-intermediate'))
} else {
html.push(`
<li class="page-item page-first-separator disabled">
<a class="page-link" href="#">...</a>
</li>`
)
}
}
}
}
for (i = from; i <= to; i++) {
html.push(pageItem(i))
}
if (this.totalPages > to) {
let min = this.totalPages - (this.options.paginationPagesBySide - 1)
if (to >= min) min = to + 1
if ((to + 1) === min - 1) {
i = to + 1
html.push(pageItem(i))
} else {
if (min > (to + 1)) {
if (
(this.totalPages - to) > this.options.paginationPagesBySide * 2 &&
this.options.paginationUseIntermediate
) {
i = Math.round(((this.totalPages - middleSize - to) / 2) + to)
html.push(pageItem(i, ' page-intermediate'))
} else {
html.push(`
<li class="page-item page-last-separator disabled">
<a class="page-link" href="#">...</a>
</li>`
)
}
}
}
for (i = min; i <= this.totalPages; i++) {
html.push(pageItem(i))
}
}
html.push(`
<li class="page-item page-next">
<a class="page-link" href="#">${this.options.paginationNextText}</a>
</li>
</ul>
</div>
`)
}
this.$pagination.html(html.join(''))
if (!this.options.onlyInfoPagination) {
$pageList = this.$pagination.find('.page-list a')
$pre = this.$pagination.find('.page-pre')
$next = this.$pagination.find('.page-next')
$number = this.$pagination.find('.page-item').not('.page-next, .page-pre')
if (this.options.smartDisplay) {
if (this.totalPages <= 1) {
this.$pagination.find('div.pagination').hide()
}