chore: Rename references to Storage Manager in docs to File Uploader #5697
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -165,6 +165,14 @@ module.exports = withNextPluginPreval({ | |
| destination: '/react/components/accordion', | ||
| permanent: false, | ||
| }, | ||
| /** | ||
| * Renamed "Storage Manager" to "File Uploader" | ||
| */ | ||
| { | ||
| source: '/react/connected-components/storage/storagemanager', | ||
| destination: '/react/connected-components/storage/fileuploader', | ||
| permanent: true, | ||
| }, | ||
|
Comment on lines
+171
to
+175
There was a problem hiding this comment. Will this cover redirects from the primary docs that are linking to the existing StorageManager documentation? There was a problem hiding this comment. I believe so. This is the only endpoint linked in the primary docs. There is also a PR under review which updates the links to use the |
||
| /** | ||
| * Redirect traffic from CRA to Vite getting started page | ||
| */ | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| import { Alert } from '@aws-amplify/ui-react'; | ||
|
|
||
| export const FileUploaderAlert = () => { | ||
| return ( | ||
| <Alert variation="info" role="none"> | ||
| StorageManager has been renamed to FileUploader. The FileUploader export | ||
| is available since version 3.3.0, previous versions must still use | ||
| StorageManager. | ||
calebpollman marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| </Alert> | ||
| ); | ||
| }; | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,12 +13,12 @@ const children = { | |
| const displayText = { | ||
| name: `displayText`, | ||
| description: 'Test strings that are used in the component', | ||
| type: `FileUploaderDisplayText`, | ||
| }; | ||
|
|
||
| const eventHandler = `(file: {key: string}) => void;`; | ||
|
|
||
| export const FILE_UPLOADER = [ | ||
| { | ||
| name: `path`, | ||
| description: | ||
|
|
@@ -93,7 +93,7 @@ export const STORAGE_MANAGER = [ | |
| { | ||
| name: `displayText?`, | ||
| description: 'Text to override in the component.', | ||
| type: 'FileUploaderDisplayText', | ||
| }, | ||
| { | ||
| name: `useAccelerateEndpoint?`, | ||
|
|
@@ -102,7 +102,7 @@ export const STORAGE_MANAGER = [ | |
| }, | ||
| { | ||
| name: `components?.Container?`, | ||
| description: 'The container the FileUploader is wrapped in.', | ||
| type: `React.ComponentType<ContainerProps>`, | ||
| }, | ||
| { | ||
|
|
@@ -132,8 +132,8 @@ export const STORAGE_MANAGER = [ | |
| }, | ||
| { | ||
| name: `ref?`, | ||
| description: 'Forward ref prop exposing FileUploader imperative methods.', | ||
| type: `React.ForwardedRef<FileUploaderHandle>`, | ||
| }, | ||
| ]; | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -5,9 +5,10 @@ import AppDirectoryAlert from '@/components/AppDirectoryAlert'; | |||||
| import { ComponentStyleDisplay } from '@/components/ComponentStyleDisplay'; | ||||||
| import ReactPropsTable from '@/components/propsTable/ReactPropsTable'; | ||||||
| import { Example, ExampleCode } from '@/components/Example'; | ||||||
| import { FileUploaderAlert } from '@/components/FileUploaderAlert'; | ||||||
| import { Fragment } from '@/components/Fragment'; | ||||||
| import { InstallScripts } from '@/components/InstallScripts'; | ||||||
| import { FILE_UPLOADER, FILE_PICKER, DROPZONE_PROPS, DISPLAY_TEXT } from './props'; | ||||||
| import { | ||||||
| DefaultExample, | ||||||
| ComponentOverridesExample, | ||||||
|
|
@@ -34,13 +35,15 @@ import { | |||||
|
|
||||||
| <AppDirectoryAlert /> | ||||||
|
|
||||||
| <FileUploaderAlert /> | ||||||
|
|
||||||
| To use the FileUploader component import it into your React application with the included styles. | ||||||
|
There was a problem hiding this comment. We should add an informational alert here that StorageManager is now FileUploader There was a problem hiding this comment. Done. Should I still keep the "Storage Manager is deprecated" warning alert in the deprecated props section? |
||||||
|
|
||||||
| <InstallScripts component="storage" /> | ||||||
|
|
||||||
| <ExampleCode> | ||||||
| ```jsx | ||||||
| import { FileUploader } from '@aws-amplify/ui-react-storage'; | ||||||
| import '@aws-amplify/ui-react/styles.css'; | ||||||
| ``` | ||||||
| </ExampleCode> | ||||||
|
|
@@ -60,14 +63,14 @@ At a minimum you must include the `path` and `maxFileCount` props. `path` refers | |||||
| </Example> | ||||||
|
|
||||||
| ### Private or Protected Buckets | ||||||
| When uploading to private or protected S3 buckets, you'll need to wrap your app in the `Authenticator`, allowing the `FileUploader` component to infer the Cognito `identityId` of the currently signed-in user. This can be done directly with the `Authenticator` component or with `withAuthenticator`, as shown in [Add the Authenticator](/connected-components/authenticator#step-3-add-the-authenticator). | ||||||
|
|
||||||
| The example below shows configuring the FileUploader to upload to the `protected` folder under the users' identity id. | ||||||
|
|
||||||
| <Example> | ||||||
| <ExampleCode> | ||||||
| ```jsx | ||||||
| <FileUploader | ||||||
| acceptedFileTypes={['image/*']} | ||||||
| path={({ identityId }) => `protected/${identityId}/`} | ||||||
| maxFileCount={1} | ||||||
|
|
@@ -78,6 +81,11 @@ The example below shows configuring the StorageManager to upload to the `protect | |||||
| </Example> | ||||||
|
|
||||||
| ### Deprecated props | ||||||
|
|
||||||
| <Alert variation="warning" heading="Storage Manager is deprecated"> | ||||||
|
||||||
| <Alert variation="warning" heading="Storage Manager is deprecated"> | |
| <Alert variation="warning" heading="Storage Manager renamed"> |
There was a problem hiding this comment.
let's move this alert to the top of the page
Outdated
There was a problem hiding this comment.
Suggested change
| This component used to be called Storage Manager. The Storage Manager component has been deprecated, and all functionality is retained by the File Uploader component. | |
| StorageManager component has been renamed `FileUploader` as of `aws-amplify/ui-react-storage` version `3.3.0`. Please upgrade to the new import path, as the `StoraageManager` will be removed in a future major version. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -63,7 +63,7 @@ To use Storage UI components with Amplify, you'll need to call `Amplify.configur | |
| <ExampleCode> | ||
| ```tsx | ||
| import { Amplify } from 'aws-amplify'; | ||
| import { StorageImage, FileUploader } from '@aws-amplify/ui-react-storage'; | ||
| import awsExports from './aws-exports'; | ||
|
|
||
| Amplify.configure(awsExports); | ||
|
|
@@ -72,7 +72,7 @@ To use Storage UI components with Amplify, you'll need to call `Amplify.configur | |
| return ( | ||
| <> | ||
| <StorageImage alt="sleepy-cat" path="public/cat.jpeg" /> | ||
| <FileUploader path="my_prefix/public" maxFileCount={3} /> | ||
| </> | ||
| ); | ||
| }; | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -830,8 +830,4 @@ The 3.x version of `@aws-amplify/ui-react-storage` has a minimum dependency of 6 | |
|
|
||
| #### 1. public accessLevel becomes 'guest' in Storage components | ||
|
|
||
|
|
||
| Starting in v6 of the Amplify JS libraries, `'public'` access level, meaning unauthentiated users can access it, became `'guest'`. The `accessLevel` property on FileUploader and StorageImage components have been updated to reflect this change. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -32,14 +32,14 @@ The components and their icons that can be overridden are: | |
| * [Accordion](../components/accordion) | ||
| * [Alert](../components/alert) | ||
| * [Checkbox](../components/checkboxfield) | ||
| * [FileUploader](../connected-components/storage/fileuploader) | ||
| * [Menu](../components/menu) | ||
| * [Pagination](../components/pagination) | ||
| * [PasswordField](../components/passwordfield) | ||
| * [Rating](../components/rating) | ||
| * [SearchField](../components/searchfield) | ||
| * [SelectField](../components/selectfield) | ||
| * [StepperField](../components/stepperfield) | ||
|
|
||
| Here is the full list of icons you can customize with the IconProvider | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -15,7 +15,7 @@ const defaultConfig = { | |
|
|
||
| /** | ||
| * https://docs.amplify.aws/lib/storage/custom-plugin/q/platform/js/ | ||
| * Mocking out the Storage class so we can render the FileUploader component | ||
| * without an Amplify backend. | ||
| */ | ||
| // export default class MyStorageProvider implements StorageProvider { | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍