Skip to main content

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

Unique domain of your Onset Page. It also supports custom domain.

  • 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: 400
  • Type: Number

direction

Direction of which the widget window appears from.

  • Default: right
  • Type: String
  • Values: left, right, center

customTrigger

Disable default widget to use your custom action button.

  • Default: false
  • Type: Boolean

showOnLoad

Automatically show the widget on load.

  • Default: false
  • Type: Boolean

triggerText

Widget action button text.

  • Default: null
  • Type: String

triggerTextColor

Text color of action button.

  • Default: #FFFFFF
  • Type: String

triggerBgColor

Background color of action button. If no color provided, defaults to "Accent Color" from your Onset Appearance Settings.

  • Default: #3e45eb
  • Type: String

triggerDirection

Direction of the widget trigger. If no color provided, fallback to use the direction property value.

  • Default: direction - value
  • Type: String
  • Values: left, right

theme

Widget theme. If not provided, defaults to "light" theme. Available options: auto, light and dark. The auto value sets the theme based on the user's system preference.

  • Default: light
  • Type: String