Skip to content
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

Jump to bottom

feat(MultipleFileUpload): add aria live region to internal Progress #8242

Merged
merged 4 commits into from
Oct 24, 2022
Merged

feat(MultipleFileUpload): add aria live region to internal Progress #8242

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
69d321f
feat(MultipleFileUpload): add aria live region to internal Progress
kmcfaul Oct 17, 2022
6836e2c
add floor/cap load percentage
kmcfaul Oct 19, 2022
5768902
update description
kmcfaul Oct 21, 2022
5d95299
update and add tests
kmcfaul Oct 24, 2022
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
10 changes: 10 additions & 0 deletions packages/react-core/src/components/MultipleFileUpload/MultipleFileUploadStatusItem.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ export interface MultipleFileUploadStatusItemProps extends React.HTMLProps<HTMLL
progressAriaLabel?: string;
/** Associates the progress bar with it's label for accessibility purposes. Required when title not used */
progressAriaLabelledBy?: string;
/** Adds an accessible aria live region to indicate updates to the progress bar. */
kmcfaul marked this conversation as resolved.
Show resolved Hide resolved
progressAriaLiveMessage?: string | ((loadPercentage: number) => string);
/** Unique identifier for progress. Generated if not specified. */
progressId?: string;
}
Expand All @@ -71,6 +73,7 @@ export const MultipleFileUploadStatusItem: React.FunctionComponent<MultipleFileU
progressAriaLabel,
progressAriaLabelledBy,
progressId,
progressAriaLiveMessage,
buttonAriaLabel = 'Remove from list',
...props
}: MultipleFileUploadStatusItemProps) => {
Expand Down Expand Up @@ -139,6 +142,13 @@ export const MultipleFileUploadStatusItem: React.FunctionComponent<MultipleFileU
<li className={css(styles.multipleFileUploadStatusItem, className)} {...props}>
<div className={styles.multipleFileUploadStatusItemIcon}>{fileIcon || <FileIcon />}</div>
<div className={styles.multipleFileUploadStatusItemMain}>
<div className="pf-screen-reader" aria-live="polite">
{progressAriaLiveMessage &&
typeof progressAriaLiveMessage === 'function' &&
progressAriaLiveMessage(+loadPercentage.toFixed(2))}
{progressAriaLiveMessage && typeof progressAriaLiveMessage === 'string' && progressAriaLiveMessage}
{!progressAriaLiveMessage && `Progress value is ${progressValue || Math.floor(loadPercentage)}%.`}
</div>
<Progress
title={title}
value={progressValue || loadPercentage}
Expand Down
3 changes: 2 additions & 1 deletion ...ct-core/src/components/MultipleFileUpload/__tests__/MultipleFileUploadStatusItem.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ describe('MultipleFileUploadStatusItem', () => {
expect(asFragment()).toMatchSnapshot();
});

test('renders custom file name/size/icon when passed', () => {
test('renders custom file name/size/icon/ariaLiveMessage when passed', () => {
kmcfaul marked this conversation as resolved.
Show resolved Hide resolved
const testFile = new File(['foo'], 'testFile.txt');
const { asFragment } = render(
<MultipleFileUploadStatusItem
Expand All @@ -32,6 +32,7 @@ describe('MultipleFileUploadStatusItem', () => {
fileName="testCustomFileName.txt"
fileSize={42}
progressId="test-progress-id"
progressAriaLiveMessage="test message"
/>
);

Expand Down
38 changes: 37 additions & 1 deletion ...nts/MultipleFileUpload/__tests__/__snapshots__/MultipleFileUploadStatusItem.test.tsx.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,12 @@ exports[`MultipleFileUploadStatusItem renders custom aria labels 1`] = `
<div
class="pf-c-multiple-file-upload__status-item-main"
>
<div
aria-live="polite"
class="pf-screen-reader"
>
Progress value is 0%.
</div>
<div
class="pf-c-progress"
id="test-progress-id"
Expand Down Expand Up @@ -135,6 +141,12 @@ exports[`MultipleFileUploadStatusItem renders custom class names 1`] = `
<div
class="pf-c-multiple-file-upload__status-item-main"
>
<div
aria-live="polite"
class="pf-screen-reader"
>
Progress value is 0%.
</div>
<div
class="pf-c-progress"
id="test-progress-id"
Expand Down Expand Up @@ -217,7 +229,7 @@ exports[`MultipleFileUploadStatusItem renders custom class names 1`] = `
</DocumentFragment>
`;

exports[`MultipleFileUploadStatusItem renders custom file name/size/icon when passed 1`] = `
exports[`MultipleFileUploadStatusItem renders custom file name/size/icon/ariaLiveMessage when passed 1`] = `
<DocumentFragment>
<li
class="pf-c-multiple-file-upload__status-item"
Expand All @@ -242,6 +254,12 @@ exports[`MultipleFileUploadStatusItem renders custom file name/size/icon when pa
<div
class="pf-c-multiple-file-upload__status-item-main"
>
<div
aria-live="polite"
class="pf-screen-reader"
>
test message
</div>
<div
class="pf-c-progress"
id="test-progress-id"
Expand Down Expand Up @@ -351,6 +369,12 @@ exports[`MultipleFileUploadStatusItem renders custom progress value/variant when
<div
class="pf-c-multiple-file-upload__status-item-main"
>
<div
aria-live="polite"
class="pf-screen-reader"
>
Progress value is 42%.
</div>
<div
class="pf-c-progress pf-m-warning"
id="test-progress-id"
Expand Down Expand Up @@ -477,6 +501,12 @@ exports[`MultipleFileUploadStatusItem renders expected values from a passed file
<div
class="pf-c-multiple-file-upload__status-item-main"
>
<div
aria-live="polite"
class="pf-screen-reader"
>
Progress value is 0%.
</div>
<div
class="pf-c-progress"
id="test-progress-id"
Expand Down Expand Up @@ -586,6 +616,12 @@ exports[`MultipleFileUploadStatusItem renders with expected class names 1`] = `
<div
class="pf-c-multiple-file-upload__status-item-main"
>
<div
aria-live="polite"
class="pf-screen-reader"
>
Progress value is 0%.
</div>
<div
class="pf-c-progress"
id="test-progress-id"
Expand Down