Hiyve Components - v1.0.0
    Preparing search index...

    Interface JoinWithTokenFormProps

    interface JoinWithTokenFormProps {
        autoValidate?: boolean;
        colors?: Partial<JoinWithTokenFormColors>;
        emailStorageKey?: string;
        icons?: Partial<JoinWithTokenFormIcons>;
        initialEmail?: string;
        initialUserName?: string;
        joinToken: string;
        labels?: Partial<JoinWithTokenFormLabels>;
        minNameLength?: number;
        onCreateRoom?: () => void;
        onEmailChange?: (email: string) => void;
        onJoinSuccess?: () => void;
        onSubmit?: (info: JoinWithTokenFormSubmitInfo) => void;
        onUserNameChange?: (name: string) => void;
        region: string;
        showEmailField?: boolean;
        styles?: Partial<JoinWithTokenFormStyles>;
        submitMode?: "join" | "continue";
        sx?: SxProps<Theme>;
        useEmailAsUserId?: boolean;
        userNameStorageKey?: string;
    }
    Index

    Properties

    autoValidate? colors? emailStorageKey? icons? initialEmail? initialUserName? joinToken labels? minNameLength? onCreateRoom? onEmailChange? onJoinSuccess? onSubmit? onUserNameChange? region showEmailField? styles? submitMode? sx? useEmailAsUserId? userNameStorageKey?

    Properties

    autoValidate?: boolean

    Auto-validate token on mount

    colors?: Partial<JoinWithTokenFormColors>

    Custom colors

    emailStorageKey?: string

    LocalStorage key for persisting the email — defaults to 'hiyve-join-token-userEmail'.

    icons?: Partial<JoinWithTokenFormIcons>

    Custom icons

    initialEmail?: string

    Initial email value (only used when showEmailField).

    initialUserName?: string

    Initial user name value

    joinToken: string

    Join token from the invite link

    labels?: Partial<JoinWithTokenFormLabels>

    Custom labels for i18n support

    minNameLength?: number

    Minimum name length required

    onCreateRoom?: () => void

    Callback when user clicks "create room" link

    onEmailChange?: (email: string) => void

    Callback when the optional email value changes (only relevant when showEmailField is true).

    onJoinSuccess?: () => void

    Callback when room is successfully joined (only fires in submitMode='join').

    onSubmit?: (info: JoinWithTokenFormSubmitInfo) => void

    Called in submitMode='continue' when the user submits the form. Receives the trimmed credentials plus the resolved userId the consumer should pass to joinRoom themselves.

    onUserNameChange?: (name: string) => void

    Callback when user name changes

    region: string

    Region from the invite link

    showEmailField?: boolean

    When true, render an optional email field below the name. Validates format when filled (any value is accepted as long as it parses as an email) and disables the submit button on a malformed entry.

    styles?: Partial<JoinWithTokenFormStyles>

    Custom styles

    submitMode?: "join" | "continue"

    'join' (default): clicking the submit button calls joinRoom and fires onJoinSuccess. 'continue': clicking calls onSubmit with the captured credentials and does NOT join — useful when the consumer wants to insert intermediate UI (e.g. a device-preview lobby) before the actual join.

    sx?: SxProps<Theme>

    MUI sx prop for container styling

    useEmailAsUserId?: boolean

    When true and a well-formed email is provided, the form passes the email as the userId to joinRoom instead of the display name. The display name still appears in the room participant list via the consumer's identity wiring.

    userNameStorageKey?: string

    LocalStorage key for persisting user name

    Settings

    Member Visibility

    On This Page

    Properties