Interface Widget<T>

Widget interface. Every widget implements this interface.

interface Widget<T> {
    mount(id: string, params?: WidgetParameters[T]): void;
    unmount(): void;
    update(props: WidgetProperties<T>): void;
    addListener<KEventName>(type: KEventName, callback: ((data: WidgetEventData[T][KEventName]) => void)): void;
    removeListener<KEventName>(type: KEventName): void;
}

Type Parameters

T extends WidgetType

Index

Methods

mount unmount update addListener removeListener

Methods

mount

mount(id, params?): void
Mount a widget to a DOM ref element.
Parameters
- id: string
  ID of the DOM element where the widget will be mounted.
- Optionalparams: WidgetParameters[T]
  widget parameters.
Returns void
- Defined in packages/checkout/sdk/dist/widgets/definitions/types.d.ts:199

unmount

unmount(): void
Unmount a widget and reset parameters

Returns void
- Defined in packages/checkout/sdk/dist/widgets/definitions/types.d.ts:203

update

update(props): void
Update the widget properties
Parameters
- props: WidgetProperties<T>
  Widget specific properties including configuration
Returns void
- Defined in packages/checkout/sdk/dist/widgets/definitions/types.d.ts:208

addListener

addListener<KEventName>(type, callback): void
Add a listener for a widget event.
Type Parameters
- KEventName extends string | number | symbol
Parameters
- type: KEventName
- callback: ((data: WidgetEventData[T][KEventName]) => void)
  function to execute when the event is received.
  - - (data): void
    - Parameters
      data: WidgetEventData[T][KEventName]
      Returns void
Returns void
- Defined in packages/checkout/sdk/dist/widgets/definitions/types.d.ts:214

removeListener

removeListener<KEventName>(type): void
Removes an event listener for a widget event.
Type Parameters
- KEventName extends string | number | symbol
Parameters
- type: KEventName
  Widget specific event name.
Returns void
- Defined in packages/checkout/sdk/dist/widgets/definitions/types.d.ts:219