Struct SignUpOptions 

pub struct SignUpOptions { /* private fields */ }

Options for sign-up UI and modal flows.

Implementations

impl SignUpOptions

pub fn new() -> Self

Start with an empty Clerk options object.

pub fn from_value(value: Value) -> Self

Wrap an already-built JSON value.

pub fn option(self, key: impl Into<String>, value: impl Into<Value>) -> Self

Set a raw clerk-js option by its JavaScript key.

If the wrapped value is not a JSON object, it is replaced with an empty object before the key is set.

pub fn into_value(self) -> Value

Convert into the raw JSON value passed to clerk-js.

impl SignUpOptions

pub fn routing(self, value: Routing) -> Self

Set embedded routing mode, for example "path" or "hash".

pub fn path(self, value: impl Into<String>) -> Self

Set the path used by embedded routing.

pub fn sign_in_url(self, value: impl Into<String>) -> Self

Set the sign-in URL linked from the sign-up flow.

pub fn waitlist_url(self, value: impl Into<String>) -> Self

Set the waitlist URL linked from the sign-up flow.

pub fn force_redirect_url(self, value: impl Into<String>) -> Self

Always redirect here after sign-up.

pub fn fallback_redirect_url(self, value: impl Into<String>) -> Self

Fallback redirect URL after sign-up.

pub fn sign_in_force_redirect_url(self, value: impl Into<String>) -> Self

Always redirect here after sign-in from sign-up.

pub fn sign_in_fallback_redirect_url(self, value: impl Into<String>) -> Self

Fallback redirect URL after sign-in from sign-up.

pub fn initial_values(self, value: Value) -> Self

Forward Clerk’s raw initialValues object.

pub fn appearance(self, value: Value) -> Self

Forward Clerk’s raw appearance object.

Trait Implementations

impl Clone for SignUpOptions

fn clone(&self) -> SignUpOptions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SignUpOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SignUpOptions

fn default() -> SignUpOptions

Returns the “default value” for a type.

impl Eq for SignUpOptions

impl From<&SignUpOptions> for Value

fn from(options: &SignUpOptions) -> Self

Converts to this type from the input type.

impl From<SignUpOptions> for Value

fn from(options: SignUpOptions) -> Self

Converts to this type from the input type.

impl From<Value> for SignUpOptions

fn from(value: Value) -> Self

Converts to this type from the input type.

impl PartialEq for SignUpOptions

fn eq(&self, other: &SignUpOptions) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for SignUpOptions