Skip to content

fix(react-storage): upload status not annouced to AT users #6509

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

fix(react-storage): upload status not annouced to AT users #6509

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
316851d
fix: upload status not annouced to AT users
aadimch Apr 9, 2025
6abf5d6
chore: remove debug artifact
aadimch Apr 10, 2025
27b438d
Merge branch 'main' into aadimch/fix-upload-status-not-announced
aadimch Apr 10, 2025
cf3e4e2
Merge branch 'main' into aadimch/fix-upload-status-not-announced
aadimch Apr 11, 2025
a5ef05d
Create fluffy-pandas-heal.md
aadimch Apr 11, 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
5 changes: 5 additions & 0 deletions .changeset/fluffy-pandas-heal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@aws-amplify/ui-react-storage": patch
---

fix(react-storage): upload status not annouced to AT users
126 changes: 77 additions & 49 deletions packages/react-storage/src/components/StorageManager/ui/FileList/FileStatusMessage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import React from 'react';
import { classNames } from '@aws-amplify/ui';

import { ComponentClassName } from '@aws-amplify/ui';
import { Text, View } from '@aws-amplify/ui-react';
import { Text, View, VisuallyHidden } from '@aws-amplify/ui-react';
import { IconCheck, IconError, useIcons } from '@aws-amplify/ui-react/internal';
import { classNameModifier } from '@aws-amplify/ui';
import { FileStatus } from '../../../FileUploader/types';
Expand All @@ -17,55 +17,83 @@ export const FileStatusMessage = ({
uploadSuccessfulText,
}: FileStatusMessageProps): React.JSX.Element | null => {
const icons = useIcons('storageManager');
switch (status) {
case FileStatus.UPLOADING: {
return (
<Text className={ComponentClassName.StorageManagerFileStatus}>
{getUploadingText(percentage)}
</Text>
);

// Generate the screen reader announcement text
const announcementText = () => {
switch (status) {
case FileStatus.UPLOADING:
return `File upload status changed: Uploading ${percentage}%`;
case FileStatus.PAUSED:
return `File upload status changed: Paused at ${percentage}%`;
case FileStatus.UPLOADED:
return `File upload status changed: Upload completed successfully`;
case FileStatus.ERROR:
return `File upload status changed: Error`;
case FileStatus.QUEUED:
return `File upload status changed: Queued`;
default:
return '';
}
case FileStatus.PAUSED:
return (
<Text className={ComponentClassName.StorageManagerFileStatus}>
{getPausedText(percentage)}
</Text>
);
case FileStatus.UPLOADED:
return (
<Text
className={classNames(
ComponentClassName.StorageManagerFileStatus,
classNameModifier(
};

const renderStatusMessage = () => {
switch (status) {
case FileStatus.UPLOADING: {
return (
<Text className={ComponentClassName.StorageManagerFileStatus}>
{getUploadingText(percentage)}
</Text>
);
}
case FileStatus.PAUSED:
return (
<Text className={ComponentClassName.StorageManagerFileStatus}>
{getPausedText(percentage)}
</Text>
);
case FileStatus.UPLOADED:
return (
<Text
className={classNames(
ComponentClassName.StorageManagerFileStatus,
'success'
)
)}
>
<View as="span" fontSize="xl">
{icons?.success ?? <IconCheck />}
</View>
{uploadSuccessfulText}
</Text>
);
case FileStatus.ERROR:
return (
<Text
className={classNames(
ComponentClassName.StorageManagerFileStatus,
classNameModifier(
classNameModifier(
ComponentClassName.StorageManagerFileStatus,
'success'
)
)}
>
<View as="span" fontSize="xl">
{icons?.success ?? <IconCheck />}
</View>
{uploadSuccessfulText}
</Text>
);
case FileStatus.ERROR:
return (
<Text
className={classNames(
ComponentClassName.StorageManagerFileStatus,
'error'
)
)}
>
<View as="span" fontSize="xl">
{icons?.error ?? <IconError />}
</View>
{errorMessage}
</Text>
);
default:
return null;
}
classNameModifier(
ComponentClassName.StorageManagerFileStatus,
'error'
)
)}
>
<View as="span" fontSize="xl">
{icons?.error ?? <IconError />}
</View>
{errorMessage}
</Text>
);
default:
return null;
}
};

return (
<>
<VisuallyHidden role="status">{announcementText()}</VisuallyHidden>
{renderStatusMessage()}
</>
);
Comment on lines +93 to +98
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The VisuallyHidden component is required to be mounted early, so that the user can hear the announcement. It is generally preffered to have the aria-live component, be present in the DOM, as soon as possible.

};
47 changes: 47 additions & 0 deletions ...ct-storage/src/components/StorageManager/ui/FileList/__tests__/FileStatusMessage.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,4 +105,51 @@ describe('FileStatusMessage', () => {
expect(screen.getByTestId('error')).toBeInTheDocument();
expect(container).toMatchSnapshot();
});

it('announces upload progress when status is uploading', () => {
render(
<FileStatusMessage {...defaultProps} status={FileStatus.UPLOADING} />
);

const announcement = screen.getByRole('status');
expect(announcement).toHaveTextContent(
'File upload status changed: Uploading 50%'
);
});

it('announces paused status with progress', () => {
render(<FileStatusMessage {...defaultProps} status={FileStatus.PAUSED} />);

const announcement = screen.getByRole('status');
expect(announcement).toHaveTextContent(
'File upload status changed: Paused at 50%'
);
});

it('announces successful upload completion', () => {
render(
<FileStatusMessage {...defaultProps} status={FileStatus.UPLOADED} />
);

const announcement = screen.getByRole('status');
expect(announcement).toHaveTextContent(
'File upload status changed: Upload completed successfully'
);
});

it('announces error status', () => {
render(<FileStatusMessage {...defaultProps} status={FileStatus.ERROR} />);

const announcement = screen.getByRole('status');
expect(announcement).toHaveTextContent('File upload status changed: Error');
});

it('has no announcement for queued status', () => {
render(<FileStatusMessage {...defaultProps} status={FileStatus.QUEUED} />);

const announcement = screen.getByRole('status');
expect(announcement).toHaveTextContent(
'File upload status changed: Queued'
);
});
});
24 changes: 24 additions & 0 deletions ...c/components/StorageManager/ui/FileList/__tests__/__snapshots__/FileControl.test.tsx.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,12 @@ exports[`FileControl renders as expected when file is uploading 1`] = `
</span>
</button>
</div>
<span
class="amplify-visually-hidden"
role="status"
>
File upload status changed: Uploading 0%
</span>
<p
class="amplify-text amplify-storagemanager__file__status"
>
Expand Down Expand Up @@ -137,6 +143,12 @@ exports[`FileControl renders as expected when uploading is paused 1`] = `
</span>
</button>
</div>
<span
class="amplify-visually-hidden"
role="status"
>
File upload status changed: Paused at 0%
</span>
<p
class="amplify-text amplify-storagemanager__file__status"
>
Expand Down Expand Up @@ -242,6 +254,12 @@ exports[`FileControl renders thumbnails 1`] = `
</span>
</button>
</div>
<span
class="amplify-visually-hidden"
role="status"
>
File upload status changed: Uploading 0%
</span>
<p
class="amplify-text amplify-storagemanager__file__status"
>
Expand Down Expand Up @@ -347,6 +365,12 @@ exports[`FileControl should default to showThumbnails being true 1`] = `
</span>
</button>
</div>
<span
class="amplify-visually-hidden"
role="status"
>
File upload status changed: Uploading 0%
</span>
<p
class="amplify-text amplify-storagemanager__file__status"
>
Expand Down
18 changes: 18 additions & 0 deletions .../src/components/StorageManager/ui/FileList/__tests__/__snapshots__/FileList.test.tsx.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,12 @@ exports[`FileList renders an alert in case of error 1`] = `
</span>
</button>
</div>
<span
class="amplify-visually-hidden"
role="status"
>
File upload status changed: Uploading 0%
</span>
<p
class="amplify-text amplify-storagemanager__file__status"
>
Expand Down Expand Up @@ -221,6 +227,12 @@ exports[`FileList renders as expected 1`] = `
</span>
</button>
</div>
<span
class="amplify-visually-hidden"
role="status"
>
File upload status changed: Uploading 0%
</span>
<p
class="amplify-text amplify-storagemanager__file__status"
>
Expand Down Expand Up @@ -313,6 +325,12 @@ exports[`FileList renders as expected when upload is resumable 1`] = `
</span>
</button>
</div>
<span
class="amplify-visually-hidden"
role="status"
>
File upload status changed: Uploading 0%
</span>
<p
class="amplify-text amplify-storagemanager__file__status"
>
Expand Down
47 changes: 46 additions & 1 deletion ...onents/StorageManager/ui/FileList/__tests__/__snapshots__/FileStatusMessage.test.tsx.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

exports[`FileStatusMessage renders as expected when file is uploaded 1`] = `
<div>
<span
class="amplify-visually-hidden"
role="status"
>
File upload status changed: Upload completed successfully
</span>
<p
class="amplify-text amplify-storagemanager__file__status amplify-storagemanager__file__status--success"
>
Expand Down Expand Up @@ -31,6 +37,12 @@ exports[`FileStatusMessage renders as expected when file is uploaded 1`] = `

exports[`FileStatusMessage renders as expected when file is uploading 1`] = `
<div>
<span
class="amplify-visually-hidden"
role="status"
>
File upload status changed: Uploading 50%
</span>
<p
class="amplify-text amplify-storagemanager__file__status"
>
Expand All @@ -41,6 +53,12 @@ exports[`FileStatusMessage renders as expected when file is uploading 1`] = `

exports[`FileStatusMessage renders as expected when file uploading is paused 1`] = `
<div>
<span
class="amplify-visually-hidden"
role="status"
>
File upload status changed: Paused at 50%
</span>
<p
class="amplify-text amplify-storagemanager__file__status"
>
Expand All @@ -51,6 +69,12 @@ exports[`FileStatusMessage renders as expected when file uploading is paused 1`]

exports[`FileStatusMessage renders as expected when there is an error uploading 1`] = `
<div>
<span
class="amplify-visually-hidden"
role="status"
>
File upload status changed: Error
</span>
<p
class="amplify-text amplify-storagemanager__file__status amplify-storagemanager__file__status--error"
>
Expand Down Expand Up @@ -80,6 +104,12 @@ exports[`FileStatusMessage renders as expected when there is an error uploading

exports[`FileStatusMessage renders custom icons from IconProvider 1`] = `
<div>
<span
class="amplify-visually-hidden"
role="status"
>
File upload status changed: Error
</span>
<p
class="amplify-text amplify-storagemanager__file__status amplify-storagemanager__file__status--error"
>
Expand All @@ -90,6 +120,12 @@ exports[`FileStatusMessage renders custom icons from IconProvider 1`] = `
</span>
Error
</p>
<span
class="amplify-visually-hidden"
role="status"
>
File upload status changed: Upload completed successfully
</span>
<p
class="amplify-text amplify-storagemanager__file__status amplify-storagemanager__file__status--success"
>
Expand All @@ -103,4 +139,13 @@ exports[`FileStatusMessage renders custom icons from IconProvider 1`] = `
</div>
`;

exports[`FileStatusMessage renders nothing when status is queued 1`] = `<div />`;
exports[`FileStatusMessage renders nothing when status is queued 1`] = `
<div>
<span
class="amplify-visually-hidden"
role="status"
>
File upload status changed: Queued
</span>
</div>
`;
Loading