Using the Documentation

We want to help you get your custom components built as quickly as possible. Because of that, the layout of this documentation might be a bit atypical of what you're used to seeing.

For the majority of our frontend APIs we provide you with two fully built out examples of the component you're looking to build - one stylized with TailwindCSS and the other in vanilla React. This allows you to simply copy and paste a fully functional component directly into your app.

Some of our components are more complex than others. For the more complex components, the @propelauth/frontend-apis-react library also includes React Hooks to help you get started. These are not required (unless you're using our examples) and can be skipped if you'd rather build everything yourself.

The exception to this are our APIs that involve the login and signup process. For these APIs we do not offer pre-built components. That being said, we do provide a step-by-step guide on how to handle and manage the login process.

Not interested in using our pre-built components? No problem! Head over to the reference documentation to help you fully customize the component to your liking.