Struct UserButtonOptions 

pub struct UserButtonOptions { /* private fields */ }

Options for the Clerk user button.

Implementations

impl UserButtonOptions

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 UserButtonOptions

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

Set the URL Clerk should use after sign-out.

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

Set the URL Clerk should use after switching sessions in multi-session apps.

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

Set the URL Clerk should use when adding another account.

pub fn show_name(self, value: bool) -> Self

Show the user’s name next to the avatar when Clerk supports it.

pub fn default_open(self, value: bool) -> Self

Open the user button menu by default on first render.

pub fn user_profile_mode(self, value: UserProfileMode) -> Self

Set the user profile mode, for example "modal" or "navigation".

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

Set the user profile URL for navigation mode.

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

Forward options to the underlying UserProfile component.

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

Forward Clerk’s raw appearance object.

Trait Implementations

impl Clone for UserButtonOptions

fn clone(&self) -> UserButtonOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UserButtonOptions

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

Formats the value using the given formatter.

impl Default for UserButtonOptions

fn default() -> UserButtonOptions

Returns the “default value” for a type.

impl Eq for UserButtonOptions

impl From<&UserButtonOptions> for Value

fn from(options: &UserButtonOptions) -> Self

Converts to this type from the input type.

impl From<UserButtonOptions> for Value

fn from(options: UserButtonOptions) -> Self

Converts to this type from the input type.

impl From<Value> for UserButtonOptions

fn from(value: Value) -> Self

Converts to this type from the input type.

impl PartialEq for UserButtonOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for UserButtonOptions