Widget Embed

The embed widget offers a seamless way to integrate your portal into your application or website. With a simple click on a trigger in form of a link or button, users can access a dialog box displaying the most recent announcements. Additionally, the trigger conveniently displays a badge indicating the presence of new announcements.

Installation instructions

Configuration

To customize the appearance of your embedded portal, go to Workspace > Settings > Widget.

The widget embed settings allow you to tailor the look and feel of the widget to match your brand or audience. From the right-hand sidebar, you are able to change the title and subtitle, color scheme, locale and more.

Alternatively you can use the widget properties below to specify the configuration via code.

Overwriting the UI settings

You can overwrite the configured styles and settings of the widget by adding custom properties to the embed code. This allows for customizing the styling when embedding the widget in different locations.

When a setting is configured via the properties below, it can no longer be customized via the UI settings.

The properties are specified as attributes within the <released-widget> custom HTML element.

Widget Properties

The following customisation options are available for the widget.

Property	Description
channel-id	The ID of the release notes channel.
modules	Determines with modules to show on the page. Can be changelog , roadmap or all. Defaults to all.
title	The title of the widget.
sub-title	The subtitle of the widget.
position	The position of the widget. Can be top-left, top-right, bottom-right, or bottom-left.
anchor	Can be trigger or viewport. Positions the popup relative to the trigger or the viewport.
trigger	A string specifying a css selector that determines which element on the page will open the dialog when clicked. For example #changelog-button. If not specified, a default trigger button will be rendered.
boost	Whether boosting will auto-popup the widget or not. Can be true or false.
badge	Whether to display a badge with the unread count. Can be true or false.
changelog-category	Limits the embed to display a single category. Use the category slug as the value. For example: The slug for “New Features” would be new-features .
color-scheme	The color scheme to use for the widget. Can be system, dark, or light. See configuring-dark-mode.md for more details.
color-primary	The primary UI color. Can be hex, hsl, rgb, or css color name.
color-secondary	The secondary UI color. Can be hex, hsl, rgb, or css color name.
attributes	Allows for passing data-* attributes to the host container for the widget. For more details see the Attributes section below.
z-index	The z-index to use for the widget.
locale	The locale to use for the page. Can be: en 🇺🇸 American English de 🇩🇪 German fr 🇫🇷 French es 🇪🇸 Spanish pt 🇵🇹 Portuguese nl 🇳🇱 Dutch zh 🇨🇳 Chinese
refresh	If you want to reduce how often the embed checks for updates, you can set refresh=“5m”. This limits update checks to at most once every 5 minutes. Supported values: Xs, Xm, Xh, Xd

Data Attributes

Setting data attributes can be helpful to prevent unwanted interactions with 3rd party libraries. For example, to prevent scrolling issues when the Lenis library is used, you can add the data-lenis-prevent attribute to the host container.

Example:

<released-widget channel-id="CHANNEL_ID" data-lenis-prevent=""></released-widget>

Default values

The following default values are applied in case a property is not explicitly defined.

<released-widget channel-id="CHANNEL_ID"
  anchor="viewport"
  position="bottom-right"
  title="What's New"
  sub-title="The latest updates and improvements."
  trigger="#trigger"
  badge="true"
  color-scheme="system"
  color-primary="#7c3aed"
  color-secondary="#e879f9"
  z-index="10000"
></released-widget>