Skip to content

feat(AnalyticalTable): add headerLabel column property #5011

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 4 commits into from
Aug 28, 2023
Merged

feat(AnalyticalTable): add headerLabel column property #5011

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a15d3f4
feat(AnalyticalTable): add `headerLabel` column property
Lukas742 Aug 25, 2023
9f96f08
tests
Lukas742 Aug 25, 2023
1859b77
Update AnalyticalTable.cy.tsx
Lukas742 Aug 25, 2023
464effb
tests: don't mutate `columns`
Lukas742 Aug 28, 2023
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
28 changes: 19 additions & 9 deletions packages/main/src/components/AnalyticalTable/AnalyticalTable.cy.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,8 @@ const columns = [
},
{
Header: () => <span>Friend Age</span>, // Custom header components!
accessor: 'friend.age'
accessor: 'friend.age',
headerLabel: 'Custom Label'
}
];
const data = [
Expand Down Expand Up @@ -1258,8 +1259,9 @@ describe('AnalyticalTable', () => {
});
});
it('columns drag & drop', () => {
columns.pop();
const updatedCols = [...columns, { accessor: 'friend.age', Header: 'Friend Age', disableDragAndDrop: true }];
const localCols = [...columns];
localCols.pop();
const updatedCols = [...localCols, { accessor: 'friend.age', Header: 'Friend Age', disableDragAndDrop: true }];
const reorder = cy.spy().as('reorder');
['ltr', 'rtl'].forEach((dir) => {
cy.mount(<AnalyticalTable dir={dir} data={data} columns={updatedCols} onColumnsReorder={reorder} />);
Expand Down Expand Up @@ -1742,7 +1744,7 @@ describe('AnalyticalTable', () => {
cy.findByText('Selected: {"0":true,"1":true,"2":true,"3":true}').should('be.visible');
});

it('a11y: grouped, filtered, sorted', () => {
it('a11y: grouped, filtered, sorted, headerLabel', () => {
cy.mount(<AnalyticalTable columns={columns} data={data} groupable filterable sortable />);
cy.findByText('Name').click();
cy.findByText('Sort Ascending').shadow().findByRole('listitem').click({ force: true });
Expand All @@ -1767,24 +1769,32 @@ describe('AnalyticalTable', () => {
cy.get('[data-visible-row-index="1"][data-visible-column-index="0"]').should(
'have.attr',
'aria-label',
'Grouped, To expand the row, press the spacebar'
'Name Grouped, To expand the row, press the spacebar'
);
cy.get('[name="navigation-right-arrow"]').click();
cy.get('[data-visible-row-index="1"][data-visible-column-index="0"]').should(
'have.attr',
'aria-label',
'Grouped, To collapse the row, press the spacebar'
'Name Grouped, To collapse the row, press the spacebar'
);
cy.findByText('Name').click();
cy.findByText('Ungroup').shadow().findByRole('listitem').click({ force: true });
cy.get('[data-visible-row-index="1"][data-visible-column-index="0"]').should('not.have.attr', 'aria-label');
cy.get('[data-visible-row-index="1"][data-visible-column-index="0"]').should('have.attr', 'aria-label', 'Name ');
cy.get('[data-column-id="name"]')
.should('have.attr', 'aria-sort', 'descending')
.and('have.attr', 'aria-label', 'Filtered');

cy.findByText('Name').click();
cy.findByText('Sort Ascending').shadow().get('[ui5-input]').typeIntoUi5Input('{selectall}{backspace}{enter}');
cy.get('[data-column-id="name"]').should('have.attr', 'aria-sort', 'descending').and('not.have.attr', 'aria-label');
cy.get('[data-column-id="name"]').should('have.attr', 'aria-sort', 'descending').and('have.attr', 'aria-label', '');

cy.get('[data-column-id="friend.age"]').should('have.attr', 'aria-label', 'Custom Label ');
cy.realPress('ArrowDown');
cy.get('[data-visible-row-index="1"][data-visible-column-index="3"]').should(
'have.attr',
'aria-label',
'Custom Label '
);
});

it("Expandable: don't scroll when expanded/collapsed", () => {
Expand Down Expand Up @@ -2234,7 +2244,7 @@ describe('AnalyticalTable', () => {
cy.focused().should('have.attr', 'data-row-index', '0').should('have.attr', 'data-column-index', '0');

cy.realPress('End');
cy.focused().should('have.attr', 'data-row-index', '0').should('have.attr', 'data-column-index', '2');
cy.focused().should('have.attr', 'data-row-index', '0').should('have.attr', 'data-column-index', '3');
cy.realPress('Home');
cy.focused().should('have.attr', 'data-row-index', '0').should('have.attr', 'data-column-index', '0');

Expand Down
1 change: 1 addition & 0 deletions packages/main/src/components/AnalyticalTable/AnalyticalTable.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ const meta = {
},
{
Header: () => <span>Friend Age</span>,
headerLabel: 'Friend Age',
accessor: 'friend.age',
hAlign: TextAlign.End,
filter: (rows, accessor, filterValue) => {
Expand Down
23 changes: 16 additions & 7 deletions packages/main/src/components/AnalyticalTable/hooks/useA11y.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ interface UpdatedCellProptypes {
'aria-colindex'?: number;
}

const setCellProps = (cellProps, { cell: { column, row, value }, instance }) => {
const setCellProps = (cellProps, { cell, instance }) => {
const { column, row, value } = cell;
const columnIndex = instance.visibleColumns.findIndex(({ id }) => id === column.id);
const { alwaysShowSubComponent, renderRowSubComponent, translatableTexts, selectionMode, selectionBehavior } =
instance.webComponentsReactProperties;
Expand All @@ -26,6 +27,10 @@ const setCellProps = (cellProps, { cell: { column, row, value }, instance }) =>

const isFirstUserCol = userCols[0]?.id === column.id || userCols[0]?.accessor === column.accessor;
updatedCellProps['data-is-first-column'] = isFirstUserCol;
updatedCellProps['aria-label'] = column.headerLabel || (typeof column.Header === 'string' ? column.Header : '');
if (updatedCellProps['aria-label']) {
updatedCellProps['aria-label'] += ' ';
}

if ((isFirstUserCol && rowIsExpandable) || (row.isGrouped && row.canExpand)) {
updatedCellProps.onKeyDown = row.getToggleRowExpandedProps?.()?.onKeyDown;
Expand All @@ -40,7 +45,7 @@ const setCellProps = (cellProps, { cell: { column, row, value }, instance }) =>
updatedCellProps['aria-expanded'] = 'false';
ariaLabel += ` ${translatableTexts.expandA11yText}`;
}
updatedCellProps['aria-label'] = ariaLabel;
updatedCellProps['aria-label'] += ariaLabel;
} else if (
(selectionMode !== AnalyticalTableSelectionMode.None &&
selectionBehavior !== AnalyticalTableSelectionBehavior.RowSelector &&
Expand All @@ -49,13 +54,12 @@ const setCellProps = (cellProps, { cell: { column, row, value }, instance }) =>
) {
if (row.isSelected) {
updatedCellProps['aria-selected'] = 'true';
updatedCellProps['aria-label'] = `${value ?? ''} ${translatableTexts.unselectA11yText}`;
updatedCellProps['aria-label'] += `${value ?? ''} ${translatableTexts.unselectA11yText}`;
} else {
updatedCellProps['aria-selected'] = 'false';
updatedCellProps['aria-label'] = `${value ?? ''} ${translatableTexts.selectA11yText}`;
updatedCellProps['aria-label'] += `${value ?? ''} ${translatableTexts.selectA11yText}`;
}
}

return [cellProps, updatedCellProps];
};

Expand All @@ -68,17 +72,22 @@ const setHeaderProps = (headerProps, { column, instance }) => {
const isFiltered = column?.filterValue && column?.filterValue.length > 0;

const updatedProps = {};
updatedProps['aria-label'] = column.headerLabel ??= '';
if (updatedProps['aria-label']) {
updatedProps['aria-label'] += ' ';
}

if (column.isSorted) {
updatedProps['aria-sort'] = column.isSortedDesc ? 'descending' : 'ascending';
}
if (isFiltered) {
updatedProps['aria-label'] = translatableTexts.filteredA11yText;
updatedProps['aria-label'] += translatableTexts.filteredA11yText;
}
if (column.isGrouped) {
if (updatedProps['aria-label']) {
updatedProps['aria-label'] += ` ${translatableTexts.groupedA11yText}`;
} else {
updatedProps['aria-label'] = translatableTexts.groupedA11yText;
updatedProps['aria-label'] += translatableTexts.groupedA11yText;
}
}

Expand Down
8 changes: 8 additions & 0 deletions packages/main/src/components/AnalyticalTable/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,14 @@ export interface AnalyticalTableColumnDefinition {
* Can either be string or a React component that will be rendered as column header
*/
Header?: string | ComponentType<any> | ((props?: any) => ReactNode);
/**
* Defines the `aria-label` for the whole column read by screen readers.
*
* __Note:__ This prop is mandatory if you pass anything else than `string` to the `Header` property. In this case the `headerLabel` should at least contain the column name.
*
* __Note:__ If `headerLabel` is defined, screen readers will always read the passed string, even when `Header` is a `string`.
*/
headerLabel?: string;
/**
* Tooltip for the column header. If not set, the display text will be the same as the Header if it is a `string`.
*/
Expand Down