Posos Widgets JavaScript SDK
    Preparing search index...

    Interface WidgetOptions

    interface WidgetOptions {
        authToken?: string;
        baseUrl?: string;
        debug?: boolean;
        env?: "preprod" | "production";
        frameHeight?: number;
        frameWidth?: number;
        locale?: string;
        signingKey?: string;
        softwareId?: string;
        theme?: string;
        userId?: string;
    }
    Index

    Properties

    authToken? baseUrl? debug? env? frameHeight? frameWidth? locale? signingKey? softwareId? theme? userId?

    Properties

    authToken?: string

    The authentication token (JWT) for the widget.

    baseUrl?: string

    The base URL of the widget.

    debug?: boolean

    Whether to enable debug mode.

    false
    env?: "preprod" | "production"

    The widget environment.

    "production"

    This option has no effect if baseUrl is set.

    frameHeight?: number

    The height of the widget’s iframe (in pixels).

    768

    The minimum accepted height is 768.

    frameWidth?: number

    The width of the widget’s iframe (in pixels).

    600

    The minimum accepted width is 600.

    locale?: string

    The language for the user interface of the widget.

    "fr"
    signingKey?: string

    The base64-encoded signing key using the ES256 algorithm.

    Please use the new authentication flow with authToken. Check out the documentation for more information.

    softwareId?: string

    The software identifier making the widget call.

    Please use the new authentication flow with authToken. Check out the documentation for more information.

    theme?: string

    The widget’s user interface theme.

    "posos"
    userId?: string

    The identifier of the user making the widget call.

    Please use the new authentication flow with authToken. Check out the documentation for more information.

    Settings

    Member Visibility

    On This Page

    Properties