Skip to content

[EuiBasicTable] unify handling of tableCaptions whether or not the user specifies them #9254

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
alexwizp merged 14 commits into from
Dec 8, 2025
Merged

[EuiBasicTable] unify handling of tableCaptions whether or not the user specifies them #9254

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
6031177
[BasicTable] unify handling of `tableCaptions` whether or not the use…
alexwizp Dec 2, 2025
149a74a
changelog
alexwizp Dec 2, 2025
8e672dc
update comment
alexwizp Dec 2, 2025
880959a
cleanup
alexwizp Dec 2, 2025
974e3b6
cleanup
alexwizp Dec 3, 2025
b4bae81
cleanup
alexwizp Dec 3, 2025
58ec23b
cleanup
alexwizp Dec 3, 2025
2161d99
cleanup
alexwizp Dec 3, 2025
07522a4
cleanup
alexwizp Dec 3, 2025
1e20290
cleanup
alexwizp Dec 3, 2025
d703dfa
Merge branch 'main' into dec-2
alexwizp Dec 4, 2025
c2f81d5
Update packages/eui/changelogs/upcoming/9254.md
alexwizp Dec 8, 2025
58385c2
Update basic_table.tsx
alexwizp Dec 8, 2025
fbbeb08
Merge branch 'main' into dec-2
alexwizp Dec 8, 2025
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
3 changes: 3 additions & 0 deletions packages/eui/changelogs/upcoming/9254.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
**Accessibility**

- Improved `EuiBasicTable` accessibility by ensuring a fallback `tableCaption` is applied if none is provided
77 changes: 37 additions & 40 deletions packages/eui/src/components/basic_table/basic_table.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ interface BasicTableProps<T extends object>
*/
error?: string;
/**
* Describes the content of the table. If not specified, the caption will be "This table contains {itemCount} rows."
* Provides a description of the table’s content. If no description is provided, the table will default to the name Data Table.
*/
tableCaption?: string;
/**
Expand Down Expand Up @@ -327,7 +327,7 @@ export class EuiBasicTable<T extends object = any> extends Component<
prevState: State<T>
) {
if (!nextProps.selection) {
// next props doesn't have a selection, reset our state
// next props don't have a selection, reset our state
return { selection: [] };
}

Expand Down Expand Up @@ -631,53 +631,50 @@ export class EuiBasicTable<T extends object = any> extends Component<
? Math.ceil(pagination.totalItemCount / this.pageSize)
: 1;

let captionElement;
if (tableCaption) {
if (pagination) {
captionElement = (
let itemCountPart: React.ReactNode = null;
if (!itemCount) {
itemCountPart = this.props.noItemsMessage;
} else if (pagination && totalItemCount > 0) {
itemCountPart = (
<p>
<EuiI18n
token="euiBasicTable.tableCaptionWithPagination"
default="{tableCaption}; Page {page} of {pageCount}."
values={{ tableCaption, page, pageCount }}
token="euiBasicTable.caption.itemCountPart.withTotalItemCount"
default="Showing {itemCount} of {totalItemCount} data rows."
values={{ itemCount, totalItemCount }}
/>
);
} else {
captionElement = tableCaption;
}
} else {
if (pagination) {
if (pagination.totalItemCount > 0) {
captionElement = (
<EuiI18n
token="euiBasicTable.tableAutoCaptionWithPagination"
default="This table contains {itemCount} rows out of {totalItemCount} rows; Page {page} of {pageCount}."
values={{ totalItemCount, itemCount, page, pageCount }}
/>
);
} else {
captionElement = (
<EuiI18n
token="euiBasicTable.tableSimpleAutoCaptionWithPagination"
default="This table contains {itemCount} rows; Page {page} of {pageCount}."
values={{ itemCount, page, pageCount }}
/>
);
}
} else {
captionElement = (
</p>
);
}

let paginationPart: React.ReactNode = null;
if (pagination && pageCount > 1) {
paginationPart = (
<p>
<EuiI18n
token="euiBasicTable.tableAutoCaptionWithoutPagination"
default="This table contains {itemCount} rows."
values={{ itemCount }}
token="euiBasicTable.caption.paginationPart.withPageCount"
default="Page {page} of {pageCount}."
values={{ page, pageCount }}
/>
);
}
</p>
);
}

return (
<EuiScreenReaderOnly>
<caption css={euiTableCaptionStyles} className="euiTableCaption">
{tabularCopyMarkers.hiddenNoCopyBoundary}
<EuiDelayRender>{captionElement}</EuiDelayRender>
<EuiDelayRender>
<p>
{tableCaption || (
<EuiI18n
token="euiBasicTable.caption.tableName"
default="Data table"
/>
)}
</p>
{itemCountPart}
{paginationPart}
</EuiDelayRender>
{tabularCopyMarkers.hiddenNoCopyBoundary}
</caption>
</EuiScreenReaderOnly>
Expand Down