-
-
Notifications
You must be signed in to change notification settings - Fork 1.9k
/
mixin-tbody-row.js
319 lines (304 loc) · 11.9 KB
/
mixin-tbody-row.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
import get from '../../../utils/get'
import toString from '../../../utils/to-string'
import { isFunction, isString, isUndefinedOrNull } from '../../../utils/inspect'
import { BTr } from '../tr'
import { BTd } from '../td'
import { BTh } from '../th'
const detailsSlotName = 'row-details'
export default {
props: {
tbodyTrClass: {
type: [String, Array, Object, Function],
default: null
},
detailsTdClass: {
type: [String, Array, Object],
default: null
}
},
methods: {
// Methods for computing classes, attributes and styles for table cells
getTdValues(item, key, tdValue, defValue) {
const parent = this.$parent
if (tdValue) {
const value = get(item, key, '')
if (isFunction(tdValue)) {
return tdValue(value, key, item)
} else if (isString(tdValue) && isFunction(parent[tdValue])) {
return parent[tdValue](value, key, item)
}
return tdValue
}
return defValue
},
getThValues(item, key, thValue, type, defValue) {
const parent = this.$parent
if (thValue) {
const value = get(item, key, '')
if (isFunction(thValue)) {
return thValue(value, key, item, type)
} else if (isString(thValue) && isFunction(parent[thValue])) {
return parent[thValue](value, key, item, type)
}
return thValue
}
return defValue
},
// Method to get the value for a field
getFormattedValue(item, field) {
const key = field.key
const formatter = this.getFieldFormatter(key)
let value = get(item, key, null)
if (isFunction(formatter)) {
value = formatter(value, key, item)
}
return isUndefinedOrNull(value) ? '' : value
},
// Factory function methods
toggleDetailsFactory(hasDetailsSlot, item) {
// Returns a function to toggle a row's details slot
return () => {
if (hasDetailsSlot) {
this.$set(item, '_showDetails', !item._showDetails)
}
}
},
// Row event handlers
rowHovered(evt) {
// `mouseenter` handler (non-bubbling)
// `this.tbodyRowEvtStopped` from tbody mixin
const type = 'row-hovered'
if (this.$listeners[type] && !this.tbodyRowEvtStopped(evt)) {
// `this.emitTbodyRowEvent` from tbody mixin
this.emitTbodyRowEvent(type, evt)
}
},
rowUnhovered(evt) {
// `mouseleave` handler (non-bubbling)
// `this.tbodyRowEvtStopped` from tbody mixin
const type = 'row-unhovered'
if (this.$listeners[type] && !this.tbodyRowEvtStopped(evt)) {
// `this.emitTbodyRowEvent` from tbody mixin
this.emitTbodyRowEvent(type, evt)
}
},
// Render helpers
renderTbodyRowCell(field, colIndex, item, rowIndex) {
// Renders a TD or TH for a row's field
const h = this.$createElement
const hasDetailsSlot = this.hasNormalizedSlot(detailsSlotName)
const formatted = this.getFormattedValue(item, field)
const key = field.key
const stickyColumn =
!this.isStacked && (this.isResponsive || this.stickyHeader) && field.stickyColumn
// We only uses the helper components for sticky columns to
// improve performance of BTable/BTableLite by reducing the
// total number of vue instances created during render
const cellTag = stickyColumn
? field.isRowHeader
? BTh
: BTd
: field.isRowHeader
? 'th'
: 'td'
const cellVariant =
item._cellVariants && item._cellVariants[key]
? item._cellVariants[key]
: field.variant || null
const data = {
// For the Vue key, we concatenate the column index and
// field key (as field keys could be duplicated)
// TODO: Although we do prevent duplicate field keys...
// So we could change this to: `row-${rowIndex}-cell-${key}`
key: `row-${rowIndex}-cell-${colIndex}-${key}`,
class: [field.class ? field.class : '', this.getTdValues(item, key, field.tdClass, '')],
props: {},
attrs: {
'aria-colindex': String(colIndex + 1),
...(field.isRowHeader
? this.getThValues(item, key, field.thAttr, 'row', {})
: this.getTdValues(item, key, field.tdAttr, {}))
}
}
if (stickyColumn) {
// We are using the helper BTd or BTh
data.props = {
stackedHeading: this.isStacked ? field.label : null,
stickyColumn: true,
variant: cellVariant
}
} else {
// Using native TD or TH element, so we need to
// add in the attributes and variant class
data.attrs['data-label'] =
this.isStacked && !isUndefinedOrNull(field.label) ? toString(field.label) : null
data.attrs.role = field.isRowHeader ? 'rowheader' : 'cell'
data.attrs.scope = field.isRowHeader ? 'row' : null
// Add in the variant class
if (cellVariant) {
data.class.push(`${this.dark ? 'bg' : 'table'}-${cellVariant}`)
}
}
const slotScope = {
item: item,
index: rowIndex,
field: field,
unformatted: get(item, key, ''),
value: formatted,
toggleDetails: this.toggleDetailsFactory(hasDetailsSlot, item),
detailsShowing: Boolean(item._showDetails)
}
// If table supports selectable mode, then add in the following scope
// this.supportsSelectableRows will be undefined if mixin isn't loaded
if (this.supportsSelectableRows) {
slotScope.rowSelected = this.isRowSelected(rowIndex)
slotScope.selectRow = () => this.selectRow(rowIndex)
slotScope.unselectRow = () => this.unselectRow(rowIndex)
}
// The new `v-slot` syntax doesn't like a slot name starting with
// a square bracket and if using in-document HTML templates, the
// v-slot attributes are lower-cased by the browser.
// Switched to round bracket syntax to prevent confusion with
// dynamic slot name syntax.
// We look for slots in this order: `cell(${key})`, `cell(${key.toLowerCase()})`, 'cell()'
// Slot names are now cached by mixin tbody in `this.$_bodyFieldSlotNameCache`
// Will be `null` if no slot (or fallback slot) exists
const slotName = this.$_bodyFieldSlotNameCache[key]
let $childNodes = slotName ? this.normalizeSlot(slotName, slotScope) : toString(formatted)
if (this.isStacked) {
// We wrap in a DIV to ensure rendered as a single cell when visually stacked!
$childNodes = [h('div', {}, [$childNodes])]
}
// Render either a td or th cell
return h(cellTag, data, [$childNodes])
},
renderTbodyRow(item, rowIndex) {
// Renders an item's row (or rows if details supported)
const h = this.$createElement
const fields = this.computedFields
const tableStriped = this.striped
const hasDetailsSlot = this.hasNormalizedSlot(detailsSlotName)
const rowShowDetails = Boolean(item._showDetails && hasDetailsSlot)
const hasRowClickHandler = this.$listeners['row-clicked'] || this.hasSelectableRowClick
// We can return more than one TR if rowDetails enabled
const $rows = []
// Details ID needed for `aria-details` when details showing
// We set it to `null` when not showing so that attribute
// does not appear on the element
const detailsId = rowShowDetails ? this.safeId(`_details_${rowIndex}_`) : null
// For each item data field in row
const $tds = fields.map((field, colIndex) => {
return this.renderTbodyRowCell(field, colIndex, item, rowIndex)
})
// Calculate the row number in the dataset (indexed from 1)
let ariaRowIndex = null
if (this.currentPage && this.perPage && this.perPage > 0) {
ariaRowIndex = String((this.currentPage - 1) * this.perPage + rowIndex + 1)
}
// Create a unique :key to help ensure that sub components are re-rendered rather than
// re-used, which can cause issues. If a primary key is not provided we use the rendered
// rows index within the tbody.
// See: https://github.com/bootstrap-vue/bootstrap-vue/issues/2410
const primaryKey = this.primaryKey
const primaryKeyValue = toString(get(item, primaryKey)) || null
const rowKey = primaryKeyValue || String(rowIndex)
// If primary key is provided, use it to generate a unique ID on each tbody > tr
// In the format of '{tableId}__row_{primaryKeyValue}'
const rowId = primaryKeyValue ? this.safeId(`_row_${primaryKeyValue}`) : null
// Selectable classes and attributes
const selectableClasses = this.selectableRowClasses ? this.selectableRowClasses(rowIndex) : {}
const selectableAttrs = this.selectableRowAttrs ? this.selectableRowAttrs(rowIndex) : {}
// Add the item row
$rows.push(
h(
BTr,
{
key: `__b-table-row-${rowKey}__`,
ref: 'itemRows',
refInFor: true,
class: [
isFunction(this.tbodyTrClass) ? this.tbodyTrClass(item, 'row') : this.tbodyTrClass,
selectableClasses,
rowShowDetails ? 'b-table-has-details' : ''
],
props: { variant: item._rowVariant || null },
attrs: {
id: rowId,
tabindex: hasRowClickHandler ? '0' : null,
'data-pk': primaryKeyValue || null,
'aria-details': detailsId,
'aria-owns': detailsId,
'aria-rowindex': ariaRowIndex,
...selectableAttrs
},
on: {
// Note: These events are not A11Y friendly!
mouseenter: this.rowHovered,
mouseleave: this.rowUnhovered
}
},
$tds
)
)
// Row Details slot
if (rowShowDetails) {
const detailsScope = {
item: item,
index: rowIndex,
fields: fields,
toggleDetails: this.toggleDetailsFactory(hasDetailsSlot, item)
}
// If table supports selectable mode, then add in the following scope
// this.supportsSelectableRows will be undefined if mixin isn't loaded
if (this.supportsSelectableRows) {
detailsScope.rowSelected = this.isRowSelected(rowIndex)
detailsScope.selectRow = () => this.selectRow(rowIndex)
detailsScope.unselectRow = () => this.unselectRow(rowIndex)
}
// Render the details slot in a TD
const $details = h(BTd, { props: { colspan: fields.length }, class: this.detailsTdClass }, [
this.normalizeSlot(detailsSlotName, detailsScope)
])
// Add a hidden row to keep table row striping consistent when details showing
// Only added if the table is striped
if (tableStriped) {
$rows.push(
// We don't use `BTr` here as we don't need the extra functionality
h('tr', {
key: `__b-table-details-stripe__${rowKey}`,
staticClass: 'd-none',
attrs: { 'aria-hidden': 'true', role: 'presentation' }
})
)
}
// Add the actual details row
$rows.push(
h(
BTr,
{
key: `__b-table-details__${rowKey}`,
staticClass: 'b-table-details',
class: [
isFunction(this.tbodyTrClass)
? this.tbodyTrClass(item, detailsSlotName)
: this.tbodyTrClass
],
props: { variant: item._rowVariant || null },
attrs: { id: detailsId, tabindex: '-1' }
},
[$details]
)
)
} else if (hasDetailsSlot) {
// Only add the placeholder if a the table has a row-details slot defined (but not shown)
$rows.push(h())
if (tableStriped) {
// Add extra placeholder if table is striped
$rows.push(h())
}
}
// Return the row(s)
return $rows
}
}
}