Skip to content

fix(ObjectStatus): add screen reader announcement for inactive state #5204

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 3 commits into from
Nov 2, 2023
Merged

fix(ObjectStatus): add screen reader announcement for inactive state #5204

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
86fb3d2
fix(ObjectStatus): add screen reader announcement for inactive state
Lukas742 Nov 2, 2023
53cbc6e
fix test
Lukas742 Nov 2, 2023
916c55b
Merge branch 'main' into fix/os-aria-desc
Lukas742 Nov 2, 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
8 changes: 4 additions & 4 deletions packages/main/src/components/ObjectStatus/ObjectStatus.cy.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ describe('ObjectStatus', () => {
cy.findByText('Content').click();
cy.get('@clickSpy').should('not.be.called');
cy.findByRole('button').should('not.exist');
cy.findByTestId('os').should('not.have.attr', 'aria-roledescription');
cy.findByText('Object Status').should('exist').and('not.be.visible');

cy.mount(
<ObjectStatus onClick={click} active>
Expand All @@ -243,14 +243,14 @@ describe('ObjectStatus', () => {
);
cy.findByText('Content').click();
cy.get('@clickSpy').should('have.been.calledOnce');
cy.findByRole('button').should('have.attr', 'aria-roledescription', 'Object Status Button');
cy.findByText('Object Status Button').should('exist').and('not.be.visible');
});

it('emptyIndicator', () => {
cy.mount(<ObjectStatus data-testid="os" />);
cy.findByTestId('os').children().should('have.length', 0);
cy.mount(<ObjectStatus data-testid="os" emptyIndicator />);
cy.findByTestId('os').children().should('have.length', 1);
cy.mount(<ObjectStatus data-testid="os" emptyIndicator />);
cy.findByTestId('os').children().should('have.length', 2);
cy.findByText('–').should('be.visible');
});

Expand Down
13 changes: 10 additions & 3 deletions packages/main/src/components/ObjectStatus/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,12 @@ import React, { forwardRef } from 'react';
import { createUseStyles } from 'react-jss';
import type { IndicationColor } from '../../enums/index.js';
import { ValueState } from '../../enums/index.js';
import { ARIA_OBJ_STATUS_DESC, EMPTY_VALUE, INDICATION_COLOR } from '../../i18n/i18n-defaults.js';
import {
ARIA_OBJ_STATUS_DESC,
ARIA_OBJ_STATUS_DESC_INACTIVE,
EMPTY_VALUE,
INDICATION_COLOR
} from '../../i18n/i18n-defaults.js';
import type { CommonProps } from '../../interfaces/index.js';
import { Icon } from '../../webComponents/Icon/index.js';
import styles from './ObjectStatus.jss.js';
Expand Down Expand Up @@ -210,10 +215,12 @@ const ObjectStatus = forwardRef<HTMLDivElement, ObjectStatusPropTypes>((props, r
onClick={active ? onClick : undefined}
tabIndex={active ? 0 : undefined}
data-icon-only={!children}
role={active ? 'button' : undefined}
aria-roledescription={active ? i18nBundle.getText(ARIA_OBJ_STATUS_DESC) : undefined}
role={active ? 'button' : 'group'}
{...rest}
>
<span className={classes.pseudoInvisibleText} data-component-name="ObjectStatusInvisibleDescriptionContainer">
{active ? i18nBundle.getText(ARIA_OBJ_STATUS_DESC) : i18nBundle.getText(ARIA_OBJ_STATUS_DESC_INACTIVE)}
</span>
{iconToRender && (
<span className={classes.icon} data-icon-only={!children} data-component-name="ObjectStatusIconContainer">
{iconToRender}
Expand Down
5 changes: 4 additions & 1 deletion packages/main/src/i18n/messagebundle.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,9 +273,12 @@ NUMERICCONTENT_DEVIATION_UP=Ascending
#XTOL: Tooltip Numeric Content Deviation Down
NUMERICCONTENT_DEVIATION_DOWN=Descending

#XACT: Aria role description for ObjectStatus component
#XACT: Aria role description for active ObjectStatus component
ARIA_OBJ_STATUS_DESC=Object Status Button

#XACT: Aria role description for inactive ObjectStatus component
ARIA_OBJ_STATUS_DESC_INACTIVE=Object Status

#XACT: Invisible text for ObjectStatus indication color
INDICATION_COLOR=Indication Color

Expand Down