Skip to content

init

__all__ = ['ClerkRepository', 'ClerkRepositoryProtocol', 'install_pages', 'wrap_in_clerk_provider'] module-attribute

ClerkRepository

clerk = clerk instance-attribute

__init__(clerk)

create_user(db_id, first_name, last_name, email_address, password, _skip_password_checks=False) async

from_secret_token(secret_token) classmethod

get_user(clerk_id) async

ClerkRepositoryProtocol

Bases: Protocol

create_user(db_id, first_name, last_name, email_address, password, _skip_password_checks=False) async

get_user(clerk_id) async

install_pages(app, signin_route='/signin', signup_route='/signup', **props)

Installs the signin and signup pages for the given app.

PARAMETER DESCRIPTION
app

The app instance for which the pages need to be installed.

TYPE: App

signin_route

The route at which the signin page should be installed. Defaults to "/signin".

TYPE: str DEFAULT: '/signin'

signup_route

The route at which the signup page should be installed. Defaults to "/signup".

TYPE: str DEFAULT: '/signup'

**props

Additional properties to pass to the signin and signup pages.

DEFAULT: {}

Example
import reflex_clerk as clerk
import reflex as rx

app = rx.App()
clerk.install_pages(app, publishable_key="your_publishable_key")
RETURNS DESCRIPTION
None

None

wrap_in_clerk_provider(*children)

Wrap with the clerk provider.

Note: Do not nest clerk providers.