Contextual Help Touchpoint Events

mindtouch-web-widget:f1:ready

Fired when the F1 widget is created. The event data contains the following properties:

 document.addEventListener('mindtouch-web-widget:f1:ready', ({ data }) => {
    const embedId = data.embedId;
});

mindtouch-web-widget:f1:loaded

Fired when the F1 widget is loaded. The event data contains the following properties:

document.addEventListener('mindtouch-web-widget:f1:loaded', ({ data }) => {
    const embedId = data.embedId;
    
    // programmable widget interface contains properties and functions
    const widget = data.widget;
});

mindtouch-web-widget:f1:modal-rendered

Fired when the F1 dialog modal wrapper has been rendered. The event data contains the following properties:

document.addEventListener('mindtouch-web-widget:f1:modal-rendered', ({ data }) => {
    const embedId = data.embedId;
    const modal = data.modal;
});

mindtouch-web-widget:f1:dialog-rendered

Fired when the F1 dialog is displayed to the user. The event data contains the following properties:

document.addEventListener('mindtouch-web-widget:f1:dialog-rendered', ({ data }) => {
    const embedId = data.embedId;
    const modal = data.modal;
});

mindtouch-web-widget:f1:clicked

Fired when an element designated to launch the dialog is clicked. If the event’s preventDefault function is called, the click will be ignored, and the dialog will not be launched. The event data contains the following properties:

document.addEventListener('mindtouch-web-widget:f1:clicked', (event) => {
    const embedId = event.data.embedId;
    const href = event.data.href;
    
    // optionally prevents dialog from launching
    event.preventDefault();
});

dialog

dialog : element

The DOM Element of the dialog that has been rendered.

embedId

embedId : string

The id of the widget that uniquely identifies it.

href

href : string

The F1 widget current page location or upcoming page location as the result of navigation.

modal

modal : element

The DOM Element of the dialog modal wrapper that has been rendered.

open

open(string href) : void

Opens the F1 dialog with content from the provided Expert site URL. This function accepts the following parameters:

document.addEventListener('mindtouch-web-widget:f1:loaded', ({ data }) => {
    const widget = data.widget;
    widget.open('https://success.example.com/foo');
});