Skip to content

Unstyled components

SignUpButton

Bases: ClerkBase

Source code in custom_components/reflex_clerk_api/unstyled_components.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
class SignUpButton(ClerkBase):
    tag = "SignUpButton"

    force_redirect_url: str | None = None
    "If provided, this URL will always be redirected to after the user signs up. It's recommended to use the environment variable instead."

    fallback_redirect_url: str | None = None
    "The fallback URL to redirect to after the user signs up, if there's no redirect_url in the path already. Defaults to /. It's recommended to use the environment variable instead."

    sign_in_force_redirect_url: str | None = None
    "If provided, this URL will always be redirected to after the user signs in. It's recommended to use the environment variable instead."

    sign_in_fallback_redirect_url: str | None = None
    "The fallback URL to redirect to after the user signs in, if there's no redirect_url in the path already. Defaults to /. It's recommended to use the environment variable instead."

    mode: str | None = None
    "Determines what happens when a user clicks on the <SignUpButton>. Setting this to 'redirect' will redirect the user to the sign-up route. Setting this to 'modal' will open a modal on the current route. Defaults to 'redirect'."

force_redirect_url = None class-attribute instance-attribute

If provided, this URL will always be redirected to after the user signs up. It's recommended to use the environment variable instead.

fallback_redirect_url = None class-attribute instance-attribute

The fallback URL to redirect to after the user signs up, if there's no redirect_url in the path already. Defaults to /. It's recommended to use the environment variable instead.

sign_in_force_redirect_url = None class-attribute instance-attribute

If provided, this URL will always be redirected to after the user signs in. It's recommended to use the environment variable instead.

sign_in_fallback_redirect_url = None class-attribute instance-attribute

The fallback URL to redirect to after the user signs in, if there's no redirect_url in the path already. Defaults to /. It's recommended to use the environment variable instead.

mode = None class-attribute instance-attribute

Determines what happens when a user clicks on the . Setting this to 'redirect' will redirect the user to the sign-up route. Setting this to 'modal' will open a modal on the current route. Defaults to 'redirect'.

SignInButton

Bases: ClerkBase

Source code in custom_components/reflex_clerk_api/unstyled_components.py 
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
class SignInButton(ClerkBase):
    tag = "SignInButton"

    force_redirect_url: str | None = None
    "If provided, this URL will always be redirected to after the user signs in. It's recommended to use the environment variable instead."

    fallback_redirect_url: str | None = None
    "The fallback URL to redirect to after the user signs in, if there's no redirect_url in the path already. Defaults to /. It's recommended to use the environment variable instead."

    sign_up_force_redirect_url: str | None = None
    "If provided, this URL will always be redirected to after the user signs up. It's recommended to use the environment variable instead."

    sign_up_fallback_redirect_url: str | None = None
    "The fallback URL to redirect to after the user signs up, if there's no redirect_url in the path already. Defaults to /. It's recommended to use the environment variable instead."

    mode: str | None = None
    "Determines what happens when a user clicks on the <SignInButton>. Setting this to 'redirect' will redirect the user to the sign-in route. Setting this to 'modal' will open a modal on the current route. Defaults to 'redirect'."

force_redirect_url = None class-attribute instance-attribute

If provided, this URL will always be redirected to after the user signs in. It's recommended to use the environment variable instead.

fallback_redirect_url = None class-attribute instance-attribute

The fallback URL to redirect to after the user signs in, if there's no redirect_url in the path already. Defaults to /. It's recommended to use the environment variable instead.

sign_up_force_redirect_url = None class-attribute instance-attribute

If provided, this URL will always be redirected to after the user signs up. It's recommended to use the environment variable instead.

sign_up_fallback_redirect_url = None class-attribute instance-attribute

The fallback URL to redirect to after the user signs up, if there's no redirect_url in the path already. Defaults to /. It's recommended to use the environment variable instead.

mode = None class-attribute instance-attribute

Determines what happens when a user clicks on the . Setting this to 'redirect' will redirect the user to the sign-in route. Setting this to 'modal' will open a modal on the current route. Defaults to 'redirect'.

SignOutButton

Bases: ClerkBase

Source code in custom_components/reflex_clerk_api/unstyled_components.py 
42
43
44
45
46
class SignOutButton(ClerkBase):
    tag = "SignOutButton"

    redirect_url: str | None = None
    "The full URL or path to navigate after successful sign-out."

redirect_url = None class-attribute instance-attribute

The full URL or path to navigate after successful sign-out.