Which UI do you use?

Custom UI

Pre built UI

How to use

ReactJS

caution

Not applicable to non-react apps. You can disable the specific pre built UI component, and then build your own UI instead.

Angular

1. You will have to use the PasswordlessComponentsOverrideProvider or the AuthRecipeComponentsOverrideContextProvider component as shown below. make sure that it render the SuperTokens components inside this component.
2. Pick a component that you'd like to override by its key.
3. Supply a React component against the key you have picked. Your custom component will get the original component as a prop.

Do you use react-router-dom?

YesNo

important

Please make sure that the file in which this config is specified is a .tsx or .jsx file type.

Finding which component will be overridden

To do that, you should use React Developer Tools extension which provides a component tree inspector.

Example

1. Look for the names defined in component override config and/or components ending in _Override in the component tree.
2. Ensure that's the component you want to override
3. Overide the component as stated above.

How do I render the original component

Because the override function receives the original component as a parameter, you can render it. To do this, simply use it in JSX. Don't forget to supply original props by spreading them.

import React from "react";
import { SuperTokensWrapper } from "supertokens-auth-react";
import { AuthRecipeComponentsOverrideContextProvider } from "supertokens-auth-react/ui";

import octocat from "./octocat.png";

function App() {
    return (
        <SuperTokensWrapper>
            <AuthRecipeComponentsOverrideContextProvider
                components={{
                    AuthPageHeader_Override: ({ DefaultComponent, ...props }) => {
                        return (
                            <>
                                <h1>I'm a header that you added above original component</h1>
                                <DefaultComponent {...props} />
                            </>
                        )
                    }
                }}>
                {/* Rest of the JSX */}
            </AuthRecipeComponentsOverrideContextProvider>
        </SuperTokensWrapper>
    );
}
export default App;

Vue

caution

Not applicable to non-react apps. You can disable the specific pre built UI component, and then build your own UI instead.