Is there documentation for aws-amplify-react - Authenticator component? about docs HOT 9 CLOSED

@powerful23 @mlabieniec this document really still sucks ~1yr later since you last posted... where is the documentation for withAuthenticator and Authenticator? The code is greek to me... I'm not sure why do you use Angular in Typescript to write react... all i want to do is relabel "username" to "email" your react.js component library doesn't use react.js, it uses angular.ts!

from docs.

I have the same issue. The documentation is really poor. There are no working examples, no full documentation of the API. Just random snippets that make it incredibly hard to use.

Have spent several days trying to make anything that works, and I'm seriously considering scrapping amplify for firebase.

from docs.

Thanks all for the feedback. Improving documentation is top of our list for our current sprints. We are working on launching a big improvement and will make sure we take this all into account. I will use this thread to track fixes to the react docs specifically.

from docs.

Thanks. I found that. I was particularly looking for some documentation on the <Authenticator> component in react. I found an example that added Greetings and some other params. But I can't find any documentation on what params are available and what they do.

from docs.

The details for the Authenticator and withAuthenticator options/params are outlined here for react: https://aws-amplify.github.io/amplify-js/media/authentication_guide#using-components-in-react

from docs.

The Authentication section under API Guides has docs, specific examples and code snippets around the Authenticator and withAuthenticator (same as React). Also there is a VSCode extension you can install with code snippets. Let us know if you are looking for something in particular that’s not covered:

https://aws-amplify.github.io/amplify-js/media/authentication_guide

from docs.

+1 on the poor documentation angle. While the examples exist, and that’s better than nothing, I tend to expect API documentation as a minimum. The way the code is laid out makes even my IDE unable to parse out implicit doco from the code, so I have had to resort to going and reading the code and manually deciphering it from that. Not really a great/productive end-user experience, particularly from a library aiming to speed up dev time. /2c

from docs.

The details for the Authenticator and withAuthenticator options/params are outlined here for react: https://aws-amplify.github.io/amplify-js/media/authentication_guide#using-components-in-react

Thanks that helps a lot. A link or reference to this from the react section of the amplify docs would be really helpful. I assumed those were the only react docs.

+1 to the others who would like to see a documented API.

from docs.

I also really wish they would split documentation for react and react native. Most of the examples do not work in react native.

from docs.