@wepin/modal-js

The Wepin Modal Library is designed for web environments. This package is not available for other platforms.

⏩ Installation

To install the Wepin Modal Library, you can use npm or yarn:

npm install @wepin/modal-js

or

yarn add @wepin/modal-js

⏩ Import Wepin Modal Library

import { WepinModal } from '@wepin/modal-js'

const wepinModal = new WepinModal()

With the Wepin Modal Library imported, you can now use the WepinModal instance to call various methods.

⏩ Methods

openModal

await wepinModal.openModal(url, EL, options?)

This method opens a Wepin modal iframe with the provided URL. The EL parameter is a function that handles postMessage events. The options parameter is an optional object that can be used to customize the modal's behavior.

Parameters

• url <string> - The URL to be loaded in the Wepin modal iframe.
• EL <Function> - The function to handle postMessage events from the iframe.
• options <object> optional - settings for the modal. Currently supports:
  • isHide <boolean> - If true, the modal will be hidden initially

Returns

• WidgetFrame - The frame of the opened modal.

Example

await wepinModal.openModal('wepin url', (event)=>{})

closeModal

await wepinModal.closeModal()

If the iframe Wepin modal is open, this method will close it.

Parameters

• void

Example

await wepinModal.closeModal()

openAuthBrowser

await wepinModal.openAuthBrowser(url, EL)

This method opens a new window for the Wepin browser to handle OAuth provider login.

Parameters

• url <string> - The URL to open in the Wepin browser.
• EL <Function> - The postMessage event handler.

Returns

• WidgetWindow - The browser of the opened window.

Example

await wepinModal.openAuthBrowser('wepin url', (event)=>{})

closeAuthBrowser

await wepinModal.closeAuthBrowser()

This method closes the Wepin browser window that was previously opened for OAuth provider login.

Parameters

• void

Example

await wepinModal.closeAuthBrowser()