Skip to content

Documentation / @frak-labs/core-sdk / actions / modalBuilder

Function: modalBuilder()

modalBuilder(client, args): ModalBuilder

Defined in: actions/wrapper/modalBuilder.ts:98

Helper to craft Frak modal, and share a base initial config

Parameters

client

FrakClient

The current Frak Client

args

login?

ModalStepMetadata & { allowSso: true; ssoMetadata?: SsoMetadata; } | ModalStepMetadata & { allowSso?: false; ssoMetadata?: undefined; }

Login step parameters

metadata?

ModalRpcMetadata

Common modal metadata (customisation, language etc)

Returns

ModalBuilder

Example

Here is an example of how to use the modalBuilder to create and display a sharing modal:

// Create the modal builder
const modalBuilder = window.FrakSDK.modalBuilder(frakClient, baseModalConfig);
 
// Configure the information to be shared via the sharing link
const sharingConfig = {
  popupTitle: "Share this with your friends",
  text: "Discover our product!",
  link: window.location.href,
};
 
// Display the sharing modal
function modalShare() {
  modalBuilder.sharing(sharingConfig).display();
}

See