Unstyled components

Stub file for reflex_clerk_api/unstyled_components.py

SignUpButton

Bases: ClerkBase

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

Source code in custom_components/reflex_clerk_api/unstyled_components.py

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'.

create(*children, force_redirect_url=None, fallback_redirect_url=None, sign_in_force_redirect_url=None, sign_in_fallback_redirect_url=None, mode=None, style=None, key=None, id=None, ref=None, class_name=None, custom_attrs=None, on_blur=None, on_click=None, on_context_menu=None, on_double_click=None, on_focus=None, on_mount=None, on_mouse_down=None, on_mouse_enter=None, on_mouse_leave=None, on_mouse_move=None, on_mouse_out=None, on_mouse_over=None, on_mouse_up=None, on_scroll=None, on_scroll_end=None, on_unmount=None, **props) classmethod

Create the component.

Parameters:

Name	Type	Description	Default
*children		The children of the component.	()
style	Sequence[Mapping[str, Any]] | Mapping[str, Any] | Var[Mapping[str, Any]] | Breakpoints | None	The style of the component.	None
key	Any | None	A unique key for the component.	None
id	Any | None	The id for the component.	None
ref	Var | None	The Var to pass as the ref to the component.	None
class_name	Any | None	The class name for the component.	None
custom_attrs	dict[str, Var | Any] | None	custom attribute	None
**props		The props of the component.	{}

Returns:

Type	Description
SignUpButton	The component.

Source code in custom_components/reflex_clerk_api/unstyled_components.py

    "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'."


class SignOutButton(ClerkBase):
    tag = "SignOutButton"

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


sign_up_button = SignUpButton.create
sign_in_button = SignInButton.create
sign_out_button = SignOutButton.create

SignInButton

Bases: ClerkBase

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

Source code in custom_components/reflex_clerk_api/unstyled_components.py

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'.

create(*children, force_redirect_url=None, fallback_redirect_url=None, sign_up_force_redirect_url=None, sign_up_fallback_redirect_url=None, mode=None, style=None, key=None, id=None, ref=None, class_name=None, custom_attrs=None, on_blur=None, on_click=None, on_context_menu=None, on_double_click=None, on_focus=None, on_mount=None, on_mouse_down=None, on_mouse_enter=None, on_mouse_leave=None, on_mouse_move=None, on_mouse_out=None, on_mouse_over=None, on_mouse_up=None, on_scroll=None, on_scroll_end=None, on_unmount=None, **props) classmethod

Create the component.

Parameters:

Name	Type	Description	Default
*children		The children of the component.	()
style	Sequence[Mapping[str, Any]] | Mapping[str, Any] | Var[Mapping[str, Any]] | Breakpoints | None	The style of the component.	None
key	Any | None	A unique key for the component.	None
id	Any | None	The id for the component.	None
ref	Var | None	The Var to pass as the ref to the component.	None
class_name	Any | None	The class name for the component.	None
custom_attrs	dict[str, Var | Any] | None	custom attribute	None
**props		The props of the component.	{}

Returns:

Type	Description
SignInButton	The component.

SignOutButton

Bases: ClerkBase

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

Source code in custom_components/reflex_clerk_api/unstyled_components.py

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.

create(*children, redirect_url=None, style=None, key=None, id=None, ref=None, class_name=None, custom_attrs=None, on_blur=None, on_click=None, on_context_menu=None, on_double_click=None, on_focus=None, on_mount=None, on_mouse_down=None, on_mouse_enter=None, on_mouse_leave=None, on_mouse_move=None, on_mouse_out=None, on_mouse_over=None, on_mouse_up=None, on_scroll=None, on_scroll_end=None, on_unmount=None, **props) classmethod

Create the component.

Parameters:

Name	Type	Description	Default
*children		The children of the component.	()
style	Sequence[Mapping[str, Any]] | Mapping[str, Any] | Var[Mapping[str, Any]] | Breakpoints | None	The style of the component.	None
key	Any | None	A unique key for the component.	None
id	Any | None	The id for the component.	None
ref	Var | None	The Var to pass as the ref to the component.	None
class_name	Any | None	The class name for the component.	None
custom_attrs	dict[str, Var | Any] | None	custom attribute	None
**props		The props of the component.	{}

Returns:

Type	Description
SignOutButton	The component.