%PDF-
%PDF-
Mini Shell
Mini Shell
import { NAME_TABLE } from '../../../constants/components'
import { CODE_ENTER, CODE_SPACE } from '../../../constants/key-codes'
import identity from '../../../utils/identity'
import noop from '../../../utils/noop'
import { makePropsConfigurable } from '../../../utils/config'
import { stopEvent } from '../../../utils/events'
import { htmlOrText } from '../../../utils/html'
import { isUndefinedOrNull } from '../../../utils/inspect'
import { startCase } from '../../../utils/string'
import filterEvent from './filter-event'
import textSelectionActive from './text-selection-active'
import { BThead } from '../thead'
import { BTfoot } from '../tfoot'
import { BTr } from '../tr'
import { BTh } from '../th'
export default {
props: makePropsConfigurable(
{
headVariant: {
type: String // 'light', 'dark' or `null` (or custom)
// default: null
},
headRowVariant: {
// Any Bootstrap theme variant (or custom)
type: String
// default: null
},
theadClass: {
type: [String, Array, Object]
// default: undefined
},
theadTrClass: {
type: [String, Array, Object]
// default: undefined
}
},
NAME_TABLE
),
methods: {
fieldClasses(field) {
// Header field (<th>) classes
return [field.class ? field.class : '', field.thClass ? field.thClass : '']
},
headClicked(evt, field, isFoot) {
if (this.stopIfBusy && this.stopIfBusy(evt)) {
// If table is busy (via provider) then don't propagate
return
} else if (filterEvent(evt)) {
// Clicked on a non-disabled control so ignore
return
} else if (textSelectionActive(this.$el)) {
// User is selecting text, so ignore
/* istanbul ignore next: JSDOM doesn't support getSelection() */
return
}
stopEvent(evt)
this.$emit('head-clicked', field.key, field, evt, isFoot)
},
renderThead(isFoot = false) {
const h = this.$createElement
const fields = this.computedFields || []
// In always stacked mode, we don't bother rendering the head/foot
// Or if no field headings (empty table)
if (this.isStackedAlways || fields.length === 0) {
return h()
}
const {
isSortable,
isSelectable,
headVariant,
footVariant,
headRowVariant,
footRowVariant
} = this
const hasHeadClickListener = isSortable || this.hasListener('head-clicked')
// Reference to `selectAllRows` and `clearSelected()`, if table is selectable
const selectAllRows = isSelectable ? this.selectAllRows : noop
const clearSelected = isSelectable ? this.clearSelected : noop
// Helper function to generate a field <th> cell
const makeCell = (field, colIndex) => {
const { label, labelHtml, variant, stickyColumn, key } = field
let ariaLabel = null
if (!field.label.trim() && !field.headerTitle) {
// In case field's label and title are empty/blank
// We need to add a hint about what the column is about for non-sighted users
/* istanbul ignore next */
ariaLabel = startCase(field.key)
}
const on = {}
if (hasHeadClickListener) {
on.click = evt => {
this.headClicked(evt, field, isFoot)
}
on.keydown = evt => {
const keyCode = evt.keyCode
if (keyCode === CODE_ENTER || keyCode === CODE_SPACE) {
this.headClicked(evt, field, isFoot)
}
}
}
const sortAttrs = isSortable ? this.sortTheadThAttrs(key, field, isFoot) : {}
const sortClass = isSortable ? this.sortTheadThClasses(key, field, isFoot) : null
const sortLabel = isSortable ? this.sortTheadThLabel(key, field, isFoot) : null
const data = {
class: [this.fieldClasses(field), sortClass],
props: { variant, stickyColumn },
style: field.thStyle || {},
attrs: {
// We only add a tabindex of 0 if there is a head-clicked listener
tabindex: hasHeadClickListener ? '0' : null,
abbr: field.headerAbbr || null,
title: field.headerTitle || null,
'aria-colindex': colIndex + 1,
'aria-label': ariaLabel,
...this.getThValues(null, key, field.thAttr, isFoot ? 'foot' : 'head', {}),
...sortAttrs
},
on,
key
}
// Handle edge case where in-document templates are used with new
// `v-slot:name` syntax where the browser lower-cases the v-slot's
// name (attributes become lower cased when parsed by the browser)
// We have replaced the square bracket syntax with round brackets
// to prevent confusion with dynamic slot names
let slotNames = [`head(${key})`, `head(${key.toLowerCase()})`, 'head()']
// Footer will fallback to header slot names
if (isFoot) {
slotNames = [`foot(${key})`, `foot(${key.toLowerCase()})`, 'foot()', ...slotNames]
}
const scope = {
label,
column: key,
field,
isFoot,
// Add in row select methods
selectAllRows,
clearSelected
}
const $content =
this.normalizeSlot(slotNames, scope) ||
h('div', { domProps: htmlOrText(labelHtml, label) })
const $srLabel = sortLabel ? h('span', { staticClass: 'sr-only' }, ` (${sortLabel})`) : null
// Return the header cell
return h(BTh, data, [$content, $srLabel].filter(identity))
}
// Generate the array of <th> cells
const $cells = fields.map(makeCell).filter(identity)
// Generate the row(s)
const $trs = []
if (isFoot) {
$trs.push(
h(
BTr,
{
class: this.tfootTrClass,
props: {
variant: isUndefinedOrNull(footRowVariant)
? headRowVariant
: /* istanbul ignore next */ footRowVariant
}
},
$cells
)
)
} else {
const scope = {
columns: fields.length,
fields,
// Add in row select methods
selectAllRows,
clearSelected
}
$trs.push(this.normalizeSlot('thead-top', scope) || h())
$trs.push(
h(
BTr,
{
class: this.theadTrClass,
props: { variant: headRowVariant }
},
$cells
)
)
}
return h(
isFoot ? BTfoot : BThead,
{
key: isFoot ? 'bv-tfoot' : 'bv-thead',
class: (isFoot ? this.tfootClass : this.theadClass) || null,
props: isFoot
? { footVariant: footVariant || headVariant || null }
: { headVariant: headVariant || null }
},
$trs
)
}
}
}
Zerion Mini Shell 1.0