Interface KlarnaIdentityButton

Interface to the Identity Button interface.

interface KlarnaIdentityButton {
    htmlElement: HTMLElement;
    id?: string;
    attach(customButtonSelector: string): this;
    attach(customButtonElement: HTMLElement): this;
    detach(): this;
    mount(containerSelector: string): this;
    mount(containerElement: HTMLElement): this;
    on(event: "render", callback: (button: this) => Promise<void>): this;
    on(event: "click", callback: (button: this) => Promise<void>): this;
    toggleState(state: "disabled" | "loading", value?: boolean): this;
    unmount(): this;
}

Hierarchy (View Summary)

Properties

htmlElement id?

Methods

attach detach mount on toggleState unmount

Properties

htmlElement

htmlElement: HTMLElement

Optionalid

id?: string

Methods

attach

  • attach(customButtonSelector: string): this

  • Programmatically attach the Identity Button behavior to a merchant's custom button element.

    Timings

    • When using attach method the render event is triggered after the button event handlers were attached to the custom button and openid configuration was fetched.

    Parameters

    • customButtonSelector: string

    Returns this

  • attach(customButtonElement: HTMLElement): this

  • Parameters

    • customButtonElement: HTMLElement

    Returns this

detach

  • detach(): this

  • Programmatically detaches the Identity Button behavior from merchant's custom button element

    Returns this

mount

  • mount(containerSelector: string): this

  • Parameters

    • containerSelector: string

    Returns this

  • mount(containerElement: HTMLElement): this

  • Parameters

    • containerElement: HTMLElement

    Returns this

on

  • on(event: "render", callback: (button: this) => Promise<void>): this

  • The render event is triggered after the button is fully visible.

    Parameters

    • event: "render"

      render

    • callback: (button: this) => Promise<void>

      Render event handler callback, triggered on render.

    Returns this

  • on(event: "click", callback: (button: this) => Promise<void>): this

  • The click event is triggered after the button is clicked.

    Parameters

    • event: "click"

      click

    • callback: (button: this) => Promise<void>

      Render event handler callback, triggered on click.

    Returns this

toggleState

  • toggleState(state: "disabled" | "loading", value?: boolean): this

  • Parameters

    • state: "disabled" | "loading"

      State "disabled" disables/enables the button, e.g. makes it non-interactive/interactive State "loading" displays/hides the loading indicator in the button

    • Optionalvalue: boolean

      can be used to set the state to a specific value instead of toggling

    Returns this

unmount

Settings

Member Visibility

On This Page

Properties
Methods