Skip to content

Improve EuiBasicTable caption #2782

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
andreadelrio merged 11 commits into from
Jan 29, 2020
Merged

Improve EuiBasicTable caption #2782

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
5757dc8
improve EuiBasicTable caption
andreadelrio Jan 22, 2020
449d508
cl
andreadelrio Jan 22, 2020
49e571d
Merge remote-tracking branch 'upstream/master' into basic-table-caption
andreadelrio Jan 23, 2020
d89a6c9
added tableCaption prop and updated cl
andreadelrio Jan 23, 2020
d79f679
changed default caption to list column names
andreadelrio Jan 25, 2020
84b2998
updated cl
andreadelrio Jan 25, 2020
2fa4d05
listing number of rows as caption
andreadelrio Jan 27, 2020
bd29385
updated prop description in docs
andreadelrio Jan 27, 2020
d7e5b05
Merge remote-tracking branch 'upstream/master' into basic-table-caption
andreadelrio Jan 29, 2020
247cbe1
removed i18n from tableCaption
andreadelrio Jan 29, 2020
153cdf0
fixing tests
andreadelrio Jan 29, 2020
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
- Converted `EuiFilterSelectItem` to TypeScript ([#2761](https://github.com/elastic/eui/pull/2761))
- Converted `EuiFieldSearch` to TypeScript ([#2775](https://github.com/elastic/eui/pull/2775))
- Added `data-test-subj` to the `EuiContextMenuItem` in `EuiTablePagination` ([#2778](https://github.com/elastic/eui/pull/2778))
- Improved `EuiBasicTable` <caption> ([#2782](https://github.com/elastic/eui/pull/2782))

**Bug fixes**

Expand Down
58 changes: 35 additions & 23 deletions src/components/basic_table/__snapshots__/basic_table.test.tsx.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ exports[`EuiBasicTable cellProps renders cells with custom props from a callback
delay={500}
>
<EuiI18n
default="Below is a table of {itemCount} items."
default="Below is a table containing {itemCount} rows."
token="euiBasicTable.tableDescription"
values={
Object {
Expand Down Expand Up @@ -157,7 +157,7 @@ exports[`EuiBasicTable cellProps renders rows with custom props from an object 1
delay={500}
>
<EuiI18n
default="Below is a table of {itemCount} items."
default="Below is a table containing {itemCount} rows."
token="euiBasicTable.tableDescription"
values={
Object {
Expand Down Expand Up @@ -282,7 +282,7 @@ exports[`EuiBasicTable empty is rendered 1`] = `
delay={500}
>
<EuiI18n
default="Below is a table of {itemCount} items."
default="Below is a table containing {itemCount} rows."
token="euiBasicTable.tableDescription"
values={
Object {
Expand Down Expand Up @@ -352,7 +352,7 @@ exports[`EuiBasicTable empty renders a node as a custom message 1`] = `
delay={500}
>
<EuiI18n
default="Below is a table of {itemCount} items."
default="Below is a table containing {itemCount} rows."
token="euiBasicTable.tableDescription"
values={
Object {
Expand Down Expand Up @@ -430,7 +430,7 @@ exports[`EuiBasicTable empty renders a string as a custom message 1`] = `
delay={500}
>
<EuiI18n
default="Below is a table of {itemCount} items."
default="Below is a table containing {itemCount} rows."
token="euiBasicTable.tableDescription"
values={
Object {
Expand Down Expand Up @@ -500,7 +500,7 @@ exports[`EuiBasicTable footers do not render without a column footer definition
delay={500}
>
<EuiI18n
default="Below is a table of {itemCount} items."
default="Below is a table containing {itemCount} rows."
token="euiBasicTable.tableDescription"
values={
Object {
Expand Down Expand Up @@ -727,11 +727,12 @@ exports[`EuiBasicTable footers render with pagination, selection, sorting, and f
delay={500}
>
<EuiI18n
default="Below is a table of {itemCount} items."
default="Below is a table containing {itemCount} rows out of {totalItemCount}."
token="euiBasicTable.tableDescription"
values={
Object {
"itemCount": 3,
"totalItemCount": 5,
}
}
/>
Expand Down Expand Up @@ -1018,7 +1019,7 @@ exports[`EuiBasicTable itemIdToExpandedRowMap renders an expanded row 1`] = `
delay={500}
>
<EuiI18n
default="Below is a table of {itemCount} items."
default="Below is a table containing {itemCount} rows."
token="euiBasicTable.tableDescription"
values={
Object {
Expand Down Expand Up @@ -1146,7 +1147,7 @@ exports[`EuiBasicTable rowProps renders rows with custom props from a callback 1
delay={500}
>
<EuiI18n
default="Below is a table of {itemCount} items."
default="Below is a table containing {itemCount} rows."
token="euiBasicTable.tableDescription"
values={
Object {
Expand Down Expand Up @@ -1275,7 +1276,7 @@ exports[`EuiBasicTable rowProps renders rows with custom props from an object 1`
delay={500}
>
<EuiI18n
default="Below is a table of {itemCount} items."
default="Below is a table containing {itemCount} rows."
token="euiBasicTable.tableDescription"
values={
Object {
Expand Down Expand Up @@ -1404,11 +1405,12 @@ exports[`EuiBasicTable with pagination - 2nd page 1`] = `
delay={500}
>
<EuiI18n
default="Below is a table of {itemCount} items."
default="Below is a table containing {itemCount} rows out of {totalItemCount}."
token="euiBasicTable.tableDescription"
values={
Object {
"itemCount": 2,
"totalItemCount": 5,
}
}
/>
Expand Down Expand Up @@ -1512,11 +1514,12 @@ exports[`EuiBasicTable with pagination 1`] = `
delay={500}
>
<EuiI18n
default="Below is a table of {itemCount} items."
default="Below is a table containing {itemCount} rows out of {totalItemCount}."
token="euiBasicTable.tableDescription"
values={
Object {
"itemCount": 3,
"totalItemCount": 5,
}
}
/>
Expand Down Expand Up @@ -1637,11 +1640,12 @@ exports[`EuiBasicTable with pagination and error 1`] = `
delay={500}
>
<EuiI18n
default="Below is a table of {itemCount} items."
default="Below is a table containing {itemCount} rows out of {totalItemCount}."
token="euiBasicTable.tableDescription"
values={
Object {
"itemCount": 3,
"totalItemCount": 5,
}
}
/>
Expand Down Expand Up @@ -1719,11 +1723,12 @@ exports[`EuiBasicTable with pagination and selection 1`] = `
delay={500}
>
<EuiI18n
default="Below is a table of {itemCount} items."
default="Below is a table containing {itemCount} rows out of {totalItemCount}."
token="euiBasicTable.tableDescription"
values={
Object {
"itemCount": 3,
"totalItemCount": 5,
}
}
/>
Expand Down Expand Up @@ -1887,11 +1892,12 @@ exports[`EuiBasicTable with pagination, hiding the per page options 1`] = `
delay={500}
>
<EuiI18n
default="Below is a table of {itemCount} items."
default="Below is a table containing {itemCount} rows out of {totalItemCount}."
token="euiBasicTable.tableDescription"
values={
Object {
"itemCount": 3,
"totalItemCount": 5,
}
}
/>
Expand Down Expand Up @@ -2034,11 +2040,12 @@ exports[`EuiBasicTable with pagination, selection and sorting 1`] = `
delay={500}
>
<EuiI18n
default="Below is a table of {itemCount} items."
default="Below is a table containing {itemCount} rows out of {totalItemCount}."
token="euiBasicTable.tableDescription"
values={
Object {
"itemCount": 3,
"totalItemCount": 5,
}
}
/>
Expand Down Expand Up @@ -2226,11 +2233,12 @@ exports[`EuiBasicTable with pagination, selection, sorting and a single record a
delay={500}
>
<EuiI18n
default="Below is a table of {itemCount} items."
default="Below is a table containing {itemCount} rows out of {totalItemCount}."
token="euiBasicTable.tableDescription"
values={
Object {
"itemCount": 3,
"totalItemCount": 5,
}
}
/>
Expand Down Expand Up @@ -2511,11 +2519,12 @@ exports[`EuiBasicTable with pagination, selection, sorting and column dataType 1
delay={500}
>
<EuiI18n
default="Below is a table of {itemCount} items."
default="Below is a table containing {itemCount} rows out of {totalItemCount}."
token="euiBasicTable.tableDescription"
values={
Object {
"itemCount": 3,
"totalItemCount": 5,
}
}
/>
Expand Down Expand Up @@ -2703,11 +2712,12 @@ exports[`EuiBasicTable with pagination, selection, sorting and column renderer 1
delay={500}
>
<EuiI18n
default="Below is a table of {itemCount} items."
default="Below is a table containing {itemCount} rows out of {totalItemCount}."
token="euiBasicTable.tableDescription"
values={
Object {
"itemCount": 3,
"totalItemCount": 5,
}
}
/>
Expand Down Expand Up @@ -2895,11 +2905,12 @@ exports[`EuiBasicTable with pagination, selection, sorting and multiple record a
delay={500}
>
<EuiI18n
default="Below is a table of {itemCount} items."
default="Below is a table containing {itemCount} rows out of {totalItemCount}."
token="euiBasicTable.tableDescription"
values={
Object {
"itemCount": 3,
"totalItemCount": 5,
}
}
/>
Expand Down Expand Up @@ -3198,11 +3209,12 @@ exports[`EuiBasicTable with pagination, selection, sorting, column renderer and
delay={500}
>
<EuiI18n
default="Below is a table of {itemCount} items."
default="Below is a table containing {itemCount} rows out of {totalItemCount}."
token="euiBasicTable.tableDescription"
values={
Object {
"itemCount": 3,
"totalItemCount": 5,
}
}
/>
Expand Down Expand Up @@ -3369,7 +3381,7 @@ exports[`EuiBasicTable with sortable columns and sorting disabled 1`] = `
delay={500}
>
<EuiI18n
default="Below is a table of {itemCount} items."
default="Below is a table containing {itemCount} rows."
token="euiBasicTable.tableDescription"
values={
Object {
Expand Down Expand Up @@ -3497,7 +3509,7 @@ exports[`EuiBasicTable with sorting 1`] = `
delay={500}
>
<EuiI18n
default="Below is a table of {itemCount} items."
default="Below is a table containing {itemCount} rows."
token="euiBasicTable.tableDescription"
values={
Object {
Expand Down
33 changes: 25 additions & 8 deletions src/components/basic_table/basic_table.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -534,21 +534,38 @@ export class EuiBasicTable<T = any> extends Component<

renderTableCaption() {
const { items } = this.props;

const { pagination } = this.props;
let paginationElement;
if (pagination && pagination.totalItemCount > 0) {
paginationElement = (
<EuiI18n
token="euiBasicTable.tableDescription"
default="Below is a table containing {itemCount} rows out of {totalItemCount}."
values={{
totalItemCount: pagination.totalItemCount,
itemCount: items.length,
}}
/>
);
} else {
paginationElement = (
<EuiI18n
token="euiBasicTable.tableDescription"
default="Below is a table containing {itemCount} rows."
values={{
itemCount: items.length,
}}
/>
);
}
return (
<EuiScreenReaderOnly>
<caption
className="euiTableCaption"
role="status"
aria-relevant="text"
aria-live="polite">
Comment thread
myasonik marked this conversation as resolved.
Outdated
<EuiDelayRender>
<EuiI18n
token="euiBasicTable.tableDescription"
default="Below is a table of {itemCount} items."
values={{ itemCount: items.length }}
/>
</EuiDelayRender>
<EuiDelayRender>{paginationElement}</EuiDelayRender>
</caption>
</EuiScreenReaderOnly>
);
Expand Down