Widget
Embed announcements into your app or site
Last updated
Embed announcements into your app or site
Last updated
The embed widget offers a seamless way to integrate release notes 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.
Experience a demo of the widget on CodePen.
The embed widget settings provide a number of options to customize the appearance of the widget.
Via the right-hand sidebar settings, you are able to change the title and subtitle, color scheme and locale of the widget.
🇺🇸 American English 🇩🇪 German 🇫🇷 French 🇪🇸 Spanish 🇵🇹 Portuguese 🇳🇱 Dutch
To add the announcement page to your website, simply follow the installation instructions in the app.
Navigate to the Released Settings in your Jira project
Click the Widget menu item in the Design section.
Click the Install button at the bottom of the sidebar.
Follow the installation instruction in the slide out panel.
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.
The following customisation options are available for the widget.
channel-id
The ID of the release notes channel.
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
title
The title of the widget.
sub-title
The subtitle of the widget.
badge
Whether to display a badge with the unread count. Can be true or false.
color-scheme
The color scheme to use for the widget. Can be system, dark, or light.
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
z-index
The z-index to use for the widget.
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:
The following default values are applied in case a property is not explicitly defined.
You can find a demo and experiment with different options on .
A string specifying a 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.
Allows for passing data-* attributes to the host container for the widget. For more details see the below.
