Skip to content

Control components

ClerkLoaded

Bases: ClerkBase

Only renders children after authentication has been checked.

Source code in custom_components/reflex_clerk_api/control_components.py 
 9
10
11
12
class ClerkLoaded(ClerkBase):
    """Only renders children after authentication has been checked."""

    tag = "ClerkLoaded"

ClerkLoading

Bases: ClerkBase

Only renders childen while Clerk authenticates the user.

Source code in custom_components/reflex_clerk_api/control_components.py 
15
16
17
18
class ClerkLoading(ClerkBase):
    """Only renders childen while Clerk authenticates the user."""

    tag = "ClerkLoading"

Protect

Bases: ClerkBase

Source code in custom_components/reflex_clerk_api/control_components.py 
21
22
23
24
25
26
27
28
29
30
31
class Protect(ClerkBase):
    tag = "Protect"

    condition: Javascript | None = None
    "Optional conditional logic that renders the children if it returns true"
    fallback: JSX | None = None
    "An optional snippet of JSX to show when a user doesn't have the role or permission to access the protected content."
    permission: str | None = None
    "Optional string corresponding to a Role's Permission in the format org:<resource>:<action>"
    role: str | None = None
    "Optional string corresponding to an Organization's Role in the format org:<role>"

condition = None class-attribute instance-attribute

Optional conditional logic that renders the children if it returns true

fallback = None class-attribute instance-attribute

An optional snippet of JSX to show when a user doesn't have the role or permission to access the protected content.

permission = None class-attribute instance-attribute

Optional string corresponding to a Role's Permission in the format org::

role = None class-attribute instance-attribute

Optional string corresponding to an Organization's Role in the format org:

RedirectToSignIn

Bases: ClerkBase

Immediately redirects the user to the sign in page when rendered.

Source code in custom_components/reflex_clerk_api/control_components.py 
34
35
36
37
38
39
40
41
42
43
44
class RedirectToSignIn(ClerkBase):
    """Immediately redirects the user to the sign in page when rendered."""

    tag = "RedirectToSignIn"

    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 /."
    sign_in_force_redirect_url: str | None = None
    "If provided, this URL will always be redirected to after the user signs in."
    initial_values: SignInInitialValues | None = None
    "The values used to prefill the sign-in fields with."

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

sign_in_force_redirect_url = None class-attribute instance-attribute

If provided, this URL will always be redirected to after the user signs in.

initial_values = None class-attribute instance-attribute

The values used to prefill the sign-in fields with.

RedirectToSignUp

Bases: ClerkBase

Immediately redirects the user to the sign up page when rendered.

Source code in custom_components/reflex_clerk_api/control_components.py 
47
48
49
50
51
52
53
54
55
56
57
class RedirectToSignUp(ClerkBase):
    """Immediately redirects the user to the sign up page when rendered."""

    tag = "RedirectToSignUp"

    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 /."
    sign_up_force_redirect_url: str | None = None
    "If provided, this URL will always be redirected to after the user signs up."
    initial_values: SignUpInitialValues | None = None
    "The values used to prefill the sign-up fields with."

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

sign_up_force_redirect_url = None class-attribute instance-attribute

If provided, this URL will always be redirected to after the user signs up.

initial_values = None class-attribute instance-attribute

The values used to prefill the sign-up fields with.

RedirectToUserProfile

Bases: ClerkBase

Immediately redirects the user to their profile page when rendered.

Source code in custom_components/reflex_clerk_api/control_components.py 
60
61
62
63
class RedirectToUserProfile(ClerkBase):
    """Immediately redirects the user to their profile page when rendered."""

    tag = "RedirectToUserProfile"

SignedIn

Bases: ClerkBase

Only renders children when the user is signed in.

Source code in custom_components/reflex_clerk_api/control_components.py 
74
75
76
77
class SignedIn(ClerkBase):
    """Only renders children when the user is signed in."""

    tag = "SignedIn"

SignedOut

Bases: ClerkBase

Only renders children when the user is signed out.

Source code in custom_components/reflex_clerk_api/control_components.py 
80
81
82
83
class SignedOut(ClerkBase):
    """Only renders children when the user is signed out."""

    tag = "SignedOut"