Liveshop Web SDK - Widget Button Options
Liveshop Web SDK - Widget Options
This documentation explains all possible options of using Widget feature in Liveshop Web SDK
| Property | Type | Required | Details |
|---|---|---|---|
| live | string | ✅ | Sets the live link (default: null) |
| bg | string | ❌ | Sets a background to the button. It accept jpeg, jpg, png or gif format (default: null) |
| positionX | "left" | "right" | ❌ | Sets the horizontal position (default: "right") |
| positionY | "up" | "down" | ❌ | Sets the vertical position (default: "down") |
| sizePositionX | number | ❌ | Sets the horizontal button space relative to the screen (default: 30) |
| sizePositionY | number | ❌ | Sets the vertical button space relative to the screen (default: 30) |
| height | number | ❌ | Button height (default: 70) |
| width | number | ❌ | Button width (default: 70) |
| animation | boolean | ❌ | Set false to disable button animation (default: true) |
| borderRadius | number | ❌ | Button border radius (default: 999) |
| afterClose | callbackFn() | ❌ | Callback function that is fired after user close the live |
| onHover | Hover Interface | ❌ | Check out the hover parameter documentation |
| display | "side" | "cinema" | ❌ | Set how fullscreen will display (default: "side") |