Skip to content

Commit 759e374

Browse files
authored
chore: update top level and package READMEs (#6548)
1 parent dc9da2b commit 759e374

File tree

13 files changed

+299
-200
lines changed

13 files changed

+299
-200
lines changed

README.md

+54-57
Original file line numberDiff line numberDiff line change
@@ -36,70 +36,67 @@ Amplify UI is an open-source UI library with cloud-connected components that are
3636

3737
## Component Matrix
3838

39-
| **Connected Components** | **React** | **React Native** | **Angular** | **Vue** |
40-
| :------------------------------ | :-------: | :--------------: | :---------: | :-----: |
41-
| Authenticator |||||
42-
| In-App Messaging ||| | |
43-
| Geo (MapView) || | | |
44-
| Account Settings || | | |
45-
| Storage (FileUploader) || | | |
46-
| Storage (StorageImage) || | | |
47-
| Liveness (FaceLivenessDetector) || | | |
48-
49-
| **Primitives** | **React** | **Angular** | **Vue** |
50-
| :--------------- | :-------: | :---------: | :-----: |
51-
| Alert || |
52-
| Autocomplete || |
53-
| Badge || |
54-
| Button || |
55-
| Card || |
56-
| CheckboxField || |
57-
| Collection || |
58-
| Divider || |
59-
| Expander || |
60-
| Flex || |
61-
| Grid || |
62-
| Heading || |
63-
| HighlightMatch || |
64-
| Icon || |
65-
| Image || |
66-
| Link || |
67-
| Loader || |
68-
| Menu || |
69-
| Pagination || |
70-
| PasswordField || |
71-
| PhoneNumberField || |
72-
| Placeholder || |
73-
| RadioGroupField || |
74-
| Rating || |
75-
| ScrollView || |
76-
| SearchField || |
77-
| SelectField || |
78-
| SliderField || |
79-
| StepperField || |
80-
| SwitchField || |
81-
| Table || |
82-
| Tabs || |
83-
| Text || |
84-
| TextAreaField || |
85-
| TextField || |
86-
| ToggleButton || |
87-
| View || |
88-
| VisuallyHidden || |
39+
| **Connected Components** | **React** | **React Native** | **Angular** | **Vue** |
40+
| :----------------------- | :-------: | :--------------: | :---------: | :-----: |
41+
| Authenticator |||||
42+
| InAppMessagingDisplay ||| | |
43+
| MapView/LocationSearch || | | |
44+
| Account Settings || | | |
45+
| StorageBrowser || | | |
46+
| FileUploader || | | |
47+
| StorageImage || | | |
48+
| FaceLivenessDetector || | | |
49+
50+
| **Primitives** | **React** |
51+
| :--------------- | :-------: |
52+
| Alert ||
53+
| Autocomplete ||
54+
| Badge ||
55+
| Button ||
56+
| Card ||
57+
| CheckboxField ||
58+
| Collection ||
59+
| Divider ||
60+
| Expander ||
61+
| Flex ||
62+
| Grid ||
63+
| Heading ||
64+
| HighlightMatch ||
65+
| Icon ||
66+
| Image ||
67+
| Link ||
68+
| Loader ||
69+
| Menu ||
70+
| Pagination ||
71+
| PasswordField ||
72+
| PhoneNumberField ||
73+
| Placeholder ||
74+
| RadioGroupField ||
75+
| Rating ||
76+
| ScrollView ||
77+
| SearchField ||
78+
| SelectField ||
79+
| SliderField ||
80+
| StepperField ||
81+
| SwitchField ||
82+
| Table ||
83+
| Tabs ||
84+
| Text ||
85+
| TextAreaField ||
86+
| TextField ||
87+
| ToggleButton ||
88+
| View ||
89+
| VisuallyHidden ||
8990

9091
## Frequently asked questions
9192

92-
**What are the major benefits of the new version of Amplify UI?**
93+
**What are the major benefits of Amplify UI?**
9394

9495
- **Better developer experience** Connected-components like Authenticator are being written with framework-specific implementations so that they follow framework conventions and are easier to integrate into your application.
9596
- **Endlessly customizable** Every detail of Amplify UI is customizable to match your brand. Style all of Amplify UI with themes, override components with your own, or build your own UI and use Amplify for complex state management.
9697
- **Accessible** Amplify UI components follow [WCAG](https://www.w3.org/WAI/standards-guidelines/wcag/) and [WAI-ARIA](https://www.w3.org/TR/wai-aria-1.2/) best practices and guidelines such as color contrast, keyboard navigation, accessible labels, and focus management.
9798
- **Primitive components (React only right now)** Primitive components are used in the connected components, like Authenticator, you can also customize them and use them to build the rest of your UI.
9899

99-
**Why are you building primitives?**
100-
101-
We are building more cloud-connected components and want to have consistency between them, while also allowing you to build your UI with the same primitives so you can have a consistent UI development experience.
102-
103100
**How does this compare to other UI libraries like Tailwind, Chakra, Supabase, or Material-UI?**
104101

105102
Amplify UI consists of both primitive components like Buttons, Badges, and Cards, as well as cloud-connected and data-bound components like the Authenticator. We are taking heavy inspiration from open-source frameworks like [Tailwind](https://tailwindcss.com/), [Chakra](https://chakra-ui.com/), [Supabase](https://ui.supabase.io/), [Radix](https://www.radix-ui.com/), [Adobe Spectrum](https://react-spectrum.adobe.com/), [Material-UI](https://material-ui.com/), and others. In fact, one of the core ideas with the new Amplify UI is the ability to integrate seamlessly into _any_ application, including ones using those UI frameworks. For example, you can use Tailwind classes to style Amplify UI components or Chakra components like buttons inside Amplify connected-components like the Authenticator.
@@ -112,6 +109,6 @@ You can also use the above link to report a bug or a feature request for previou
112109

113110
As we continue to work on the new Amplify UI we will move UI-related issues in the amplify-js repository over here to work on them. We will continue to maintain major bug and security fixes for all existing UI packages and versions. New development for UI components will happen in this repository and eventually be published under the `@react` npm tag.
114111

115-
## Contributing
112+
## We love contributors!!
116113

117-
- [CONTRIBUTING.md](/CONTRIBUTING.md)
114+
See our contributing guide [CONTRIBUTING.md](/CONTRIBUTING.md) to help us scale Amplify UI!

packages/angular/README.md

+7-17
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,15 @@
1+
# Amplify UI Angular
2+
13
[![@aws-amplify/ui-angular Weekly Downloads stat badge](https://img.shields.io/npm/dw/@aws-amplify/ui-angular?label=Download&logo=Amplify)](https://www.npmjs.com/package/@aws-amplify/ui-angular) [![@aws-amplify/ui-angular version badge](https://img.shields.io/npm/v/@aws-amplify/ui-angular/latest)](https://www.npmjs.com/package/@aws-amplify/ui-angular)
24

3-
# Amplify UI
5+
The Angular package provides components and utilities for building Amplify connected applications on Angular.
6+
7+
## Contents
48

5-
Amplify UI is an open-source UI library with cloud-connected components that are endlessly customizable, accessible, and can integrate into _any_ application. Amplify UI consists of:
9+
### Authenticator Component
610

7-
1. Connected components that simplify complex cloud-connected workflows, like Authenticator.
8-
2. Primitive components that create consistency across Amplify UI and allow you to build complete applications that fit your brand, like Buttons and Badges.
9-
3. Data-bound components that make it easy to display dynamic data, like DataStoreCollections.
10-
4. Theming capabilities that allow you to customize the appearance of Amplify UI to match your brand.
11+
- Authentication component for Angular applications
1112

1213
## Angular Documentation
1314

1415
- https://ui.docs.amplify.aws/angular
15-
16-
## Features 🚀
17-
18-
- **Better developer experience** Connected-components like Authenticator are being written with framework-specific implementations so that they follow framework conventions and are easier to integrate into your application.
19-
- **Endlessly customizable** Every detail of Amplify UI is customizable to match your brand. Style all of Amplify UI with themes, override components with your own, or build your own UI and use Amplify for complex state management.
20-
- **Accessible** Amplify UI components follow [WCAG](https://www.w3.org/WAI/standards-guidelines/wcag/) and [WAI-ARIA](https://www.w3.org/TR/wai-aria-1.2/) best practices and guidelines such as color contrast, keyboard navigation, accessible labels, and focus management.
21-
- **Primitive components (React only right now)** Primitive components are used in the connected components, like Authenticator, you can also customize them and use them to build the rest of your UI.
22-
23-
## We love contributors!!
24-
25-
See our contributing guide [CONTRIBUTING.md](/CONTRIBUTING.md) to help us scale Amplify UI!

packages/react-ai/README.md

+21-15
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,29 @@
1-
# Amplify UI
1+
# Amplify UI React AI
22

3-
Amplify UI is an open-source UI library with cloud-connected components that are endlessly customizable, accessible, and can integrate into _any_ application. Amplify UI consists of:
3+
The React AI package provides components and utilities for AI-powered conversations and interactions in Amplify connected applications.
44

5-
1. Connected components that simplify complex cloud-connected workflows, like Authenticator.
6-
2. Primitive components that create consistency across Amplify UI and allow you to build complete applications that fit your brand, like Buttons and Badges.
7-
3. Data-bound components that make it easy to display dynamic data, like DataStoreCollections.
8-
4. Theming capabilities that allow you to customize the appearance of Amplify UI to match your brand.
5+
## Contents
96

10-
## React Documentation
7+
### Core Components
118

12-
- https://ui.docs.amplify.aws/react
9+
- `AIConversation` - Component for AI-powered conversations
10+
- `createAIConversation` - Factory function for creating AI conversation components
11+
12+
### Utility Functions
1313

14-
## Features 🚀
14+
- `createAIHooks` - Factory function for creating AI-related hooks
1515

16-
- **Better developer experience** Connected-components like Authenticator are being written with framework-specific implementations so that they follow framework conventions and are easier to integrate into your application.
17-
- **Endlessly customizable** Every detail of Amplify UI is customizable to match your brand. Style all of Amplify UI with themes, override components with your own, or build your own UI and use Amplify for complex state management.
18-
- **Accessible** Amplify UI components follow [WCAG](https://www.w3.org/WAI/standards-guidelines/wcag/) and [WAI-ARIA](https://www.w3.org/TR/wai-aria-1.2/) best practices and guidelines such as color contrast, keyboard navigation, accessible labels, and focus management.
19-
- **Primitive components (React only right now)** Primitive components are used in the connected components, like Authenticator, you can also customize them and use them to build the rest of your UI.
16+
### Type Definitions
2017

21-
## We love contributors!!
18+
- `Avatars` - Type for avatar configurations
19+
- `CustomAction` - Type for custom actions
20+
- `ResponseComponent` - Type for response components
21+
- `SuggestedPrompt` - Type for suggested prompts
22+
- `ConversationMessage` - Type for conversation messages
23+
- `ConversationMessageContent` - Type for conversation message content
24+
- `SendMessage` - Type for send message function
25+
- `SendMesageParameters` - Type for send message parameters
2226

23-
See our contributing guide [CONTRIBUTING.md](/CONTRIBUTING.md) to help us scale Amplify UI!
27+
## React Documentation
28+
29+
- https://ui.docs.amplify.aws/react
+33-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,35 @@
1-
# Amplify UI React Core
1+
# Amplify UI React Core Notifications
22

33
`@aws-amplify/ui-react-core-notifications` is a React platform agnostic utility library for Amplify UI internal usage in the `@aws-amplify/ui-react-notifications` package.
4+
5+
## Contents
6+
7+
### Providers and Hooks
8+
9+
- `InAppMessagingProvider` - Provider component for in-app messaging context
10+
- `useInAppMessaging` - Hook for accessing in-app messaging functionality
11+
- `useMessage` - Hook for accessing message functionality
12+
- `handleMessageAction` - Utility function for handling message actions
13+
14+
### Type Definitions
15+
16+
- `InAppMessage` - Core message type definition
17+
- `InAppMessageAction` - Type for message actions
18+
- `InAppMessageButton` - Type for message buttons
19+
- `InAppMessageContent` - Type for message content
20+
- `InAppMessageImage` - Type for message images
21+
- `InAppMessageLayout` - Type for message layouts
22+
- `InAppMessageStyle` - Type for message styling
23+
- `InAppMessageTextAlign` - Type for text alignment options
24+
25+
### Message Component Types
26+
27+
- `BannerMessageComponent` - Type for banner message components
28+
- `CarouselMessageComponent` - Type for carousel message components
29+
- `FullScreenMessageComponent` - Type for full-screen message components
30+
- `ModalMessageComponent` - Type for modal message components
31+
- `MessageButtonProps` - Props for message buttons
32+
- `MessageCommonProps` - Common props for messages
33+
- `MessageComponentBaseProps` - Base props for message components
34+
- `MessageContentProps` - Props for message content
35+
- `MessagePayloadStyle` - Style for message payload

packages/react-core/README.md

+39
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,42 @@
11
# Amplify UI React Core
22

33
`@aws-amplify/ui-react-core` is a React platform agnostic utility library for Amplify UI internal usage in `@aws-amplify/ui-react*` and `@aws-amplify/ui-react-native*` namespaced packages.
4+
5+
## Contents
6+
7+
### Authenticator
8+
9+
- `AuthenticatorProvider` - Provider component for Authenticator context
10+
- `useAuthenticator` - Hook for accessing Authenticator functionality
11+
- `useAuthenticatorRoute` - Hook for accessing Authenticator route information
12+
- `useAuthenticatorInitMachine` - Hook for initializing Authenticator state machine
13+
- `isAuthenticatorComponentRouteKey` - Utility function for checking route keys
14+
- `resolveAuthenticatorComponents` - Utility function for resolving Authenticator components
15+
16+
### Form Components and Hooks
17+
18+
- `FormProvider` - Provider component for form context
19+
- `useField` - Hook for accessing form field functionality
20+
- `useForm` - Hook for accessing form functionality
21+
- `withFormProvider` - Higher-order component for adding form provider capabilities
22+
- `RenderNothing` - Utility component for rendering nothing
23+
24+
### Utility Hooks
25+
26+
- `useAsyncReducer` - Hook for async state management
27+
- `useControlledReducer` - Hook for controlled state management
28+
- `useDeprecationWarning` - Hook for displaying deprecation warnings
29+
- `useDropZone` - Hook for drag and drop functionality
30+
- `useGetUrl` - Hook for getting URLs
31+
- `useHasValueUpdated` - Hook for checking if a value has updated
32+
- `usePreviousValue` - Hook for accessing previous value
33+
- `useSetUserAgent` - Hook for setting user agent
34+
- `useTimeout` - Hook for timeout functionality
35+
36+
### Utility Functions
37+
38+
- `createContextUtilities` - Utility function for creating context utilities
39+
40+
### Type Definitions
41+
42+
- Various type definitions for Authenticator, Form, and utility components

packages/react-geo/README.md

+8-17
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,14 @@
1-
# Amplify UI
1+
# Amplify UI React Geo
22

3-
Amplify UI is an open-source UI library with cloud-connected components that are endlessly customizable, accessible, and can integrate into _any_ application. Amplify UI consists of:
3+
The React Geo package provides geolocation and mapping components for Amplify connected applications.
44

5-
1. Connected components that simplify complex cloud-connected workflows, like Authenticator.
6-
2. Primitive components that create consistency across Amplify UI and allow you to build complete applications that fit your brand, like Buttons and Badges.
7-
3. Data-bound components that make it easy to display dynamic data, like DataStoreCollections.
8-
4. Theming capabilities that allow you to customize the appearance of Amplify UI to match your brand.
5+
## Contents
96

10-
## React Documentation
11-
12-
- https://ui.docs.amplify.aws/react
7+
### Core Components
138

14-
## Features 🚀
9+
- `MapView` - Component for displaying maps
10+
- `LocationSearch` - Component for location search functionality
1511

16-
- **Better developer experience** Connected-components like Authenticator are being written with framework-specific implementations so that they follow framework conventions and are easier to integrate into your application.
17-
- **Endlessly customizable** Every detail of Amplify UI is customizable to match your brand. Style all of Amplify UI with themes, override components with your own, or build your own UI and use Amplify for complex state management.
18-
- **Accessible** Amplify UI components follow [WCAG](https://www.w3.org/WAI/standards-guidelines/wcag/) and [WAI-ARIA](https://www.w3.org/TR/wai-aria-1.2/) best practices and guidelines such as color contrast, keyboard navigation, accessible labels, and focus management.
19-
- **Primitive components (React only right now)** Primitive components are used in the connected components, like Authenticator, you can also customize them and use them to build the rest of your UI.
20-
21-
## We love contributors!!
12+
## React Documentation
2213

23-
See our contributing guide [CONTRIBUTING.md](/CONTRIBUTING.md) to help us scale Amplify UI!
14+
- https://ui.docs.amplify.aws/react

0 commit comments

Comments
 (0)