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.

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 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
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
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { DisplayTextTemplate } from '@aws-amplify/ui';
import { FileStatus } from '../types';

export type FileUploaderDisplayText = DisplayTextTemplate<{
getFilesUploadedText?: (count: number) => string;
Expand All @@ -9,6 +10,10 @@ export type FileUploaderDisplayText = DisplayTextTemplate<{
getUploadButtonText?: (count: number) => string;
getMaxFilesErrorText?: (count: number) => string;
getErrorText?: (message: string) => string;
getStatusAnnouncementText?: (
status: FileStatus,
percentage?: number
) => string;
doneButtonText?: string;
clearAllButtonText?: string;
extensionNotAllowedText?: string;
Expand Down Expand Up @@ -49,6 +54,22 @@ export const defaultFileUploaderDisplayText: FileUploaderDisplayTextDefault = {
getErrorText(message: string): string {
return message;
},
getStatusAnnouncementText(status: FileStatus, percentage?: number): string {
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 '';
}
},
doneButtonText: 'Done',
clearAllButtonText: 'Clear all',
extensionNotAllowedText: 'Extension not allowed',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ export function FileControl({
const {
getPausedText,
getUploadingText,
getStatusAnnouncementText,
uploadSuccessfulText,
pauseButtonText,
resumeButtonText,
Expand Down Expand Up @@ -76,6 +77,7 @@ export function FileControl({
uploadSuccessfulText={uploadSuccessfulText}
getUploadingText={getUploadingText}
getPausedText={getPausedText}
getStatusAnnouncementText={getStatusAnnouncementText}
status={status}
errorMessage={errorMessage}
percentage={progress}
Expand Down
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 @@ -12,60 +12,73 @@ export const FileStatusMessage = ({
errorMessage,
getPausedText,
getUploadingText,
getStatusAnnouncementText,
percentage,
status,
uploadSuccessfulText,
}: FileStatusMessageProps): React.JSX.Element | null => {
const icons = useIcons('storageManager');
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,
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">
{getStatusAnnouncementText(status, percentage)}
</VisuallyHidden>
{renderStatusMessage()}
</>
);
};
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,22 @@ const defaultProps: Omit<FileStatusMessageProps, 'status'> = {
errorMessage: errorUploading,
percentage: 50,
getUploadingText: (percentage: number) => `${uploadingText} ${percentage}%`,
getStatusAnnouncementText: (status: FileStatus, percentage?: number) => {
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 '';
}
},
getPausedText: () => uploadingPausedText,
uploadSuccessfulText: uploadSuccessful,
};
Expand Down Expand Up @@ -105,4 +121,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('announces queued status', () => {
render(<FileStatusMessage {...defaultProps} status={FileStatus.QUEUED} />);

const announcement = screen.getByRole('status');
expect(announcement).toHaveTextContent(
'File upload status changed: Queued'
);
});
});
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
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
Loading