Comment on page
Embed announcements into your app or site
The announcement 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.
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.
- 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.
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-preventattribute to the host container.
<released-widget channel-id="CHANNEL_ID" data-lenis-prevent=""></released-widget>
The following default values are applied in case a property is not explicitly defined.
sub-title="The latest updates and improvements."