Links

Configuration

Once you have installed Onset on your site, you should see the widget trigger on the right of your screen. You may now want to tailor how the widget appears on your site.
onsetWidgetSettings = {
page: 'releases.onset.io',
triggerText: "🔔 What's New",
};

page

The unique domain of your Onset Page. It also supports custom domains.
  • Required
  • Type: String
Examples:
  • example.onset.io - Onset Page Domain
  • releases.example.com - Custom domain page

project

Default selected project.
  • Default: all
  • Type: String

title

Widget header text.
  • Default: Release Notes
  • Type: String

allowSubscribers

Enable / Disable subscribe button.
  • Default: true
  • Type: Boolean

hideBadge

Enable / Disable trigger badge count.
  • Default: false
  • Type: Boolean

width

Widget window width.
  • Default: 400px
  • Type: string

height

Widget window height.
  • Default: 95%
  • Type: string

direction

The direction from which the widget window appears.
  • Default: right
  • Type: String
  • Values: left, right, center

customTrigger

Disable the default widget to use your custom action button.
  • Default: false
  • Type: Boolean

showOnLoad

Automatically show the widget on load.
  • Default: false
  • Type: Boolean

showRoadmap

Toggle to the roadmap tab.
  • Default: false
  • Type: Boolean

triggerText

Widget action button text.
  • Default: null
  • Type: String

triggerTextColor

Text color of the action button.
  • Default: #FFFFFF
  • Type: String

triggerBgColor

The background color of the action button. If no color is provided, we default to "Accent Color" from your Onset Appearance Settings.
  • Default: #3e45eb
  • Type: String

triggerDirection

The direction of the widget trigger.
  • Default: right
  • Type: String
  • Values: left, right

theme

Widget theme. The auto value sets the theme based on the user's system preference.
  • Default: light
  • Type: String
  • Values: system, light, dark
Last modified 20d ago