Skip to Content

Widget

⚡ 4 min read

Customize the installation UI using a floating button, or your own custom component. You can trigger the installation prompt by matching a custom element ID with the component ID


Floating Install Button

A pre-built floating button that appears on your website for easy PWA installation

FieldDescriptionExample
Enable Floating ButtonDisplay a floating install button on your website for easy PWA installationCheckbox
PositionChoose where the floating button appears on your websiteBottom Right
Display OnChoose which devices should show the floating buttonDesktop Only, Mobile Only, Both
Button SizeEnter the desired size (px) of the floating button48
Background ColorChoose the background color for the floating buttonHex color (e.g. #000000)
Icon (SVG)Upload an SVG icon for the floating button. File size should be less than 100KBUpload SVG Icon

Position Options

  • Bottom Right
  • Bottom Left
  • Top Right
  • Top Left

Custom Install Button

Use your own HTML element to trigger the PWA installation prompt

FieldDescriptionExample
Enable Custom ButtonEnable a custom install button that you can trigger with your own JavaScript codeCheckbox
Button IDEnter the HTML element ID that will trigger the PWA installation when clickedinstall-button

Usage

  1. Enable Custom Button
  2. Set the Button ID (e.g. install-button)
  3. Add an element with that ID in your HTML:
<button id="install-button">Install App</button>

When the user clicks the element, the PWA installation prompt will appear

The Button ID must match the id attribute of your HTML element. The SDK listens for clicks on that element and triggers the install prompt


Next Steps

Last updated on