Creating Widgets

All of these methods can be found in the livelike-widget element reference documentation

Widget can be created with multiple different methods.

πŸ“˜

A widget id or widgetPayload is needed for all following methods.

The following methods are for displaying widgets previously published through the API or Producer Suite.

To handle new widgets that are being published where you do not have access to the id or payload yet, see the Widget Modes section

createWidgetElement

With createWidgetElement, you can immediately display a widget on the page by passing in the widget kind and id. This is useful if you just want to display a widget that has already been posted.

const widgetContainer = document.querySelector('livelike-widgets');

widgetContainer.createWidgetElement({kind: 'text-poll', id: 'widgetid' });

showWidget

With showWidget, you can display a widget if you already have the widgetPayload. This is useful if you need to access the widgetPayload before displaying the widget. If you do not have the widgetPayload yet, the getWidget method can be used in conjunction with the showWidget method.

const widgetContainer = document.querySelector('livelike-widgets');

LiveLike.getWidget({kind: 'text-poll', id: 'widgetid' })
  .then(widgetPayload => widgetContainer.showWidget({ widgetPayload }));

createSyncWidget

The SDK has a built-in queue system by default. This is used for Spoiler Prevention when used with a custom syncStrategy. Learn more about Spoiler Prevention

When creating a widget with createSyncWidget, it will be displayed according to the syncStrategy

const widgetContainer = document.querySelector('livelike-widgets');

widgetContainer.createSyncWidget({kind: 'text-poll', id: 'widgetid' });

enqueueWidget

The enqueueWidget method works similaraly to the showWidget method above, except it will displayed according to the syncStrategy

const widgetContainer = document.querySelector('livelike-widgets');

LiveLike.getWidget({kind: 'text-poll', id: 'widgetid' })
  .then(widgetPayload => widgetContainer.enqueueWidget({ widgetPayload }));