moduleLoaded

The widget has finished loading.

Details

It is emitted when the internal engine has finished its Initialization and the Widget is ready.

Event: prefix

Type: FacephiSelphidWidgetCustomEvent<WidgetLoadedEvent> | CustomEvent<WidgetLoadedEvent>

Syntax

selphid.addEventListener('moduleLoaded', onModuleLoaded);

Received object

The useful payload is of type SelphidWidgetLoadedDetail and is in event.detail.detail:

• eventType (string): Type of event emitted.

• camerasDeviceInfo (MediaTrackSettings[] | string): Information about the device's cameras.

• deviceType (string): Type of device in use.

• resolutionHeight (number): Initial height resolution.

• resolutionWidth (number): Initial width resolution.

• widgetConfiguration (object): Effective configuration applied to the engine (e.g. DocumentType, Rules, CaptureTimeout).

• widgetVersion (string): Version of the engine component.

Description

Allows external loading screens to be hidden or logic to be executed when the widget is ready to interact.

Considerations

The useful payload is in event.detail.detail (see event format). widgetConfiguration reflects the final values after applying the wrapper's defaults and props.

---

Example

<facephi-selphid-widget
    onModuleLoaded={(event) => {
      const { widgetVersion, resolutionWidth, resolutionHeight } = event.detail.detail;
      console.log('SelphID loaded:', widgetVersion, resolutionWidth, resolutionHeight);
    }}
/>

import { type SelphidWidgetLoadedDetail } from '@facephi/sdk-web-wc';

selphid.addEventListener('moduleLoaded', (event) => {
  const detail: SelphidWidgetLoadedDetail = event.detail.detail;
});