Interface Widget<T>

Widget interface. Every widget implements this interface.

Type Parameters

T extends WidgetType

Hierarchy

Widget

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.
- Optional params: WidgetParameters[T]
  
  widget parameters.
Returns void
- Defined in checkout/sdk/src/widgets/definitions/types.ts:238

unmount

unmount(): void
Unmount a widget and reset parameters

Returns void
- Defined in checkout/sdk/src/widgets/definitions/types.ts:242

update

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

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) => void)
  
  function to execute when the event is received.
  - - (data): void
    - Parameters
      
      data: WidgetEventData[T][KEventName]
      
      Returns void
Returns void
- Defined in checkout/sdk/src/widgets/definitions/types.ts:254

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 checkout/sdk/src/widgets/definitions/types.ts:260

Generated using TypeDoc