Skip to main content

mmq-auth

Overview

A Mimeeq Auth is a component for loading Mimeeq authentication on your app. After adding it in your DOM you can call trigger on it methods to display authorization forms in Mimeeq dialog.

Basic Usage

<mmq-auth short-code="SHORT_CODE" locale="en"></mmq-auth>

Properties

PropertyAttributeDescriptionTypeDefault
accentColoraccent-colorCustom accent colorstringundefined
accentTextColoraccent-text-colorCustom text color on controls with accent color as backgroundstringundefined
backgroundColorbackground-colorCustom background colorstringundefined
localelocaleLocale codestring'en'
preserveFontpreserve-fontIf true, inherit font family from websitebooleanundefined
shortCodeshort-codeEmbed shortcodestringundefined

Events

EventDescriptionType
mimeeq-auth-loadedEvent emitted after embed with current short code was loadedCustomEvent<any>
mimeeq-login-successEvent emitted after successful sign upCustomEvent<UserData>

Methods

mountForgotPassword() => Promise<void>

Render forgot password form in Mimeeq modal

Returns

Type: Promise<void>

mountLogin() => Promise<void>

Render sign in form in Mimeeq modal

Returns

Type: Promise<void>

mountUserProfile() => Promise<void>

Render current user information in Mimeeq modal. It also allows for edit of this information. Available only after sign in.

Returns

Type: Promise<void>