Skip to main content

Type Alias: Mount()

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

Unified method to mount any type of embed component.

When used with mimeeqAuth, this method supports authentication-related embed types (LOGIN, USER_PROFILE, FORGOT_PASSWORD). When used with mimeeqApp, this method supports all embed types including configurators, product lists, and authentication.

This method creates and configures a React-based rendering context, returning a mount root object that allows you to render specific UIs and unmount them when needed.

Parameters​

payload​

MountPayload

Configuration options for mounting the component

Returns​

Promise<Nullable<MountRoot>>

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

Example​

// When used with mimeeqAuth (authentication embeds only)
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:', user)
});