Login

UI for logging into Polyfire Auth

📘

Auth is required

All the components and functions in the SDK require you to connect your users to Polyfire Auth.

Because all calls to the Polyfire API use LLMs (and therefore cost money) or access user data, the client needs some kind of secured authentification.

You don't need to authenticate your users entirely through Polyfire (e.g. we can authenticate your Firebase or Supabase user tokens). If you need a custom auth provider integrated, tell us on Discord.

Description

Component UI to log in your users with Polyfire Auth. It displays Sign In with Google and GitHub. We can add more if you need them. Tell us on Discord.

It takes only two props for your Privacy Policy and Terms of Service. Everything else works automatically through the PolyfireProvider. The other props are applied to to parent <div /> component.

One specificity is that you need to pass as children the components you want to display when then user is logged in. (When the user isn't logged in, the component displays the login buttons.)

Props

• termsOfService: Optional. A string URL to the Terms of Service of your application or website.
• privacyPolicy: Optional. A string URL to the Privacy Policy of your application or website.
• Extends all the standard <div> element props, allowing for additional customization of the parent container.

TypeScript

interface LoginProps extends React.HTMLAttributes<HTMLDivElement> {
    children: ReactNode;
    termsOfService?: string;
    privacyPolicy?: string;
}

Example

TypeScript

<Login
  termsOfService="https://yourwebsite.com/terms"
  privacyPolicy="https://yourwebsite.com/privacy"
  // Additional props like className, style, etc.
>
  {/* Child components to display after user logs in */}
</Login>