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

    Interface JoinWithTokenFormSubmitInfo

    Props for the JoinWithTokenForm component.

    This component provides a form for joining a room via an invite link. It uses the useJoinToken hook internally to handle token validation and room joining.

    function JoinPage() {
      const searchParams = new URLSearchParams(window.location.search);
      const joinToken = searchParams.get('joinToken');
      const region = searchParams.get('region');

      if (!joinToken || !region) {
        return <div>Invalid invite link</div>;
      }

      return (
        <JoinWithTokenForm
          joinToken={joinToken}
          region={region}
          onJoinSuccess={() => console.log('Joined!')}
          onCreateRoom={() => window.location.href = '/'}
        />
      );
    }
    interface JoinWithTokenFormSubmitInfo {
        email: string;
        password: string;
        userId: string;
        userName: string;
    }
    Index

    Properties

    email password userId userName

    Properties

    email: string

    Trimmed email the user typed (only meaningful when showEmailField). Empty string when the field is hidden or left blank.

    password: string

    Trimmed password the user typed. Empty string when no password.

    userId: string

    The userId the form would have used to join — email when useEmailAsUserId is enabled and the email is well-formed, otherwise userName. Consumers running their own join (e.g. inserting a device preview before joining) should pass this through to joinRoom.

    userName: string

    Trimmed display name the user typed.

    Settings

    Member Visibility

    On This Page

    Properties