bootstrap-table
Version:
An extended table to integration with some of the most widely used CSS frameworks. (Supports Bootstrap, Semantic UI, Bulma, Material Design, Foundation)
3,463 lines • 108 kB
JavaScript
/**
* @author zhixin wen <wenzhixin2010@gmail.com>
* version: 1.21.3
* https://github.com/wenzhixin/bootstrap-table/
*/
import Constants from './constants/index.js'
import Utils from './utils/index.js'
import VirtualScroll from './virtual-scroll/index.js'
class BootstrapTable {
constructor (el, options) {
this.options = options
this.$el = $(el)
this.$el_ = this.$el.clone()
this.timeoutId_ = 0
this.timeoutFooter_ = 0
}
init () {
this.initConstants()
this.initLocale()
this.initContainer()
this.initTable()
this.initHeader()
this.initData()
this.initHiddenRows()
this.initToolbar()
this.initPagination()
this.initBody()
this.initSearchText()
this.initServer()
}
initConstants () {
const opts = this.options
this.constants = Constants.CONSTANTS
this.constants.theme = $.fn.bootstrapTable.theme
this.constants.dataToggle = this.constants.html.dataToggle || 'data-toggle'
// init iconsPrefix and icons
const iconsPrefix = Utils.getIconsPrefix($.fn.bootstrapTable.theme)
const icons = Utils.getIcons(iconsPrefix)
if (typeof opts.icons === 'string') {
opts.icons = Utils.calculateObjectValue(null, opts.icons)
}
opts.iconsPrefix = opts.iconsPrefix || $.fn.bootstrapTable.defaults.iconsPrefix || iconsPrefix
opts.icons = Object.assign(icons, $.fn.bootstrapTable.defaults.icons, opts.icons)
// init buttons class
const buttonsPrefix = opts.buttonsPrefix ? `${opts.buttonsPrefix}-` : ''
this.constants.buttonsClass = [
opts.buttonsPrefix,
buttonsPrefix + opts.buttonsClass,
Utils.sprintf(`${buttonsPrefix}%s`, opts.iconSize)
].join(' ').trim()
this.buttons = Utils.calculateObjectValue(this, opts.buttons, [], {})
if (typeof this.buttons !== 'object') {
this.buttons = {}
}
}
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()
}
let localesToExtend = {}
if (locales[this.options.locale]) {
localesToExtend = locales[this.options.locale]
} else if (locales[parts.join('-')]) {
localesToExtend = locales[parts.join('-')]
} else if (locales[parts[0]]) {
localesToExtend = locales[parts[0]]
}
for (const [formatName, func] of Object.entries(localesToExtend)) {
if (this.options[formatName] !== BootstrapTable.DEFAULTS[formatName]) {
continue
}
this.options[formatName] = func
}
}
}
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>' : ''
const loadingTemplate = Utils.calculateObjectValue(this.options,
this.options.loadingTemplate, [this.options.formatLoadingMessage()])
this.$container = $(`
<div class="bootstrap-table ${this.constants.theme}">
<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">
${loadingTemplate}
</div>
</div>
<div class="fixed-table-footer"></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.$el.find('tfoot')
// 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)
this.$tableLoading.addClass(this.options.classes)
if (this.options.height) {
this.$tableContainer.addClass('fixed-height')
if (this.options.showFooter) {
this.$tableContainer.addClass('has-footer')
}
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')
}
this.$tableFooter = this.$container.find('.fixed-table-footer')
}
}
initTable () {
const columns = []
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._headerTrClasses = []
this._headerTrStyles = []
this.$header.find('tr').each((i, el) => {
const $tr = $(el)
const column = []
$tr.find('th').each((i, el) => {
const $th = $(el)
// #2014: getFieldIndex and elsewhere assume this is string, causes issues if not
if (typeof $th.data('field') !== 'undefined') {
$th.data('field', `${$th.data('field')}`)
}
const _data = Object.assign({}, $th.data())
for (const key in _data) {
if ($.fn.bootstrapTable.columnDefaults.hasOwnProperty(key)) {
delete _data[key]
}
}
column.push(Utils.extend({}, {
_data: Utils.getRealDataAttr(_data),
title: $th.html(),
class: $th.attr('class'),
titleTooltip: $th.attr('title'),
rowspan: $th.attr('rowspan') ? +$th.attr('rowspan') : undefined,
colspan: $th.attr('colspan') ? +$th.attr('colspan') : undefined
}, $th.data()))
})
columns.push(column)
if ($tr.attr('class')) {
this._headerTrClasses.push($tr.attr('class'))
}
if ($tr.attr('style')) {
this._headerTrStyles.push($tr.attr('style'))
}
})
if (!Array.isArray(this.options.columns[0])) {
this.options.columns = [this.options.columns]
}
this.options.columns = Utils.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 = Utils.extend({}, BootstrapTable.COLUMN_DEFAULTS, _column, { passed: _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 and tfoot data
if (!this.options.data.length) {
const htmlData = Utils.trToData(this.columns, this.$el.find('>tbody>tr'))
if (htmlData.length) {
this.options.data = htmlData
this.fromHtml = true
}
}
if (!(this.options.pagination && this.options.sidePagination !== 'server')) {
this.footerData = Utils.trToData(this.columns, this.$el.find('>tfoot>tr'))
}
if (this.footerData) {
this.$el.find('tfoot').html('<tr></tr>')
}
if (!this.options.showFooter || this.options.cardView) {
this.$tableFooter.hide()
} else {
this.$tableFooter.show()
}
}
initHeader () {
const visibleColumns = {}
const headerHtml = []
this.header = {
fields: [],
styles: [],
classes: [],
formatters: [],
detailFormatters: [],
events: [],
sorters: [],
sortNames: [],
cellStyles: [],
searchables: []
}
Utils.updateFieldGroup(this.options.columns, this.columns)
this.options.columns.forEach((columns, i) => {
const html = []
html.push(`<tr${Utils.sprintf(' class="%s"', this._headerTrClasses[i])} ${Utils.sprintf(' style="%s"', this._headerTrStyles[i])}>`)
let detailViewTemplate = ''
if (i === 0 && Utils.hasDetailViewIcon(this.options)) {
const rowspan = this.options.columns.length > 1 ?
` rowspan="${this.options.columns.length}"` : ''
detailViewTemplate = `<th class="detail"${rowspan}>
<div class="fht-cell"></div>
</th>`
}
if (detailViewTemplate && this.options.detailViewAlign !== 'right') {
html.push(detailViewTemplate)
}
columns.forEach((column, j) => {
const class_ = Utils.sprintf(' class="%s"', column['class'])
const unitWidth = column.widthUnit
const width = parseFloat(column.width)
const columnHalign = column.halign ? column.halign : column.align
const halign = Utils.sprintf('text-align: %s; ', columnHalign)
const align = Utils.sprintf('text-align: %s; ', column.align)
let 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' && !column.visible) {
return
}
const headerStyle = Utils.calculateObjectValue(null, this.options.headerStyle, [column])
const csses = []
const data_ = []
let classes = ''
if (headerStyle && headerStyle.css) {
for (const [key, value] of Object.entries(headerStyle.css)) {
csses.push(`${key}: ${value}`)
}
}
if (headerStyle && headerStyle.classes) {
classes = Utils.sprintf(' class="%s"', column['class'] ?
[column['class'], headerStyle.classes].join(' ') : headerStyle.classes)
}
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.detailFormatters[column.fieldIndex] = column.detailFormatter
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
}
if (Object.keys(column._data || {}).length > 0) {
for (const [k, v] of Object.entries(column._data)) {
data_.push(`data-${k}='${typeof v === 'object' ? JSON.stringify(v) : v}'`)
}
}
html.push(`<th${Utils.sprintf(' title="%s"', column.titleTooltip)}`,
column.checkbox || column.radio ?
Utils.sprintf(' class="bs-checkbox %s"', column['class'] || '') :
classes || class_,
Utils.sprintf(' style="%s"', halign + style + csses.join('; ')),
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' : '',
data_.length > 0 ? data_.join(' ') : '',
'>')
html.push(Utils.sprintf('<div class="th-inner %s">',
this.options.sortable && column.sortable ? `sortable${columnHalign === 'center' ? ' sortable-center' : ''} both` : ''))
let text = this.options.escape && this.options.escapeTitle ? Utils.escapeHTML(column.title) : column.title
const title = text
if (column.checkbox) {
text = ''
if (!this.options.singleSelect && this.options.checkboxHeader) {
text = '<label><input name="btSelectAll" type="checkbox" /><span></span></label>'
}
this.header.stateField = column.field
}
if (column.radio) {
text = ''
this.header.stateField = column.field
}
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>')
})
if (detailViewTemplate && this.options.detailViewAlign === 'right') {
html.push(detailViewTemplate)
}
html.push('</tr>')
if (html.length > 3) {
headerHtml.push(html.join(''))
}
})
this.$header.html(headerHtml.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)
}
})
const resizeEvent = Utils.getEventName('resize.bootstrap-table', this.$el.attr('id'))
$(window).off(resizeEvent)
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(resizeEvent, () => this.resetView())
}
this.$selectAll = this.$header.find('[name="btSelectAll"]')
this.$selectAll.off('click').on('click', e => {
e.stopPropagation()
const checked = $(e.currentTarget).prop('checked')
this[checked ? 'checkAll' : 'uncheckAll']()
this.updateSelected()
})
}
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 {
data = data || Utils.deepCopy(this.options.data)
this.options.data = Array.isArray(data) ? data : data[this.options.dataField]
}
this.data = [...this.options.data]
if (this.options.sortReset) {
this.unsortedData = [...this.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]
}
const aa = Utils.getItemField(a, name, this.options.escape)
const 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
}
return Utils.sort(aa, bb, order, this.options, a._position, b._position)
})
}
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)
}
} else if (this.options.sortReset) {
this.data = [...this.unsortedData]
}
}
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')) {
const currentSortOrder = this.options.sortOrder
const initialSortOrder = this.columns[this.fieldsColumnsIndex[$this.data('field')]].sortOrder ||
this.columns[this.fieldsColumnsIndex[$this.data('field')]].order
if (currentSortOrder === undefined) {
this.options.sortOrder = 'asc'
} else if (currentSortOrder === 'asc') {
this.options.sortOrder = this.options.sortReset ? initialSortOrder === 'asc' ? 'desc' : undefined : 'desc'
} else if (this.options.sortOrder === 'desc') {
this.options.sortOrder = this.options.sortReset ? initialSortOrder === 'desc' ? 'asc' : undefined : 'asc'
}
if (this.options.sortOrder === undefined) {
this.options.sortName = undefined
}
} 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')]].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.options.serverSort) {
this.options.pageNumber = 1
this.initServer(this.options.silentSort)
return
}
if (this.options.pagination && this.options.sortResetPage) {
this.options.pageNumber = 1
this.initPagination()
}
this.initSort()
this.initBody()
}
initToolbar () {
const opts = this.options
let html = []
let timeoutId = 0
let $keepOpen
let switchableCount = 0
if (this.$toolbar.find('.bs-bars').children().length) {
$('body').append($(opts.toolbar))
}
this.$toolbar.html('')
if (typeof opts.toolbar === 'string' || typeof opts.toolbar === 'object') {
$(Utils.sprintf('<div class="bs-bars %s-%s"></div>', this.constants.classes.pull, opts.toolbarAlign))
.appendTo(this.$toolbar)
.append($(opts.toolbar))
}
// showColumns, showToggle, showRefresh
html = [`<div class="${[
'columns',
`columns-${opts.buttonsAlign}`,
this.constants.classes.buttonsGroup,
`${this.constants.classes.pull}-${opts.buttonsAlign}`
].join(' ')}">`]
if (typeof opts.buttonsOrder === 'string') {
opts.buttonsOrder = opts.buttonsOrder.replace(/\[|\]| |'/g, '').split(',')
}
this.buttons = Object.assign(this.buttons, {
paginationSwitch: {
text: opts.pagination ? opts.formatPaginationSwitchUp() : opts.formatPaginationSwitchDown(),
icon: opts.pagination ? opts.icons.paginationSwitchDown : opts.icons.paginationSwitchUp,
render: false,
event: this.togglePagination,
attributes: {
'aria-label': opts.formatPaginationSwitch(),
title: opts.formatPaginationSwitch()
}
},
refresh: {
text: opts.formatRefresh(),
icon: opts.icons.refresh,
render: false,
event: this.refresh,
attributes: {
'aria-label': opts.formatRefresh(),
title: opts.formatRefresh()
}
},
toggle: {
text: opts.formatToggleOn(),
icon: opts.icons.toggleOff,
render: false,
event: this.toggleView,
attributes: {
'aria-label': opts.formatToggleOn(),
title: opts.formatToggleOn()
}
},
fullscreen: {
text: opts.formatFullscreen(),
icon: opts.icons.fullscreen,
render: false,
event: this.toggleFullscreen,
attributes: {
'aria-label': opts.formatFullscreen(),
title: opts.formatFullscreen()
}
},
columns: {
render: false,
html: () => {
const html = []
html.push(`<div class="keep-open ${this.constants.classes.buttonsDropdown}" title="${opts.formatColumns()}">
<button class="${this.constants.buttonsClass} dropdown-toggle" type="button" ${this.constants.dataToggle}="dropdown"
aria-label="${opts.formatColumns()}" title="${opts.formatColumns()}">
${opts.showButtonIcons ? Utils.sprintf(this.constants.html.icon, opts.iconsPrefix, opts.icons.columns) : ''}
${opts.showButtonText ? opts.formatColumns() : ''}
${this.constants.html.dropdownCaret}
</button>
${this.constants.html.toolbarDropdown[0]}`)
if (opts.showColumnsSearch) {
html.push(
Utils.sprintf(this.constants.html.toolbarDropdownItem,
Utils.sprintf('<input type="text" class="%s" name="columnsSearch" placeholder="%s" autocomplete="off">', this.constants.classes.input, opts.formatSearch())
)
)
html.push(this.constants.html.toolbarDropdownSeparator)
}
if (opts.showColumnsToggleAll) {
const allFieldsVisible = this.getVisibleColumns().length === this.columns.filter(column => !this.isSelectionColumn(column)).length
html.push(
Utils.sprintf(this.constants.html.toolbarDropdownItem,
Utils.sprintf('<input type="checkbox" class="toggle-all" %s> <span>%s</span>',
allFieldsVisible ? 'checked="checked"' : '', opts.formatColumnsToggleAll())
)
)
html.push(this.constants.html.toolbarDropdownSeparator)
}
let visibleColumns = 0
this.columns.forEach(column => {
if (column.visible) {
visibleColumns++
}
})
this.columns.forEach((column, i) => {
if (this.isSelectionColumn(column)) {
return
}
if (opts.cardView && !column.cardVisible) {
return
}
const checked = column.visible ? ' checked="checked"' : ''
const disabled = visibleColumns <= opts.minimumCountColumns && checked ? ' disabled="disabled"' : ''
if (column.switchable) {
html.push(Utils.sprintf(this.constants.html.toolbarDropdownItem,
Utils.sprintf('<input type="checkbox" data-field="%s" value="%s"%s%s> <span>%s</span>',
column.field, i, checked, disabled, column.title)))
switchableCount++
}
})
html.push(this.constants.html.toolbarDropdown[1], '</div>')
return html.join('')
}
}
})
const buttonsHtml = {}
for (const [buttonName, buttonConfig] of Object.entries(this.buttons)) {
let buttonHtml
if (buttonConfig.hasOwnProperty('html')) {
if (typeof buttonConfig.html === 'function') {
buttonHtml = buttonConfig.html()
} else if (typeof buttonConfig.html === 'string') {
buttonHtml = buttonConfig.html
}
} else {
buttonHtml = `<button class="${this.constants.buttonsClass}" type="button" name="${buttonName}"`
if (buttonConfig.hasOwnProperty('attributes')) {
for (const [attributeName, value] of Object.entries(buttonConfig.attributes)) {
buttonHtml += ` ${attributeName}="${value}"`
}
}
buttonHtml += '>'
if (opts.showButtonIcons && buttonConfig.hasOwnProperty('icon')) {
buttonHtml += `${Utils.sprintf(this.constants.html.icon, opts.iconsPrefix, buttonConfig.icon)} `
}
if (opts.showButtonText && buttonConfig.hasOwnProperty('text')) {
buttonHtml += buttonConfig.text
}
buttonHtml += '</button>'
}
buttonsHtml[buttonName] = buttonHtml
const optionName = `show${buttonName.charAt(0).toUpperCase()}${buttonName.substring(1)}`
const showOption = opts[optionName]
if ((
!buttonConfig.hasOwnProperty('render') ||
buttonConfig.hasOwnProperty('render') &&
buttonConfig.render) &&
(showOption === undefined || showOption === true)
) {
opts[optionName] = true
}
if (!opts.buttonsOrder.includes(buttonName)) {
opts.buttonsOrder.push(buttonName)
}
}
// Adding the button html to the final toolbar html when the showOption is true
for (const button of opts.buttonsOrder) {
const showOption = opts[`show${button.charAt(0).toUpperCase()}${button.substring(1)}`]
if (showOption) {
html.push(buttonsHtml[button])
}
}
html.push('</div>')
// Fix #188: this.showToolbar is for extensions
if (this.showToolbar || html.length > 2) {
this.$toolbar.append(html.join(''))
}
for (const [buttonName, buttonConfig] of Object.entries(this.buttons)) {
if (buttonConfig.hasOwnProperty('event')) {
if (typeof buttonConfig.event === 'function' || typeof buttonConfig.event === 'string') {
const event = typeof buttonConfig.event === 'string' ? window[buttonConfig.event] : buttonConfig.event
this.$toolbar.find(`button[name="${buttonName}"]`)
.off('click')
.on('click', () => event.call(this))
continue
}
for (const [eventType, eventFunction] of Object.entries(buttonConfig.event)) {
const event = typeof eventFunction === 'string' ? window[eventFunction] : eventFunction
this.$toolbar.find(`button[name="${buttonName}"]`)
.off(eventType)
.on(eventType, () => event.call(this))
}
}
}
if (opts.showColumns) {
$keepOpen = this.$toolbar.find('.keep-open')
const $checkboxes = $keepOpen.find('input[type="checkbox"]:not(".toggle-all")')
const $toggleAll = $keepOpen.find('input[type="checkbox"].toggle-all')
if (switchableCount <= opts.minimumCountColumns) {
$keepOpen.find('input').prop('disabled', true)
}
$keepOpen.find('li, label').off('click').on('click', e => {
e.stopImmediatePropagation()
})
$checkboxes.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'))
$toggleAll.prop('checked', $checkboxes.filter(':checked').length === this.columns.filter(column => !this.isSelectionColumn(column)).length)
})
$toggleAll.off('click').on('click', ({ currentTarget }) => {
this._toggleAllColumns($(currentTarget).prop('checked'))
this.trigger('column-switch-all', $(currentTarget).prop('checked'))
})
if (opts.showColumnsSearch) {
const $columnsSearch = $keepOpen.find('[name="columnsSearch"]')
const $listItems = $keepOpen.find('.dropdown-item-marker')
$columnsSearch.on('keyup paste change', ({ currentTarget }) => {
const $this = $(currentTarget)
const searchValue = $this.val().toLowerCase()
$listItems.show()
$checkboxes.each((i, el) => {
const $checkbox = $(el)
const $listItem = $checkbox.parents('.dropdown-item-marker')
const text = $listItem.text().toLowerCase()
if (!text.includes(searchValue)) {
$listItem.hide()
}
})
})
}
}
const handleInputEvent = $searchInput => {
const eventTriggers = 'keyup drop blur mouseup'
$searchInput.off(eventTriggers).on(eventTriggers, event => {
if (opts.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({ currentTarget: event.currentTarget })
}, opts.searchTimeOut)
})
}
// Fix #4516: this.showSearchClearButton is for extensions
if (
(opts.search || this.showSearchClearButton) &&
typeof opts.searchSelector !== 'string'
) {
html = []
const showSearchButton = Utils.sprintf(this.constants.html.searchButton,
this.constants.buttonsClass,
opts.formatSearch(),
opts.showButtonIcons ? Utils.sprintf(this.constants.html.icon, opts.iconsPrefix, opts.icons.search) : '',
opts.showButtonText ? opts.formatSearch() : ''
)
const showSearchClearButton = Utils.sprintf(this.constants.html.searchClearButton,
this.constants.buttonsClass,
opts.formatClearSearch(),
opts.showButtonIcons ? Utils.sprintf(this.constants.html.icon, opts.iconsPrefix, opts.icons.clearSearch) : '',
opts.showButtonText ? opts.formatClearSearch() : ''
)
const searchInputHtml = `<input class="${this.constants.classes.input}
${Utils.sprintf(' %s%s', this.constants.classes.inputPrefix, opts.iconSize)}
search-input" type="search" aria-label="${opts.formatSearch()}" placeholder="${opts.formatSearch()}" autocomplete="off">`
let searchInputFinalHtml = searchInputHtml
if (opts.showSearchButton || opts.showSearchClearButton) {
const buttonsHtml = (opts.showSearchButton ? showSearchButton : '') +
(opts.showSearchClearButton ? showSearchClearButton : '')
searchInputFinalHtml = opts.search ? Utils.sprintf(this.constants.html.inputGroup,
searchInputHtml, buttonsHtml) : buttonsHtml
}
html.push(Utils.sprintf(`
<div class="${this.constants.classes.pull}-${opts.searchAlign} search ${this.constants.classes.inputGroup}">
%s
</div>
`, searchInputFinalHtml))
this.$toolbar.append(html.join(''))
const $searchInput = Utils.getSearchInput(this)
if (opts.showSearchButton) {
this.$toolbar.find('.search button[name=search]').off('click').on('click', () => {
clearTimeout(timeoutId) // doesn't matter if it's 0
timeoutId = setTimeout(() => {
this.onSearch({ currentTarget: $searchInput })
}, opts.searchTimeOut)
})
if (opts.searchOnEnterKey) {
handleInputEvent($searchInput)
}
} else {
handleInputEvent($searchInput)
}
if (opts.showSearchClearButton) {
this.$toolbar.find('.search button[name=clearSearch]').click(() => {
this.resetSearch()
})
}
} else if (typeof opts.searchSelector === 'string') {
const $searchInput = Utils.getSearchInput(this)
handleInputEvent($searchInput)
}
}
onSearch ({ currentTarget, firedByInitSearchText } = {}, overwriteSearchText = true) {
if (currentTarget !== undefined && $(currentTarget).length && overwriteSearchText) {
const text = $(currentTarget).val().trim()
if (this.options.trimOnSearch && $(currentTarget).val() !== text) {
$(currentTarget).val(text)
}
if (this.searchText === text) {
return
}
const $searchInput = Utils.getSearchInput(this)
const $currentTarget = currentTarget instanceof jQuery ? currentTarget : $(currentTarget)
if ($currentTarget.is($searchInput) || $currentTarget.hasClass('search-input')) {
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', this.searchText)
}
initSearch () {
this.filterOptions = this.filterOptions || this.options.filterOptions
if (this.options.sidePagination !== 'server') {
if (this.options.customSearch) {
this.data = Utils.calculateObjectValue(this.options, this.options.customSearch,
[this.options.data, this.searchText, this.filterColumns])
if (this.options.sortReset) {
this.unsortedData = [...this.data]
}
this.initSort()
return
}
const rawSearchText = this.searchText && (this.fromHtml ? Utils.escapeHTML(this.searchText) : this.searchText)
let searchText = rawSearchText ? rawSearchText.toLowerCase() : ''
const f = Utils.isEmptyObject(this.filterColumns) ? null : this.filterColumns
if (this.options.searchAccentNeutralise) {
searchText = Utils.normalizeAccent(searchText)
}
// Check filter
if (typeof this.filterOptions.filterAlgorithm === 'function') {
this.data = this.options.data.filter(item => this.filterOptions.filterAlgorithm.apply(null, [item, f]))
} else if (typeof this.filterOptions.filterAlgorithm === 'string') {
this.data = f ? this.options.data.filter(item => {
const filterAlgorithm = this.filterOptions.filterAlgorithm
if (filterAlgorithm === 'and') {
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
}
}
} else if (filterAlgorithm === 'or') {
let match = false
for (const key in f) {
if (
Array.isArray(f[key]) &&
f[key].includes(item[key]) ||
!Array.isArray(f[key]) &&
item[key] === f[key]
) {
match = true
}
}
return match
}
return true
}) : [...this.options.data]
}
const visibleFields = this.getVisibleFields()
this.data = searchText ? this.data.filter((item, i) => {
for (let j = 0; j < this.header.fields.length; j++) {
if (!this.header.searchables[j] || this.options.visibleSearch && visibleFields.indexOf(this.header.fields[j]) === -1) {
continue
}
const key = Utils.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 = null
break
}
}
} else {
value = item[key]
}
if (this.options.searchAccentNeutralise) {
value = Utils.normalizeAccent(value)
}
// Fix #142: respect searchFormatter boolean
if (column && column.searchFormatter) {
value = Utils.calculateObjectValue(column,
this.header.formatters[j], [value, item, i, column.field], value)
}
if (typeof value === 'string' || typeof value === 'number') {
if (
this.options.strictSearch && `${value}`.toLowerCase() === searchText ||
this.options.regexSearch && Utils.regexCompare(value, rawSearchText)
) {
return true
}
const largerSmallerEqualsRegex = /(?:(<=|=>|=<|>=|>|<)(?:\s+)?(-?\d+)?|(-?\d+)?(\s+)?(<=|=>|=<|>=|>|<))/gm
const matches = largerSmallerEqualsRegex.exec(this.searchText)
let comparisonCheck = false
if (matches) {
const operator = matches[1] || `${matches[5]}l`
const comparisonValue = matches[2] || matches[3]
const int = parseInt(value, 10)
const comparisonInt = parseInt(comparisonValue, 10)
switch (operator) {
case '>':
case '<l':
comparisonCheck = int > comparisonInt
break
case '<':
case '>l':
comparisonCheck = int < comparisonInt
break
case '<=':
case '=<':
case '>=l':
case '=>l':
comparisonCheck = int <= comparisonInt
break
case '>=':
case '=>':
case '<=l':
case '=<l':
comparisonCheck = int >= comparisonInt
break
default:
break
}
}
if (comparisonCheck || `${value}`.toLowerCase().includes(searchText)) {
return true
}
}
}
return false
}) : this.data
if (this.options.sortReset) {
this.unsortedData = [...this.data]
}
this.initSort()
}
}
initPagination () {
const opts = this.options
if (!opts.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({ includeHiddenRows: false })
let pageList = opts.pageList
if (typeof pageList === 'string') {
pageList = pageList.replace(/\[|\]| /g, '').toLowerCase().split(',')
}
pageList = pageList.map(value => {
if (typeof value === 'string') {
return value.toLowerCase() === opts.formatAllRows().toLowerCase() ||
['all', 'unlimited'].includes(value.toLowerCase()) ? opts.formatAllRows() : +value
}
return value
})
this.paginationParts = opts.paginationParts
if (typeof this.paginationParts === 'string') {
this.paginationParts = this.paginationParts.replace(/\[|\]| |'/g, '').split(',')
}
if (opts.sidePagination !== 'server') {
opts.totalRows = data.length
}
this.totalPages = 0
if (opts.totalRows) {
if (opts.pageSize === opts.formatAllRows()) {
opts.pageSize = opts.totalRows
allSelected = true
}
this.totalPages = ~~((opts.totalRows - 1) / opts.pageSize) + 1
opts.totalPages = this.totalPages
}
if (this.totalPages > 0 && opts.pageNumber > this.totalPages) {
opts.pageNumber = this.totalPages
}
this.pageFrom = (opts.pageNumber - 1) * opts.pageSize + 1
this.pageTo = opts.pageNumber * opts.pageSize
if (this.pageTo > opts.totalRows) {
this.pageTo = opts.totalRows
}
if (this.options.pagination && this.options.sidePagination !== 'server') {
this.options.totalNotFiltered = this.options.data.length
}
if (!this.options.showExtendedPagination) {
this.options.totalNotFiltered = undefined
}
if (this.paginationParts.includes('pageInfo') || this.paginationParts.includes('pageInfoShort') || this.paginationParts.includes('pageSize')) {
html.push(`<div class="${this.constants.classes.pull}-${opts.paginationDetailHAlign} pagination-detail">`)
}
if (this.paginationParts.includes('pageInfo') || this.paginationParts.includes('pageInfoShort')) {
const paginationInfo = this.paginationParts.includes('pageInfoShort') ? opts.formatDetailPagination(opts.totalRows) : opts.formatShowingRows(this.pageFrom, this.pageTo, opts.totalRows, opts.totalNotFiltered)
html.push(`<span class="pagination-info">
${paginationInfo}
</span>`)
}
if (this.paginationParts.includes('pageSize')) {
html.push('<div class="page-list">')
const pageNumber = [
`<div class="${this.constants.classes.paginationDropdown}">
<button class="${this.constants.buttonsClass} dropdown-toggle" type="button" ${this.constants.dataToggle}="dropdown">
<span class="page-size">
${allSelected ? opts.formatAllRows() : opts.pageSize}
</span>
${this.constants.html.dropdownCaret}
</button>
${this.constants.html.pageDropdown[0]}`
]
pageList.forEach((page, i) => {
if (!opts.smartDisplay || i === 0 || pageList[i - 1] < opts.totalRows || page === opts.formatAllRows()) {
let active
if (allSelected) {
active = page === opts.formatAllRows() ? this.constants.classes.dropdownActive : ''
} else {
active = page === opts.pageSize ? this.constants.classes.dropdownActive : ''
}
pageNumber.push(Utils.sprintf(this.constants.html.pageDropdownItem, active, page))
}
})
pageNumber.push(`${this.constants.html.pageDropdown[1]}</div>`)
html.push(opts.formatRecordsPerPage(pageNumber.join('')))
}
if (this.paginationParts.includes('pageInfo') || this.paginationParts.includes('pageInfoShort') || this.paginationParts.includes('pageSize')) {
html.push('</div></div>')
}
if (this.paginationParts.includes('pageList')) {
html.push(`<div class="${this.constants.classes.pull}-${opts.paginationHAlign} pagination">`,
Utils.sprintf(this.constants.html.pagination[0], Utils.sprintf(' pagination-%s', opts.iconSize)),
Utils.sprintf(this.constants.html.paginationItem, ' page-pre', opts.formatSRPaginationPreText(), opts.paginationPreText))
if (this.totalPages < opts.paginationSuccessivelySize) {
from = 1
to = this.totalPages
} else {
from = opts.pageNumber - opts.paginationPagesBySide
to = from + opts.paginationPagesBySide * 2
}
if (opts.pageNumber < opts.paginationSuccessivelySize - 1) {
to = opts.paginationSuccessivelySize
}
if (opts.paginationSuccessivelySize > this.totalPages - from) {
from = from - (opts.paginationSuccessivelySize - (this.totalPages - from)) + 1
}
if (from < 1) {
from = 1
}
if (to > this.totalPages) {
to = this.totalPages
}
const middleSize = Math.round(opts.paginationPagesBySide / 2)
const pageItem = (i, classes = '') => Utils.sprintf(this.constants.html.paginationItem,
classes + (i === opts.pageNumber ? ` ${this.constants.classes.paginationActive}` : ''), opts.formatSRPaginationPageText(i), i)
if (from > 1) {
let max = opts.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 - opts.paginationPagesBySide * 2 > opts.paginationPagesBySide &&
opts.paginationUseIntermediate
) {
i = Math.round((from - middleSize) / 2 + middleSize)
html.push(pageItem(i, ' page-intermediate'))
} else {
html.push(Utils.sprintf(this.constants.html.paginationItem,
' page-first-separator disabled', '', '...'))
}
}
}
for (i = from; i <= to; i++) {
html.push(pageItem(i))
}
if (this.totalPages > to) {
let min = this.totalPages - (opts.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 > opts.paginationPagesBySide * 2 &&
opts.paginationUseIntermediate
) {
i = Math.round((this.totalPages - middleSize - to) / 2 + to)
html.push(pageItem(i, ' page-intermediate'))
} else {
html.push(Utils.sprintf(this.constants.html.paginationItem,
' page-last-separator disabled', '', '...'))
}
}
for (i = min; i <= this.totalPages; i++) {
html.push(pageItem(i))
}
}
html.push(Utils.sprintf(this.constants.html.paginationItem, ' page-next', opts.formatSRPaginationNextText(), opts.paginationNextText))
html.push(this.constants.html.pagination[1], '</div>')
}
this.$pagination.html(html.join(''))
const dropupClass = ['bottom', 'both'].includes(opts.paginationVAlign) ?
` ${this.constants.classes.dropup}` : ''
this.$pagination.last().find('.page-list > div').addClass(dropupClass)
if (!opts.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, .page-last-separator, .page-first-separator')
if (this.totalPages <= 1) {
this.$pagination.find('div.pagination').hide()
}
if (opts.smartDisplay) {
if (pageList.length < 2 || opts.totalRows <= pageList[0]) {
this.$pagination.find('div.page-list').hide()
}
}
// when data is empty, hide the pagination
this.$pagination[this.getData().length ? 'show' : 'hide']()
if (!opts.paginationLoop) {
if (opts.pageNumber === 1) {
$pre.addClass('disabled')
}
if (opts.pageNumber === this.totalPages) {
$next.addClass('disabled')
}
}
if (allSelected) {
opts.pageSize = opts.formatAllRows()
}
// removed the events for last and first, onPageNumber executeds the same logic
$pageList.off('click').on('click', e => this.onPageListChange(e))
$pre.off('click').on('click', e => this.onPagePre(e))
$next.off('click').on('click', e => this.onPageNext(e))
$number.off('click').on('click', e => this.onPageNumber(e))
}
}
updatePagination (event) {
// Fix #171: IE disabled button can be clicked bug.
if (event && $(event.currentTarget).hasClass('disabled')) {
return
}
if (!this.options.maintainMetaData) {
this.resetRows()
}
this.initPagination()
this.trigger('page-change', this.options.pageNumber, this.options.pageSize)
if (this.options.sidePagination === 'server') {
this.initServer()
} else {
this.initBody()
}
}
onPageListChange (event) {
event.preventDefault()
const $this = $(event.currentTarget)
$this.parent().addClass(this.constants.classes.dropdownActive)
.siblings().removeClass(this.constants.classes.dropdownActive)
this.options.pageSize = $this.text().toUpperCase() === this.options.formatAllRows().toUpperCase() ?
this.options.formatAllRows() : +$this.text()
this.$toolbar.find('.page-size').text(this.options.pageSize)
this.updatePagination(event)
return false
}
onPagePre (event) {
if ($(event.target).hasClass('disabled')) {
return
}
event.preventDefault()
if (this.options.pageNumber - 1 === 0) {
this.options.pageNumber = this.options.totalPages
} else {
this.options.pageNumber--
}
this.updatePagination(event)
return false
}
onPageNext (event) {
if ($(event.target).hasClass('disabled')) {
return
}
event.preventDefault()
if (this.options.pageNumber + 1 > this.options.totalPages) {
this.options.pageNumber = 1
} else {
this.options.pageNumber++
}
this.updatePagination(event)
return false
}
onPageNumber (event) {
event.preventDefault()
if (this.options.pageNumber === +$(event.currentTarget).text()) {
return
}
this.options.pageNumber = +$(event.currentTarget).text()
this.updatePagination(event)
return false
}
// eslint-disable-next-line no-unused-vars
initRow (item, i, data, trFragments) {
const html = []
let style = {}
const csses = []
let data_ = ''
let attributes = {}
const htmlAttributes = []
if (Utils.findIndex(this.hiddenRows, item) > -1) {
return
}
style = Utils.calculateObjectValue(this.options, this.options.rowStyle, [item, i], style)
if (style && style.css) {
for (const [key, value] of Object.entries(style.css)) {
csses.push(`${key}: ${value}`)
}
}
attributes = Utils.calculateObjectValue(this.options,
this.options.rowAttributes, [item, i], attributes)
if (attributes) {
for (const [key, value] of Object.entries(attributes)) {
htmlAttributes.push(`${key}="${Utils.escapeHTML(value)}"`)
}
}
if (item._data && !Utils.isEmptyObject(item._data)) {
for (const [k, v] of Object.entries(item._data)) {
// ignore data-index
if (k === 'index') {
return
}
data_ += ` data-${k}='${typeof v === 'object' ? JSON.stringify(v) : v}'`
}
}
html.push('<tr',
Utils.sprintf(' %s', htmlAttributes.length ? htmlAttributes.join(' ') : undefined),
Utils.sprintf(' id="%s"', Array.isArray(item) ? undefined : item._id),
Utils.sprintf(' class="%s"', style.classes || (Array.isArray(item) ? undefined : item._class)),
Utils.sprintf(' style="%s"', Array.isArray(item) ? undefined : item._style),
` data-index="${i}"`,
Utils.sprintf(' data-uniqueid="%s"', Utils.getItemField(item, this.options.uniqueId, false)),
Utils.sprintf(' data-has-detail-view="%s"', this.options.detailView && Utils.calculateObjectValue(null, this.options.detailFilter, [i, item]) ? 'true' : undefined),
Utils.sprintf('%s', data_),
'>'
)
if (this.options.cardView) {
html.push(`<td colspan="${this.header.fields.length}"><div class="card-views">`)
}
let detailViewTemplate = ''
if (Utils.hasDetailViewIcon(this.options)) {
detailViewTemplate = '<td>'
if (Utils.calculateObjectValue(null, this.options.detailFilter, [i, item])) {
detailViewTemplate += `
<a class="detail-icon" href="#">
${Utils.sprintf(this.constants.html.icon, this.options.iconsPrefix, this.options.icons.detailOpen)}
</a>
`
}
detailViewTemplate += '</td>'
}
if (detailViewTemplate && this.options.detailViewAlign !== 'right') {
html.push(detailViewTemplate)
}
this.header.fields.forEach((field, j) => {
const column = this.columns[j]
let text = ''
const value_ = Utils.getItemField(item, field, this.options.escape, column.escape)
let value = ''
let type = ''
let cellStyle = {}
let id_ = ''
let class_ = this.header.classes[j]
let style_ = ''
let styleToAdd_ = ''
let data_ = ''
let rowspan_ = ''
let colspan_ = ''
let title_ = ''
if ((this.fromHtml || this.autoMergeCells) && typeof value_ === 'undefined') {
if (!column.checkbox && !column.radio) {
return
}
}
if (!column.visible) {
return
}
if (this.options.cardView && !column.cardVisible) {
return
}
// Style concat
if (csses.concat([this.header.styles[j]]).length) {
styleToAdd_ += `${csses.concat([this.header.styles[j]]).join('; ')}`
}
if (item[`_${field}_style`]) {
styleToAdd_ += `${item[`_${field}_style`]}`
}
if (styleToAdd_) {
style_ = ` style="${styleToAdd_}"`
}
// Style concat
// handle id and class of td
if (item[`_${field}_id`]) {
id_ = Utils.sprintf(' id="%s"', item[`_${field}_id`])
}
if (item[`_${field}_class`]) {
class_ = Utils.sprintf(' class="%s"', item[`_${field}_class`])
}
if (item[`_${field}_rowspan`]) {
rowspan_ = Utils.sprintf(' rowspan="%s"', item[`_${field}_rowspan`])
}
if (item[`_${field}_colspan`]) {
colspan_ = Utils.sprintf(' colspan="%s"', item[`_${field}_colspan`])
}
if (item[`_${field}_title`]) {
title_ = Utils.sprintf(' title="%s"', item[`_${field}_title`])
}
cellStyle = Utils.calculateObjectValue(this.header,
this.header.cellStyles[j], [value_, item, i, field], cellStyle)
if (cellStyle.classes) {
class_ = ` class="${cellStyle.classes}"`
}
if (cellStyle.css) {
const csses_ = []
for (const [key, value] of Object.entries(cellStyle.css)) {
csses_.push(`${key}: ${value}`)
}
style_ = ` style="${csses_.concat(this.header.styles[j]).join('; ')}"`
}
value = Utils.calculateObjectValue(column,
this.header.formatters[j], [value_, item, i, field], value_)
if (!(column.checkbox || column.radio)) {
value = typeof value === 'undefined' || value === null ?
this.options.undefinedText : value
}
if (column.searchable && this.searchText && this.options.searchHighlight && !(column.checkbox || column.radio)) {
let defValue = ''
let searchText = this.searchText.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')
if (this.options.searchAccentNeutralise) {
const indexRegex = new RegExp(`${Utils.normalizeAccent(searchText)}`, 'gmi')
const match = indexRegex.exec(Utils.normalizeAccent(value))
if (match) {
searchText = value.substring(match.index, match.index + searchText.length)
}
}
const regExp = new RegExp(`(${searchText})`, 'gim')
const marker = '<mark>$1</mark>'
const isHTML = value && /<(?=.*? .*?\/ ?>|br|hr|input|!--|wbr)[a-z]+.*?>|<([a-z]+).*?<\/\1>/i.test(value)
if (isHTML) {
// value can contains a HTML tags
let textContent = new DOMParser().parseFromString(value.toString(), 'text/html').documentElement.textContent
const textReplaced = textContent.replace(regExp, marker)
textContent = textContent.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')
defValue = value.replace(new RegExp(`(>\\s*)(${textContent})(\\s*)`, 'gm'), `$1${textReplaced}$3`)
} else {
// but usually not
defValue = value.toString().replace(regExp, marker)
}
value = Utils.calculateObjectValue(column, column.searchHighlightFormatter, [value, this.searchText], defValue)
}
if (item[`_${field}_data`] && !Utils.isEmptyObject(item[`_${field}_data`])) {
for (const [k, v] of Object.entries(item[`_${field}_data`])) {
// ignore data-index
if (k === 'index') {
return
}
data_ += ` data-${k}="${v}"`
}
}
if (column.checkbox || column.radio) {
type = column.checkbox ? 'checkbox' : type
type = column.radio ? 'radio' : type
const c = column['class'] || ''
const isChecked = Utils.isObject(value) && value.hasOwnProperty('checked') ?
value.checked : (value === true || value_) && value !== false
const isDisabled = !column.checkboxEnabled || value && value.disabled
text = [
this.options.cardView ?
`<div class="card-view ${c}">` :
`<td class="bs-checkbox ${c}"${class_}${style_}>`,
`<label>
<input
data-index="${i}"
name="${this.options.selectItemName}"
type="${type}"
${Utils.sprintf('value="%s"', item[this.options.idField])}
${Utils.sprintf('checked="%s"', isChecked ? 'checked' : undefined)}
${Utils.sprintf('disabled="%s"', isDisabled ? 'disabled' : undefined)} />
<span></span>
</label>`,
this.header.formatters[j] && typeof value === 'string' ? value : '',
this.options.cardView ? '</div>' : '</td>'
].join('')
item[this.header.stateField] = value === true || (!!value_ || value && value.checked)
} else if (this.options.cardView) {
const cardTitle = this.options.showHeader ?
`<span class="card-view-title ${cellStyle.classes || ''}"${style_}>${Utils.getFieldTitle(this.columns, field)}</span>` : ''
text = `<div class="card-view">${cardTitle}<span class="card-view-value ${cellStyle.classes || ''}"${style_}>${value}</span></div>`
if (this.options.smartDisplay && value === '') {
text = '<div class="card-view"></div>'
}
} else {
text = `<td${id_}${class_}${style_}${data_}${rowspan_}${colspan_}${title_}>${value}</td>`
}
html.push(text)
})
if (detailViewTemplate && this.options.detailViewAlign === 'right') {
html.push(detailViewTemplate)
}
if (this.options.cardView) {
html.push('</div></td>')
}
html.push('</tr>')
return html.join('')
}
initBody (fixedScroll, updatedUid) {
const data = this.getData()
this.trigger('pre-body', data)
this.$body = this.$el.find('>tbody')
if (!this.$body.length) {
this.$body = $('<tbody></tbody>').appendTo(this.$el)
}
// Fix #389 Bootstrap-table-flatJSON is not working
if (!this.options.pagination || this.options.sidePagination === 'server') {
this.pageFrom = 1
this.pageTo = data.length
}
const rows = []
const trFragments = $(document.createDocumentFragment())
let hasTr = false
const toExpand = []
this.autoMergeCells = Utils.checkAutoMergeCells(data.slice(this.pageFrom - 1, this.pageTo))
for (let i = this.pageFrom - 1; i < this.pageTo; i++) {
const item = data[i]
let tr = this.initRow(item, i, data, trFragments)
hasTr = hasTr || !!tr
if (tr && typeof tr === 'string') {
const uniqueId = this.options.uniqueId
if (uniqueId && item.hasOwnProperty(uniqueId)) {
const itemUniqueId = item[uniqueId]
const oldTr = this.$body.find(Utils.sprintf('> tr[data-uniqueid="%s"][data-has-detail-view]', itemUniqueId))
const oldTrNext = oldTr.next()
if (oldTrNext.is('tr.detail-view')) {
toExpand.push(i)
if (!updatedUid || itemUniqueId !== updatedUid) {
tr += oldTrNext[0].outerHTML
}
}
}
if (!this.options.virtualScroll) {
trFragments.append(tr)
} else {
rows.push(tr)
}
}
}
// show no records
if (!hasTr) {
this.$body.html(`<tr class="no-records-found">${Utils.sprintf('<td colspan="%s">%s</td>',
this.getVisibleFields().length + Utils.getDetailViewIndexOffset(this.options),
this.options.formatNoMatches())}</tr>`)
} else if (!this.options.virtualScroll) {
this.$body.html(trFragments)
} else {
if (this.virtualScroll) {
this.virtualScroll.destroy()
}
this.virtualScroll = new VirtualScroll({
rows,
fixedScroll,
scrollEl: this.$tableBody[0],
contentEl: this.$body[0],
itemHeight: this.options.virtualScrollItemHeight,
callback: (startIndex, endIndex) => {
this.fitHeader()
this.initBodyEvent()
this.trigger('virtual-scroll', startIndex, endIndex)
}
})
}
toExpand.forEach(index => {
this.expandRow(index)
})
if (!fixedScroll) {
this.scrollTo(0)
}
this.initBodyEvent()
this.initFooter()
this.resetView()
this.updateSelected()
if (this.options.sidePagination !== 'server') {
this.options.totalRows = data.length
}
this.trigger('post-body', data)
}
initBodyEvent () {
// click to select by column
this.$body.find('> tr[data-index] > td').off('click dblclick').on('click dblclick', e => {
const $td = $(e.currentTarget)
if (
$td.find('.detail-icon').length ||
$td.index() - Utils.getDetailViewIndexOffset(this.options) < 0
) {
return
}
const $tr = $td.parent()
const $cardViewArr = $(e.target).parents('.card-views').children()
const $cardViewTarget = $(e.target).parents('.card-view')
const rowIndex = $tr.data('index')
const item = this.data[rowIndex]
const index = this.options.cardView ? $cardViewArr.index($cardViewTarget) : $td[0].cellIndex
const fields = this.getVisibleFields()
const field = fields[index - Utils.getDetailViewIndexOffset(this.options)]
const column = this.columns[this.fieldsColumnsIndex[field]]
const value = Utils.getItemField(item, field, this.options.escape, column.escape)
this.trigger(e.type === 'click' ? 'click-cell' : 'dbl-click-cell', field, value, item, $td)
this.trigger(e.type === 'click' ? 'click-row' : 'dbl-click-row', item, $tr, field)
// if click to select - then trigger the checkbox/radio click
if (
e.type === 'click' &&
this.options.clickToSelect &&
column.clickToSelect &&
!Utils.calculateObjectValue(this.options, this.options.ignoreClickToSelectOn, [e.target])
) {
const $selectItem = $tr.find(Utils.sprintf('[name="%s"]', this.options.selectItemName))
if ($selectItem.length) {
$selectItem[0].click()
}
}
if (e.type === 'click' && this.options.detailViewByClick) {
this.toggleDetailView(rowIndex, this.header.detailFormatters[this.fieldsColumnsIndex[field]])
}
}).off('mousedown').on('mousedown', e => {
// https://github.com/jquery/jquery/issues/1741
this.multipleSelectRowCtrlKey = e.ctrlKey || e.metaKey
this.multipleSelectRowShiftKey = e.shiftKey
})
this.$body.find('> tr[data-index] > td > .detail-icon').off('click').on('click', e => {
e.preventDefault()
this.toggleDetailView($(e.currentTarget).parent().parent().data('index'))
return false
})
this.$selectItem = this.$body.find(Utils.sprintf('[name="%s"]', this.options.selectItemName))
this.$selectItem.off('click').on('click', e => {
e.stopImmediatePropagation()
const $this = $(e.currentTarget)
this._toggleCheck($this.prop('checked'), $this.data('index'))
})
this.header.events.forEach((_events, i) => {
let events = _events
if (!events) {
return
}
// fix bug, if events is defined with namespace
if (typeof events === 'string') {
events = Utils.calculateObjectValue(null, events)
}
if (!events) {
throw new Error(`Unknown event in the scope: ${_events}`)
}
const field = this.header.fields[i]
let fieldIndex = this.getVisibleFields().indexOf(field)
if (fieldIndex === -1) {
return
}
fieldIndex += Utils.getDetailViewIndexOffset(this.options)
for (const key in events) {
if (!events.hasOwnProperty(key)) {
continue
}
const event = events[key]
this.$body.find('>tr:not(.no-records-found)').each((i, tr) => {
const $tr = $(tr)
const $td = $tr.find(this.options.cardView ? '.card-views>.card-view' : '>td').eq(fieldIndex)
const index = key.indexOf(' ')
const name = key.substring(0, index)
const el = key.substring(index + 1)
$td.find(el).off(name).on(name, e => {
const index = $tr.data('index')
const row = this.data[index]
const value = row[field]
event.apply(this, [e, value, row, index])
})
})
}
})
}
initServer (silent, query, url) {
let data = {}
const index = this.header.fields.indexOf(this.options.sortName)
let params = {
searchText: this.searchText,
sortName: this.options.sortName,
sortOrder: this.options.sortOrder
}
if (this.header.sortNames[index]) {
params.sortName = this.header.sortNames[index]
}
if (this.options.pagination && this.options.sidePagination === 'server') {
params.pageSize = this.options.pageSize === this.options.formatAllRows() ?
this.options.totalRows : this.options.pageSize
params.pageNumber = this.options.pageNumber
}
if (!(url || this.options.url) && !this.options.ajax) {
return
}
if (this.options.queryParamsType === 'limit') {
params = {
search: params.searchText,
sort: params.sortName,
order: params.sortOrder
}
if (this.options.pagination && this.options.sidePagination === 'server') {
params.offset = this.options.pageSize === this.options.formatAllRows() ?
0 : this.options.pageSize * (this.options.pageNumber - 1)
params.limit = this.options.pageSize
if (params.limit === 0 || this.options.pageSize === this.options.formatAllRows()) {
delete params.limit
}
}
}
if (
this.options.search &&
this.options.sidePagination === 'server' &&
this.columns.filter(column => column.searchable).length
) {
params.searchable = []
for (const column of this.columns) {
if (
!column.checkbox &&
column.searchable &&
(
this.options.visibleSearch &&
column.visible ||
!this.options.visibleSearch
)
) {
params.searchable.push(column.field)
}
}
}
if (!Utils.isEmptyObject(this.filterColumnsPartial)) {
params.filter = JSON.stringify(this.filterColumnsPartial, null)
}
Utils.extend(params, query || {})
data = Utils.calculateObjectValue(this.options, this.options.queryParams, [params], data)
// false to stop request
if (data === false) {
return
}
if (!silent) {
this.showLoading()
}
const request = Utils.extend({}, Utils.calculateObjectValue(null, this.options.ajaxOptions), {
type: this.options.method,
url: url || this.options.url,
data: this.options.contentType === 'application/json' && this.options.method === 'post' ?
JSON.stringify(data) : data,
cache: this.options.cache,
contentType: this.options.contentType,
dataType: this.options.dataType,
success: (_res, textStatus, jqXHR) => {
const res = Utils.calculateObjectValue(this.options,
this.options.responseHandler, [_res, jqXHR], _res)
this.load(res)
this.trigger('load-success', res, jqXHR && jqXHR.status, jqXHR)
if (!silent) {
this.hideLoading()
}
if (
this.options.sidePagination === 'server' &&
this.options.pageNumber > 1 &&
res[this.options.totalField] > 0 &&
!res[this.options.dataField].length
) {
this.updatePagination()
}
},
error: jqXHR => {
// abort ajax by multiple request
if (jqXHR && jqXHR.status === 0 && this._xhrAbort) {
this._xhrAbort = false
return
}
let data = []
if (this.options.sidePagination === 'server') {
data = {}
data[this.options.totalField] = 0
data[this.options.dataField] = []
}
this.load(data)
this.trigger('load-error', jqXHR && jqXHR.status, jqXHR)
if (!silent) {
this.hideLoading()
}
}
})
if (this.options.ajax) {
Utils.calculateObjectValue(this, this.options.ajax, [request], null)
} else {
if (this._xhr && this._xhr.readyState !== 4) {
this._xhrAbort = true
this._xhr.abort()
}
this._xhr = $.ajax(request)
}
return data
}
initSearchText () {
if (this.options.search) {
this.searchText = ''
if (this.options.searchText !== '') {
const $search = Utils.getSearchInput(this)
$search.val(this.options.searchText)
this.onSearch({ currentTarget: $search, firedByInitSearchText: true })
}
}
}
getCaret () {
this.$header.find('th').each((i, th) => {
$(th).find('.sortable').removeClass('desc asc')
.addClass($(th).data('field') === this.options.sortName ?
this.options.sortOrder : 'both')
})
}
updateSelected () {
const checkAll = this.$selectItem.filter(':enabled').length &&
this.$selectItem.filter(':enabled').length ===
this.$selectItem.filter(':enabled').filter(':checked').length
this.$selectAll.add(this.$selectAll_).prop('checked', checkAll)
this.$selectItem.each((i, el) => {
$(el).closest('tr')[$(el).prop('checked') ? 'addClass' : 'removeClass']('selected')
})
}
updateRows () {
this.$selectItem.each((i, el) => {
this.data[$(el).data('index')][this.header.stateField] = $(el).prop('checked')
})
}
resetRows () {
for (const row of this.data) {
this.$selectAll.prop('checked', false)
this.$selectItem.prop('checked', false)
if (this.header.stateField) {
row[this.header.stateField] = false
}
}
this.initHiddenRows()
}
trigger (_name, ...args) {
const name = `${_name}.bs.table`
this.options[BootstrapTable.EVENTS[name]](...[...args, this])
this.$el.trigger($.Event(name, { sender: this }), args)
this.options.onAll(name, ...[...args, this])
this.$el.trigger($.Event('all.bs.table', { sender: this }), [name, args])
}
resetHeader () {
// fix #61: the hidden table reset header bug.
// fix bug: get $el.css('width') error sometime (height = 500)
clearTimeout(this.timeoutId_)
this.timeoutId_ = setTimeout(() => this.fitHeader(), this.$el.is(':hidden') ? 100 : 0)
}
fitHeader () {
if (this.$el.is(':hidden')) {
this.timeoutId_ = setTimeout(() => this.fitHeader(), 100)
return
}
const fixedBody = this.$tableBody.get(0)
const scrollWidth = this.hasScrollBar &&
fixedBody.scrollHeight > fixedBody.clientHeight + this.$header.outerHeight() ?
Utils.getScrollBarWidth() : 0
this.$el.css('margin-top', -this.$header.outerHeight())
const focused = this.$tableHeader.find(':focus')
if (focused.length > 0) {
const $th = focused.parents('th')
if ($th.length > 0) {
const dataField = $th.attr('data-field')
if (dataField !== undefined) {
const $headerTh = this.$header.find(`[data-field='${dataField}']`)
if ($headerTh.length > 0) {
$headerTh.find(':input').addClass('focus-temp')
}
}
}
}
this.$header_ = this.$header.clone(true, true)
this.$selectAll_ = this.$header_.find('[name="btSelectAll"]')
this.$tableHeader
.css('margin-right', scrollWidth)
.find('table').css('width', this.$el.outerWidth())
.html('').attr('class', this.$el.attr('class'))
.append(this.$header_)
this.$tableLoading.css('width', this.$el.outerWidth())
const focusedTemp = $('.focus-temp:visible:eq(0)')
if (focusedTemp.length > 0) {
focusedTemp.focus()
this.$header.find('.focus-temp').removeClass('focus-temp')
}
// fix bug: $.data() is not working as expected after $.append()
this.$header.find('th[data-field]').each((i, el) => {
this.$header_.find(Utils.sprintf('th[data-field="%s"]', $(el).data('field'))).data($(el).data())
})
const visibleFields = this.getVisibleFields()
const $ths = this.$header_.find('th')
let $tr = this.$body.find('>tr:not(.no-records-found,.virtual-scroll-top)').eq(0)
while ($tr.length && $tr.find('>td[colspan]:not([colspan="1"])').length) {
$tr = $tr.next()
}
const trLength = $tr.find('> *').length
$tr.find('> *').each((i, el) => {
const $this = $(el)
if (Utils.hasDetailViewIcon(this.options)) {
if (
i === 0 && this.options.detailViewAlign !== 'right' ||
i === trLength - 1 && this.options.detailViewAlign === 'right'
) {
const $thDetail = $ths.filter('.detail')
const zoomWidth = $thDetail.innerWidth() - $thDetail.find('.fht-cell').width()
$thDetail.find('.fht-cell').width($this.innerWidth() - zoomWidth)
return
}
}
const index = i - Utils.getDetailViewIndexOffset(this.options)
let $th = this.$header_.find(Utils.sprintf('th[data-field="%s"]', visibleFields[index]))
if ($th.length > 1) {
$th = $($ths[$this[0].cellIndex])
}
const zoomWidth = $th.innerWidth() - $th.find('.fht-cell').width()
$th.find('.fht-cell').width($this.innerWidth() - zoomWidth)
})
this.horizontalScroll()
this.trigger('post-header')
}
initFooter () {
if (!this.options.showFooter || this.options.cardView) { // do nothing
return
}
const data = this.getData()
const html = []
let detailTemplate = ''
if (Utils.hasDetailViewIcon(this.options)) {
detailTemplate = '<th class="detail"><div class="th-inner"></div><div class="fht-cell"></div></th>'
}
if (detailTemplate && this.options.detailViewAlign !== 'right') {
html.push(detailTemplate)
}
for (const column of this.columns) {
let falign = ''
let valign = ''
const csses = []
let style = {}
let class_ = Utils.sprintf(' class="%s"', column['class'])
if (
!column.visible ||
this.footerData && this.footerData.length > 0 && !(column.field in this.footerData[0])
) {
continue
}
if (this.options.cardView && !column.cardVisible) {
return
}
falign = Utils.sprintf('text-align: %s; ', column.falign ? column.falign : column.align)
valign = Utils.sprintf('vertical-align: %s; ', column.valign)
style = Utils.calculateObjectValue(null, this.options.footerStyle, [column])
if (style && style.css) {
for (const [key, value] of Object.entries(style.css)) {
csses.push(`${key}: ${value}`)
}
}
if (style && style.classes) {
class_ = Utils.sprintf(' class="%s"', column['class'] ?
[column['class'], style.classes].join(' ') : style.classes)
}
html.push('<th', class_, Utils.sprintf(' style="%s"', falign + valign + csses.concat().join('; ')))
let colspan = 0
if (this.footerData && this.footerData.length > 0) {
colspan = this.footerData[0][`_${column.field}_colspan`] || 0
}
if (colspan) {
html.push(` colspan="${colspan}" `)
}
html.push('>')
html.push('<div class="th-inner">')
let value = ''
if (this.footerData && this.footerData.length > 0) {
value = this.footerData[0][column.field] || ''
}
html.push(Utils.calculateObjectValue(column, column.footerFormatter,
[data, value], value))
html.push('</div>')
html.push('<div class="fht-cell"></div>')
html.push('</div>')
html.push('</th>')
}
if (detailTemplate && this.options.detailViewAlign === 'right') {
html.push(detailTemplate)
}
if (!this.options.height && !this.$tableFooter.length) {
this.$el.append('<tfoot><tr></tr></tfoot>')
this.$tableFooter = this.$el.find('tfoot')
}
if (!this.$tableFooter.find('tr').length) {
this.$tableFooter.html('<table><thead><tr></tr></thead></table>')
}
this.$tableFooter.find('tr').html(html.join(''))
this.trigger('post-footer', this.$tableFooter)
}
fitFooter () {
if (this.$el.is(':hidden')) {
setTimeout(() => this.fitFooter(), 100)
return
}
const fixedBody = this.$tableBody.get(0)
const scrollWidth = this.hasScrollBar &&
fixedBody.scrollHeight > fixedBody.clientHeight + this.$header.outerHeight() ?
Utils.getScrollBarWidth() : 0
this.$tableFooter
.css('margin-right', scrollWidth)
.find('table').css('width', this.$el.outerWidth())
.attr('class', this.$el.attr('class'))
const $ths = this.$tableFooter.find('th')
let $tr = this.$body.find('>tr:first-child:not(.no-records-found)')
$ths.find('.fht-cell').width('auto')
while ($tr.length && $tr.find('>td[colspan]:not([colspan="1"])').length) {
$tr = $tr.next()
}
const trLength = $tr.find('> *').length
$tr.find('> *').each((i, el) => {
const $this = $(el)
if (Utils.hasDetailViewIcon(this.options)) {
if (
i === 0 && this.options.detailViewAlign === 'left' ||
i === trLength - 1 && this.options.detailViewAlign === 'right'
) {
const $thDetail = $ths.filter('.detail')
const zoomWidth = $thDetail.innerWidth() - $thDetail.find('.fht-cell').width()
$thDetail.find('.fht-cell').width($this.innerWidth() - zoomWidth)
return
}
}
const $th = $ths.eq(i)
const zoomWidth = $th.innerWidth() - $th.find('.fht-cell').width()
$th.find('.fht-cell').width($this.innerWidth() - zoomWidth)
})
this.horizontalScroll()
}
horizontalScroll () {
// horizontal scroll event
// TODO: it's probably better improving the layout than binding to scroll event
this.$tableBody.off('scroll').on('scroll', () => {
const scrollLeft = this.$tableBody.scrollLeft()
if (this.options.showHeader && this.options.height) {
this.$tableHeader.scrollLeft(scrollLeft)
}
if (this.options.showFooter && !this.options.cardView) {
this.$tableFooter.scrollLeft(scrollLeft)
}
this.trigger('scroll-body', this.$tableBody)
})
}
getVisibleFields () {
const visibleFields = []
for (const field of this.header.fields) {
const column = this.columns[this.fieldsColumnsIndex[field]]
if (!column || !column.visible || this.options.cardView && !column.cardVisible) {
continue
}
visibleFields.push(field)
}
return visibleFields
}
initHiddenRows () {
this.hiddenRows = []
}
// PUBLIC FUNCTION DEFINITION
// =======================
getOptions () {
// deep copy and remove data
const options = Utils.extend({}, this.options)
delete options.data
return Utils.extend(true, {}, options)
}
refreshOptions (options) {
// If the objects are equivalent then avoid the call of destroy / init methods
if (Utils.compareObjects(this.options, options, true)) {
return
}
this.options = Utils.extend(this.options, options)
this.trigger('refresh-options', this.options)
this.destroy()
this.init()
}
getData (params) {
let data = this.options.data
if (
(
this.searchText ||
this.options.customSearch ||
this.options.sortName !== undefined ||
this.enableCustomSort || // Fix #4616: this.enableCustomSort is for extensions
!Utils.isEmptyObject(this.filterColumns) ||
typeof this.options.filterOptions.filterAlgorithm === 'function' ||
!Utils.isEmptyObject(this.filterColumnsPartial)
) && (!params || !params.unfiltered)
) {
data = this.data
}
if (params && params.useCurrentPage) {
data = data.slice(this.pageFrom - 1, this.pageTo)
}
if (params && !params.includeHiddenRows) {
const hiddenRows = this.getHiddenRows()
data = data.filter(row => Utils.findIndex(hiddenRows, row) === -1)
}
if (params && params.formatted) {
data.forEach(row => {
for (const [key, value] of Object.entries(row)) {
const column = this.columns[this.fieldsColumnsIndex[key]]
if (!column) {
return
}
row[key] = Utils.calculateObjectValue(column, this.header.formatters[column.fieldIndex], [value, row, row.index, column.field], value)
}
})
}
return data
}
getSelections () {
return (this.options.maintainMetaData ? this.options.data : this.data)
.filter(row => row[this.header.stateField] === true)
}
load (_data) {
let fixedScroll = false
let data = _data
// #431: support pagination
if (this.options.pagination && this.options.sidePagination === 'server') {
this.options.totalRows = data[this.options.totalField]
this.options.totalNotFiltered = data[this.options.totalNotFilteredField]
this.footerData = data[this.options.footerField] ? [data[this.options.footerField]] : undefined
}
fixedScroll = data.fixedScroll
data = Array.isArray(data) ? data : data[this.options.dataField]
this.initData(data)
this.initSearch()
this.initPagination()
this.initBody(fixedScroll)
}
append (data) {
this.initData(data, 'append')
this.initSearch()
this.initPagination()
this.initSort()
this.initBody(true)
}
prepend (data) {
this.initData(data, 'prepend')
this.initSearch()
this.initPagination()
this.initSort()
this.initBody(true)
}
remove (params) {
let removed = 0
for (let i = this.options.data.length - 1; i >= 0; i--) {
const row = this.options.data[i]
const value = Utils.getItemField(row, params.field, this.options.escape, row.escape)
if (value === undefined && params.field !== '$index') {
continue
}
if (
!row.hasOwnProperty(params.field) &&
params.field === '$index' &&
params.values.includes(i) ||
params.values.includes(value)
) {
removed++
this.options.data.splice(i, 1)
}
}
if (!removed) {
return
}
if (this.options.sidePagination === 'server') {
this.options.totalRows -= removed
this.data = [...this.options.data]
}
this.initSearch()
this.initPagination()
this.initSort()
this.initBody(true)
}
removeAll () {
if (this.options.data.length > 0) {
this.options.data.splice(0, this.options.data.length)
this.initSearch()
this.initPagination()
this.initBody(true)
}
}
insertRow (params) {
if (!params.hasOwnProperty('index') || !params.hasOwnProperty('row')) {
return
}
this.options.data.splice(params.index, 0, params.row)
this.initSearch()
this.initPagination()
this.initSort()
this.initBody(true)
}
updateRow (params) {
const allParams = Array.isArray(params) ? params : [params]
for (const params of allParams) {
if (!params.hasOwnProperty('index') || !params.hasOwnProperty('row')) {
continue
}
if (params.hasOwnProperty('replace') && params.replace) {
this.options.data[params.index] = params.row
} else {
Utils.extend(this.options.data[params.index], params.row)
}
}
this.initSearch()
this.initPagination()
this.initSort()
this.initBody(true)
}
getRowByUniqueId (_id) {
const uniqueId = this.options.uniqueId
const len = this.options.data.length
let id = _id
let dataRow = null
let i
let row
for (i = len - 1; i >= 0; i--) {
row = this.options.data[i]
const rowUniqueId = Utils.getItemField(row, uniqueId, this.options.escape, row.escape)
if (rowUniqueId === undefined) {
continue
}
if (typeof rowUniqueId === 'string') {
id = id.toString()
} else if (typeof rowUniqueId === 'number') {
if (Number(rowUniqueId) === rowUniqueId && rowUniqueId % 1 === 0) {
id = parseInt(id, 10)
} else if (rowUniqueId === Number(rowUniqueId) && rowUniqueId !== 0) {
id = parseFloat(id)
}
}
if (rowUniqueId === id) {
dataRow = row
break
}
}
return dataRow
}
updateByUniqueId (params) {
const allParams = Array.isArray(params) ? params : [params]
let updatedUid = null
for (const params of allParams) {
if (!params.hasOwnProperty('id') || !params.hasOwnProperty('row')) {
continue
}
const rowId = this.options.data.indexOf(this.getRowByUniqueId(params.id))
if (rowId === -1) {
continue
}
if (params.hasOwnProperty('replace') && params.replace) {
this.options.data[rowId] = params.row
} else {
Utils.extend(this.options.data[rowId], params.row)
}
updatedUid = params.id
}
this.initSearch()
this.initPagination()
this.initSort()
this.initBody(true, updatedUid)
}
removeByUniqueId (id) {
const len = this.options.data.length
const row = this.getRowByUniqueId(id)
if (row) {
this.options.data.splice(this.options.data.indexOf(row), 1)
}
if (len === this.options.data.length) {
return
}
if (this.options.sidePagination === 'server') {
this.options.totalRows -= 1
this.data = [...this.options.data]
}
this.initSearch()
this.initPagination()
this.initBody(true)
}
_updateCellOnly (field, index) {
const rowHtml = this.initRow(this.options.data[index], index)
let fieldIndex = this.getVisibleFields().indexOf(field)
if (fieldIndex === -1) {
return
}
fieldIndex += Utils.getDetailViewIndexOffset(this.options)
this.$body.find(`>tr[data-index=${index}]`)
.find(`>td:eq(${fieldIndex})`)
.replaceWith($(rowHtml).find(`>td:eq(${fieldIndex})`))
this.initBodyEvent()
this.initFooter()
this.resetView()
this.updateSelected()
}
updateCell (params) {
if (!params.hasOwnProperty('index') ||
!params.hasOwnProperty('field') ||
!params.hasOwnProperty('value')) {
return
}
this.options.data[params.index][params.field] = params.value
if (params.reinit === false) {
this._updateCellOnly(params.field, params.index)
return
}
this.initSort()
this.initBody(true)
}
updateCellByUniqueId (params) {
const allParams = Array.isArray(params) ? params : [params]
allParams.forEach(({ id, field, value }) => {
const index = this.options.data.indexOf(this.getRowByUniqueId(id))
if (index === -1) {
return
}
this.options.data[index][field] = value
})
if (params.reinit === false) {
this._updateCellOnly(params.field,
this.options.data.indexOf(this.getRowByUniqueId(params.id)))
return
}
this.initSort()
this.initBody(true)
}
showRow (params) {
this._toggleRow(params, true)
}
hideRow (params) {
this._toggleRow(params, false)
}
_toggleRow (params, visible) {
let row
if (params.hasOwnProperty('index')) {
row = this.getData()[params.index]
} else if (params.hasOwnProperty('uniqueId')) {
row = this.getRowByUniqueId(params.uniqueId)
}
if (!row) {
return
}
const index = Utils.findIndex(this.hiddenRows, row)
if (!visible && index === -1) {
this.hiddenRows.push(row)
} else if (visible && index > -1) {
this.hiddenRows.splice(index, 1)
}
this.initBody(true)
this.initPagination()
}
getHiddenRows (show) {
if (show) {
this.initHiddenRows()
this.initBody(true)
this.initPagination()
return
}
const data = this.getData()
const rows = []
for (const row of data) {
if (this.hiddenRows.includes(row)) {
rows.push(row)
}
}
this.hiddenRows = rows
return rows
}
showColumn (field) {
const fields = Array.isArray(field) ? field : [field]
fields.forEach(field => {
this._toggleColumn(this.fieldsColumnsIndex[field], true, true)
})
}
hideColumn (field) {
const fields = Array.isArray(field) ? field : [field]
fields.forEach(field => {
this._toggleColumn(this.fieldsColumnsIndex[field], false, true)
})
}
_toggleColumn (index, checked, needUpdate) {
if (index === -1 || this.columns[index].visible === checked) {
return
}
this.columns[index].visible = checked
this.initHeader()
this.initSearch()
this.initPagination()
this.initBody()
if (this.options.showColumns) {
const $items = this.$toolbar.find('.keep-open input:not(".toggle-all")').prop('disabled', false)
if (needUpdate) {
$items.filter(Utils.sprintf('[value="%s"]', index)).prop('checked', checked)
}
if ($items.filter(':checked').length <= this.options.minimumCountColumns) {
$items.filter(':checked').prop('disabled', true)
}
}
}
getVisibleColumns () {
return this.columns.filter(column => column.visible && !this.isSelectionColumn(column))
}
getHiddenColumns () {
return this.columns.filter(({ visible }) => !visible)
}
isSelectionColumn (column) {
return column.radio || column.checkbox
}
showAllColumns () {
this._toggleAllColumns(true)
}
hideAllColumns () {
this._toggleAllColumns(false)
}
_toggleAllColumns (visible) {
for (const column of this.columns.slice().reverse()) {
if (column.switchable) {
if (
!visible &&
this.options.showColumns &&
this.getVisibleColumns().filter(it => it.switchable).length === this.options.minimumCountColumns
) {
continue
}
column.visible = visible
}
}
this.initHeader()
this.initSearch()
this.initPagination()
this.initBody()
if (this.options.showColumns) {
const $items = this.$toolbar.find('.keep-open input[type="checkbox"]:not(".toggle-all")').prop('disabled', false)
if (visible) {
$items.prop('checked', visible)
} else {
$items.get().reverse().forEach(item => {
if ($items.filter(':checked').length > this.options.minimumCountColumns) {
$(item).prop('checked', visible)
}
})
}
if ($items.filter(':checked').length <= this.options.minimumCountColumns) {
$items.filter(':checked').prop('disabled', true)
}
}
}
mergeCells (options) {
const row = options.index
let col = this.getVisibleFields().indexOf(options.field)
const rowspan = options.rowspan || 1
const colspan = options.colspan || 1
let i
let j
const $tr = this.$body.find('>tr[data-index]')
col += Utils.getDetailViewIndexOffset(this.options)
const $td = $tr.eq(row).find('>td').eq(col)
if (row < 0 || col < 0 || row >= this.data.length) {
return
}
for (i = row; i < row + rowspan; i++) {
for (j = col; j < col + colspan; j++) {
$tr.eq(i).find('>td').eq(j).hide()
}
}
$td.attr('rowspan', rowspan).attr('colspan', colspan).show()
}
checkAll () {
this._toggleCheckAll(true)
}
uncheckAll () {
this._toggleCheckAll(false)
}
_toggleCheckAll (checked) {
const rowsBefore = this.getSelections()
this.$selectAll.add(this.$selectAll_).prop('checked', checked)
this.$selectItem.filter(':enabled').prop('checked', checked)
this.updateRows()
this.updateSelected()
const rowsAfter = this.getSelections()
if (checked) {
this.trigger('check-all', rowsAfter, rowsBefore)
return
}
this.trigger('uncheck-all', rowsAfter, rowsBefore)
}
checkInvert () {
const $items = this.$selectItem.filter(':enabled')
let checked = $items.filter(':checked')
$items.each((i, el) => {
$(el).prop('checked', !$(el).prop('checked'))
})
this.updateRows()
this.updateSelected()
this.trigger('uncheck-some', checked)
checked = this.getSelections()
this.trigger('check-some', checked)
}
check (index) {
this._toggleCheck(true, index)
}
uncheck (index) {
this._toggleCheck(false, index)
}
_toggleCheck (checked, index) {
const $el = this.$selectItem.filter(`[data-index="${index}"]`)
const row = this.data[index]
if (
$el.is(':radio') ||
this.options.singleSelect ||
this.options.multipleSelectRow &&
!this.multipleSelectRowCtrlKey &&
!this.multipleSelectRowShiftKey
) {
for (const r of this.options.data) {
r[this.header.stateField] = false
}
this.$selectItem.filter(':checked').not($el).prop('checked', false)
}
row[this.header.stateField] = checked
if (this.options.multipleSelectRow) {
if (this.multipleSelectRowShiftKey && this.multipleSelectRowLastSelectedIndex >= 0) {
const [fromIndex, toIndex] = this.multipleSelectRowLastSelectedIndex < index ?
[this.multipleSelectRowLastSelectedIndex, index] : [index, this.multipleSelectRowLastSelectedIndex]
for (let i = fromIndex + 1; i < toIndex; i++) {
this.data[i][this.header.stateField] = true
this.$selectItem.filter(`[data-index="${i}"]`).prop('checked', true)
}
}
this.multipleSelectRowCtrlKey = false
this.multipleSelectRowShiftKey = false
this.multipleSelectRowLastSelectedIndex = checked ? index : -1
}
$el.prop('checked', checked)
this.updateSelected()
this.trigger(checked ? 'check' : 'uncheck', this.data[index], $el)
}
checkBy (obj) {
this._toggleCheckBy(true, obj)
}
uncheckBy (obj) {
this._toggleCheckBy(false, obj)
}
_toggleCheckBy (checked, obj) {
if (!obj.hasOwnProperty('field') || !obj.hasOwnProperty('values')) {
return
}
const rows = []
this.data.forEach((row, i) => {
if (!row.hasOwnProperty(obj.field)) {
return false
}
if (obj.values.includes(row[obj.field])) {
let $el = this.$selectItem.filter(':enabled')
.filter(Utils.sprintf('[data-index="%s"]', i))
const onlyCurrentPage = obj.hasOwnProperty('onlyCurrentPage') ? obj.onlyCurrentPage : false
$el = checked ? $el.not(':checked') : $el.filter(':checked')
if (!$el.length && onlyCurrentPage) {
return
}
$el.prop('checked', checked)
row[this.header.stateField] = checked
rows.push(row)
this.trigger(checked ? 'check' : 'uncheck', row, $el)
}
})
this.updateSelected()
this.trigger(checked ? 'check-some' : 'uncheck-some', rows)
}
refresh (params) {
if (params && params.url) {
this.options.url = params.url
}
if (params && params.pageNumber) {
this.options.pageNumber = params.pageNumber
}
if (params && params.pageSize) {
this.options.pageSize = params.pageSize
}
this.trigger('refresh', this.initServer(params && params.silent,
params && params.query, params && params.url))
}
destroy () {
this.$el.insertBefore(this.$container)
$(this.options.toolbar).insertBefore(this.$el)
this.$container.next().remove()
this.$container.remove()
this.$el.html(this.$el_.html())
.css('margin-top', '0')
.attr('class', this.$el_.attr('class') || '') // reset the class
const resizeEvent = Utils.getEventName('resize.bootstrap-table', this.$el.attr('id'))
$(window).off(resizeEvent)
}
resetView (params) {
let padding = 0
if (params && params.height) {
this.options.height = params.height
}
this.$tableContainer.toggleClass('has-card-view', this.options.cardView)
if (this.options.height) {
const fixedBody = this.$tableBody.get(0)
this.hasScrollBar = fixedBody.scrollWidth > fixedBody.clientWidth
}
if (!this.options.cardView && this.options.showHeader && this.options.height) {
this.$tableHeader.show()
this.resetHeader()
padding += this.$header.outerHeight(true) + 1
} else {
this.$tableHeader.hide()
this.trigger('post-header')
}
if (!this.options.cardView && this.options.showFooter) {
this.$tableFooter.show()
this.fitFooter()
if (this.options.height) {
padding += this.$tableFooter.outerHeight(true)
}
}
if (this.$container.hasClass('fullscreen')) {
this.$tableContainer.css('height', '')
this.$tableContainer.css('width', '')
} else if (this.options.height) {
if (this.$tableBorder) {
this.$tableBorder.css('width', '')
this.$tableBorder.css('height', '')
}
const toolbarHeight = this.$toolbar.outerHeight(true)
const paginationHeight = this.$pagination.outerHeight(true)
const height = this.options.height - toolbarHeight - paginationHeight
const $bodyTable = this.$tableBody.find('>table')
const tableHeight = $bodyTable.outerHeight()
this.$tableContainer.css('height', `${height}px`)
if (this.$tableBorder && $bodyTable.is(':visible')) {
let tableBorderHeight = height - tableHeight - 2
if (this.hasScrollBar) {
tableBorderHeight -= Utils.getScrollBarWidth()
}
this.$tableBorder.css('width', `${$bodyTable.outerWidth()}px`)
this.$tableBorder.css('height', `${tableBorderHeight}px`)
}
}
if (this.options.cardView) {
// remove the element css
this.$el.css('margin-top', '0')
this.$tableContainer.css('padding-bottom', '0')
this.$tableFooter.hide()
} else {
// Assign the correct sortable arrow
this.getCaret()
this.$tableContainer.css('padding-bottom', `${padding}px`)
}
this.trigger('reset-view')
}
showLoading () {
this.$tableLoading.toggleClass('open', true)
let fontSize = this.options.loadingFontSize
if (this.options.loadingFontSize === 'auto') {
fontSize = this.$tableLoading.width() * 0.04
fontSize = Math.max(12, fontSize)
fontSize = Math.min(32, fontSize)
fontSize = `${fontSize}px`
}
this.$tableLoading.find('.loading-text').css('font-size', fontSize)
}
hideLoading () {
this.$tableLoading.toggleClass('open', false)
}
togglePagination () {
this.options.pagination = !this.options.pagination
const icon = this.options.showButtonIcons ? this.options.pagination ? this.options.icons.paginationSwitchDown : this.options.icons.paginationSwitchUp : ''
const text = this.options.showButtonText ? this.options.pagination ? this.options.formatPaginationSwitchUp() : this.options.formatPaginationSwitchDown() : ''
this.$toolbar.find('button[name="paginationSwitch"]')
.html(`${Utils.sprintf(this.constants.html.icon, this.options.iconsPrefix, icon)} ${text}`)
this.updatePagination()
this.trigger('toggle-pagination', this.options.pagination)
}
toggleFullscreen () {
this.$el.closest('.bootstrap-table').toggleClass('fullscreen')
this.resetView()
}
toggleView () {
this.options.cardView = !this.options.cardView
this.initHeader()
const icon = this.options.showButtonIcons ? this.options.cardView ? this.options.icons.toggleOn : this.options.icons.toggleOff : ''
const text = this.options.showButtonText ? this.options.cardView ? this.options.formatToggleOff() : this.options.formatToggleOn() : ''
this.$toolbar.find('button[name="toggle"]')
.html(`${Utils.sprintf(this.constants.html.icon, this.options.iconsPrefix, icon)} ${text}`)
.attr('aria-label', text)
.attr('title', text)
this.initBody()
this.trigger('toggle', this.options.cardView)
}
resetSearch (text) {
const $search = Utils.getSearchInput(this)
const textToUse = text || ''
$search.val(textToUse)
this.searchText = textToUse
this.onSearch({ currentTarget: $search }, false)
}
filterBy (columns, options) {
this.filterOptions = Utils.isEmptyObject(options) ? this.options.filterOptions : Utils.extend(this.options.filterOptions, options)
this.filterColumns = Utils.isEmptyObject(columns) ? {} : columns
this.options.pageNumber = 1
this.initSearch()
this.updatePagination()
}
scrollTo (params) {
let options = { unit: 'px', value: 0 }
if (typeof params === 'object') {
options = Object.assign(options, params)
} else if (typeof params === 'string' && params === 'bottom') {
options.value = this.$tableBody[0].scrollHeight
} else if (typeof params === 'string' || typeof params === 'number') {
options.value = params
}
let scrollTo = options.value
if (options.unit === 'rows') {
scrollTo = 0
this.$body.find(`> tr:lt(${options.value})`).each((i, el) => {
scrollTo += $(el).outerHeight(true)
})
}
this.$tableBody.scrollTop(scrollTo)
}
getScrollPosition () {
return this.$tableBody.scrollTop()
}
selectPage (page) {
if (page > 0 && page <= this.options.totalPages) {
this.options.pageNumber = page
this.updatePagination()
}
}
prevPage () {
if (this.options.pageNumber > 1) {
this.options.pageNumber--
this.updatePagination()
}
}
nextPage () {
if (this.options.pageNumber < this.options.totalPages) {
this.options.pageNumber++
this.updatePagination()
}
}
toggleDetailView (index, _columnDetailFormatter) {
const $tr = this.$body.find(Utils.sprintf('> tr[data-index="%s"]', index))
if ($tr.next().is('tr.detail-view')) {
this.collapseRow(index)
} else {
this.expandRow(index, _columnDetailFormatter)
}
this.resetView()
}
expandRow (index, _columnDetailFormatter) {
const row = this.data[index]
const $tr = this.$body.find(Utils.sprintf('> tr[data-index="%s"][data-has-detail-view]', index))
if (this.options.detailViewIcon) {
$tr.find('a.detail-icon').html(Utils.sprintf(this.constants.html.icon, this.options.iconsPrefix, this.options.icons.detailClose))
}
if ($tr.next().is('tr.detail-view')) {
return
}
$tr.after(Utils.sprintf('<tr class="detail-view"><td colspan="%s"></td></tr>', $tr.children('td').length))
const $element = $tr.next().find('td')
const detailFormatter = _columnDetailFormatter || this.options.detailFormatter
const content = Utils.calculateObjectValue(this.options, detailFormatter, [index, row, $element], '')
if ($element.length === 1) {
$element.append(content)
}
this.trigger('expand-row', index, row, $element)
}
expandRowByUniqueId (uniqueId) {
const row = this.getRowByUniqueId(uniqueId)
if (!row) {
return
}
this.expandRow(this.data.indexOf(row))
}
collapseRow (index) {
const row = this.data[index]
const $tr = this.$body.find(Utils.sprintf('> tr[data-index="%s"][data-has-detail-view]', index))
if (!$tr.next().is('tr.detail-view')) {
return
}
if (this.options.detailViewIcon) {
$tr.find('a.detail-icon').html(Utils.sprintf(this.constants.html.icon, this.options.iconsPrefix, this.options.icons.detailOpen))
}
this.trigger('collapse-row', index, row, $tr.next())
$tr.next().remove()
}
collapseRowByUniqueId (uniqueId) {
const row = this.getRowByUniqueId(uniqueId)
if (!row) {
return
}
this.collapseRow(this.data.indexOf(row))
}
expandAllRows () {
const trs = this.$body.find('> tr[data-index][data-has-detail-view]')
for (let i = 0; i < trs.length; i++) {
this.expandRow($(trs[i]).data('index'))
}
}
collapseAllRows () {
const trs = this.$body.find('> tr[data-index][data-has-detail-view]')
for (let i = 0; i < trs.length; i++) {
this.collapseRow($(trs[i]).data('index'))
}
}
updateColumnTitle (params) {
if (!params.hasOwnProperty('field') || !params.hasOwnProperty('title')) {
return
}
this.columns[this.fieldsColumnsIndex[params.field]].title =
this.options.escape && this.options.escapeTitle ? Utils.escapeHTML(params.title) : params.title
if (this.columns[this.fieldsColumnsIndex[params.field]].visible) {
this.$header.find('th[data-field]').each((i, el) => {
if ($(el).data('field') === params.field) {
$($(el).find('.th-inner')[0]).text(params.title)
return false
}
})
this.resetView()
}
}
updateFormatText (formatName, text) {
if (!/^format/.test(formatName) || !this.options[formatName]) {
return
}
if (typeof text === 'string') {
this.options[formatName] = () => text
} else if (typeof text === 'function') {
this.options[formatName] = text
}
this.initToolbar()
this.initPagination()
this.initBody()
}
}
BootstrapTable.VERSION = Constants.VERSION
BootstrapTable.DEFAULTS = Constants.DEFAULTS
BootstrapTable.LOCALES = Constants.LOCALES
BootstrapTable.COLUMN_DEFAULTS = Constants.COLUMN_DEFAULTS
BootstrapTable.METHODS = Constants.METHODS
BootstrapTable.EVENTS = Constants.EVENTS
// BOOTSTRAP TABLE PLUGIN DEFINITION
// =======================
$.BootstrapTable = BootstrapTable
$.fn.bootstrapTable = function (option, ...args) {
let value
this.each((i, el) => {
let data = $(el).data('bootstrap.table')
if (typeof option === 'string') {
if (!Constants.METHODS.includes(option)) {
throw new Error(`Unknown method: ${option}`)
}
if (!data) {
return
}
value = data[option](...args)
if (option === 'destroy') {
$(el).removeData('bootstrap.table')
}
return
}
const options = Utils.extend(true, {}, BootstrapTable.DEFAULTS, $(el).data(),
typeof option === 'object' && option)
if (!data) {
data = new $.BootstrapTable(el, options)
$(el).data('bootstrap.table', data)
data.init()
}
})
return typeof value === 'undefined' ? this : value
}
$.fn.bootstrapTable.Constructor = BootstrapTable
$.fn.bootstrapTable.theme = Constants.THEME
$.fn.bootstrapTable.VERSION = Constants.VERSION
$.fn.bootstrapTable.defaults = BootstrapTable.DEFAULTS
$.fn.bootstrapTable.columnDefaults = BootstrapTable.COLUMN_DEFAULTS
$.fn.bootstrapTable.events = BootstrapTable.EVENTS
$.fn.bootstrapTable.locales = BootstrapTable.LOCALES
$.fn.bootstrapTable.methods = BootstrapTable.METHODS
$.fn.bootstrapTable.utils = Utils
// BOOTSTRAP TABLE INIT
// =======================
$(() => {
$('[data-toggle="table"]').bootstrapTable()
})
export default BootstrapTable