Skip to content

feat(b-table): add selectAllRows() and clearSelected() to thead/tfoot slot scopes (addresses #3901) #3907

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Aug 17, 2019
Merged

feat(b-table): add selectAllRows() and clearSelected() to thead/tfoot slot scopes (addresses #3901) #3907

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3f991d0
feat(b-table): add `selectAllRows()` and `clearSelected()` to thead s…
tmorehouse Aug 16, 2019
817c77d
Update mixin-thead.js
tmorehouse Aug 16, 2019
b9646cd
Update README.md
tmorehouse Aug 16, 2019
e9676dd
Merge branch 'dev' into tmorehouse/table-head-scope
jacobmllr95 Aug 17, 2019
c12418e
Merge branch 'dev' into tmorehouse/table-head-scope
jacobmllr95 Aug 17, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 13 additions & 9 deletions src/components/table/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1070,11 +1070,13 @@ footer cells that do not have an explicit scoped slot provided.
The slots can be optionally scoped (`data` in the above example), and will have the following
properties:

| Property | Type | Description |
| -------- | ------ | ------------------------------------------------------------- |
| `column` | String | The fields's `key` value |
| `field` | Object | the field's object (from the `fields` prop) |
| `label` | String | The fields label value (also available as `data.field.label`) |
| Property | Type | Description |
| --------------- | ------ | ----------------------------------------------------------------------------------------- |
| `column` | String | The fields's `key` value |
| `field` | Object | the field's object (from the `fields` prop) |
| `label` | String | The fields label value (also available as `data.field.label`) |
| `selectAllRows` | Method | Select all rows (applicable if the table is in [`selectable`](#row-select-support) mode |
| `clearSelected` | Method | Unselect all rows (applicable if the table is in [`selectable`](#row-select-support) mode |

When placing inputs, buttons, selects or links within a `HEAD[...]` or `FOOT[...]` slot, note that
`head-clicked` event will not be emitted when the input, select, textarea is clicked (unless they
Expand Down Expand Up @@ -1138,10 +1140,12 @@ rather than native browser table child elements.

Slot `thead-top` can be optionally scoped, receiving an object with the following properties:

| Property | Type | Description |
| --------- | ------ | ----------------------------------------------------------------------------- |
| `columns` | Number | The number of columns in the rendered table |
| `fields` | Array | Array of field definition objects (normalized to the array of objects format) |
| Property | Type | Description |
| --------------- | ------ | ----------------------------------------------------------------------------------------- |
| `columns` | Number | The number of columns in the rendered table |
| `fields` | Array | Array of field definition objects (normalized to the array of objects format) |
| `selectAllRows` | Method | Select all rows (applicable if the table is in [`selectable`](#row-select-support) mode |
| `clearSelected` | Method | Unselect all rows (applicable if the table is in [`selectable`](#row-select-support) mode |

## Custom empty and emptyfiltered rendering via slots

Expand Down
14 changes: 12 additions & 2 deletions src/components/table/helpers/mixin-thead.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,10 @@ export default {
return h()
}

// Refernce to `selectAllRows` and `clearSelected()`, if table is Selectable
const selectAllRows = this.isSelectable ? this.selectAllRows : () => {}
const clearSelected = this.isSelectable ? this.clearSelected : () => {}

// Helper function to generate a field <th> cell
const makeCell = (field, colIndex) => {
let ariaLabel = null
Expand Down Expand Up @@ -116,7 +120,10 @@ export default {
label: field.label,
column: field.key,
field,
isFoot
isFoot,
// Add in row select methods
selectAllRows,
clearSelected
})
if (!slot) {
// need to check if this will work
Expand All @@ -135,7 +142,10 @@ export default {
} else {
const scope = {
columns: fields.length,
fields: fields
fields: fields,
// Add in row select methods
selectAllRows,
clearSelected
}
$trs.push(this.normalizeSlot('thead-top', scope) || h())
$trs.push(h(BTr, { class: this.theadTrClass }, $cells))
Expand Down