Skip to content

Clerk api pages

Mostly direct copies from reflex-clerk, but with clerk_keys specified explicitly in the wrap_in_clerk_provider.

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

install_signin_page(app, route='/signin', **props)

Add signin page to app.

Example
import reflex_clerk

app = App()
reflex_clerk.install_signin_page(app, publishable_key="your_publishable_key")
PARAMETER DESCRIPTION
app

The app instance to install the login page on.

TYPE: App

route

The route to install the login page on. Defaults to "/signin".

TYPE: str DEFAULT: '/signin'

install_signup_page(app, route='/signup', **props)

Add signup page to app.

Example
import reflex_clerk

app = App()
reflex_clerk.install_signup_page(app, publishable_key="your_publishable_key")
PARAMETER DESCRIPTION
app

The app instance to install the login page on.

TYPE: App

route

The route to install the login page on. Defaults to "/signup".

TYPE: str DEFAULT: '/signup'

wrap_in_clerk_provider(*children)

Wrap with the clerk provider.

Note: Do not nest clerk providers.