Type Alias: MountAuth()

MountAuth = (payload) => Promise<Nullable<MountRoot>>

Unified method to mount any type of authentication-related embed.

This method creates and configures a React-based rendering context for authentication components, returning a mount root object that allows you to render specific authentication UIs (login, user profile, forgot password) and unmount them when needed.

When using <mmq-auth> component, this method is called internally with the proper configuration derived from window.mimeeqEmbedEnv.

Parameters

payload

MountPayload

Configuration options for mounting the authentication component

Returns

Promise<Nullable<MountRoot>>

A promise that resolves to an object with render and unmount methods

Example

// Mount an authentication component
const mountRoot = await window.mimeeqAuth.mount({
  CDNPath: window.mimeeqEmbedEnv.CDNPath,
  baseURL: window.mimeeqEmbedEnv.APIPath,
  customerId: 'customer123',
  node: document.getElementById('auth-container'),
  uid: 'auth-embed'
});

// Render a login form
mountRoot.render({
  embedType: 'LOGIN',
  onLoginSuccess: (user) => {
    console.log('User logged in successfully:', user);
    window.location.reload();
  }
});

// Or render a user profile
mountRoot.render({
  embedType: 'USER_PROFILE'
});

// Or render a forgot password form
mountRoot.render({
  embedType: 'FORGOT_PASSWORD',
  onLoginSuccess: (user) => {
    console.log('Password reset successfully, user logged in:', user);
    window.location.reload();
  }
});

// Unmount the component when done
mountRoot.unmount();