diff --git a/src/components/table/README.md b/src/components/table/README.md index 2a2532ac274..ad87647c8f2 100755 --- a/src/components/table/README.md +++ b/src/components/table/README.md @@ -273,7 +273,9 @@ The following field properties are recognized: | Property | Type | Description | ---------| ---- | ----------- | `key` | String | The key for selecting data from the record in the items array. Required when setting the `fields` from as an array of objects. -| `label` | String | Appears in the columns table header (and footer if `foot-clone` is set). Defaults to the field's key (in humanized format) if not provided. It's possible to use empty labels by assigning an empty string `""` +| `label` | String | Appears in the columns table header (and footer if `foot-clone` is set). Defaults to the field's key (in humanized format) if not provided. It's possible to use empty labels by assigning an empty string `""` but be sure you also set `headerTitle` to provide non-sighted users a hint about the column contents. +| `headerTitle` | Text to place on the fields header `` attribute `title`. Defaults to no `title` attribute. +| `headerAbbr` | Text to place on the fields header `` attribute `abbr`. Set this to the unabbreviated version of the label (or title) if label (or title) is an abbreviation. Defaults to no `abbr` attribute. | `class` | String or Array | Class name (or array of class names) to add to `` **and** `` in the column. | `formatter` | String or Function | A formatter callback function, can be used instead of (or in conjunction with) slots for real table fields (i.e. fields, that have corresponding data at items array). Refer to [**Custom Data Rendering**](#custom-data-rendering) for more details. | `sortable` | Boolean | Enable sorting on this column. Refer to the [**Sorting**](#sorting) Section for more details. @@ -486,9 +488,8 @@ export default { ``` ->**Responsive table notes:** -> - _Possible vertical clipping/truncation_. Responsive tables make use of `overflow-y: hidden`, which clips off any content that goes beyond the bottom or top edges of the table. In particular, this can clip off dropdown menus and other third-party widgets. -> - When in responsive mode the table will lose it's width of 100%. This is a known issue with bootstrap V4 css and placing the `table-responsive` class on the `` element as recommended by Bootstrap. +**Responsive table notes:** +- _Possible vertical clipping/truncation_. Responsive tables make use of `overflow-y: hidden`, which clips off any content that goes beyond the bottom or top edges of the table. In particular, this may clip off dropdown menus and other third-party widgets. ## Stacked tables @@ -680,12 +681,12 @@ The slot's scope variable (`data` in the above sample) will have the following p | `toggleDetails` | Function | Can be called to toggle the visibility of the rows `row-details` scoped slot. See section [**Row details support**](#row-details-support) below for additional information ->**Notes:** ->- _`index` will not always be the actual row's index number, as it is +**Notes:** +- _`index` will not always be the actual row's index number, as it is computed after pagination and filtering have been applied to the original table data. The `index` value will refer to the **displayed row number**. This number will align with the indexes from the optional `v-model` bound variable._ ->- _When placing inputs, buttons, selects or links within a data cell scoped slot, +- _When placing inputs, buttons, selects or links within a data cell scoped slot, be sure to add a `@click.stop` (or `@click.native.stop` if needed) handler (which can be empty) to prevent the click on the input, button, select, or link, from triggering the `row-clicked` event:_ @@ -698,8 +699,8 @@ the `row-clicked` event:_ ``` #### Displaying raw HTML -By default `b-table` escapes HTML tags in items, if you need to display raw HTML code in `b-table`, you should use -`v-html` directive on an element in a in scoped field slot +By default `b-table` escapes HTML tags in items data and results of formatter functions, if you need to display +raw HTML code in `b-table`, you should use `v-html` directive on an element in a in scoped field slot ```html