Embed Widget
Embed announcements into your app or site
Overview
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.
Basics
Demo
Experience a demo of the widget on CodePen.
Configuration
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.
Supported locales
🇺🇸 American English 🇩🇪 German 🇫🇷 French 🇪🇸 Spanish 🇵🇹 Portuguese 🇳🇱 Dutch
Installation
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.
Advanced options
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.
| The ID of the release notes channel. |
| The position of the widget. Can be |
| Can be |
| A |
| The title of the widget. |
| The subtitle of the widget. |
| Whether to display a badge with the unread count. Can be |
| The color scheme to use for the widget. Can be |
| The primary UI color. Can be hex, hsl, rgb, or css color name. |
| The secondary UI color. Can be hex, hsl, rgb, or css color name. |
| Allows for passing |
| The z-index to use for the widget. |
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:
Default values
The following default values are applied in case a property is not explicitly defined.
Last updated