mirror of
https://github.com/Unleash/unleash.git
synced 2024-11-01 19:07:38 +01:00
d3bd591b1d
https://linear.app/unleash/issue/2-1486/docs-document-the-new-internal-message-banner-feature Adds documentation for the "Banners" feature. - [Banners reference](https://unleash-docs-git-docs-banners-unleash-team.vercel.app/reference/banners) - ["How to create and display banners" guide](https://unleash-docs-git-docs-banners-unleash-team.vercel.app/how-to/how-to-create-and-display-banners) 
86 lines
5.4 KiB
Markdown
86 lines
5.4 KiB
Markdown
---
|
|
title: Banners
|
|
---
|
|
|
|
:::info Availability
|
|
|
|
Banners were introduced as a beta feature in **Unleash 5.6** and are only available in Unleash Enterprise. We plan to make this feature generally available to all Enterprise users in **Unleash 5.7**.
|
|
|
|
:::
|
|
|
|
Banners allow you to configure and display internal messages that all users of your Unleash instance can see and interact with. They are displayed at the top of the Unleash UI, and can be configured to be interactive.
|
|
|
|
|
|
|
|
A common use case could be to have some pre-configured banners that you can enable when you need to communicate something to your users. For example, you could have a banner that you enable when you're doing maintenance on your Unleash instance, and another banner that you enable when you're running a survey.
|
|
|
|
In order to create and display a banner, you can follow the [how to create and display banners](../how-to/how-to-create-and-display-banners.md) guide.
|
|
|
|
## Banner status
|
|
|
|
Banners can be enabled or disabled at any time. For more information on how to enable or disable a banner, see the section on [displaying banners](../how-to/how-to-create-and-display-banners.md#displaying-banners).
|
|
|
|
| Option | Description |
|
|
| ----------- | -------------------------------------------------------------------------------- |
|
|
| **Enabled** | Whether the banner is currently displayed to all users of your Unleash instance. |
|
|
|
|
## Configuration
|
|
|
|
Banners can be configured with the following options:
|
|
|
|
| Option | Description |
|
|
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| **Type** | The type of banner, which controls the banner's color and its icon, if using the default icon option. |
|
|
| **Icon** | The icon displayed on the banner. This can be the default for the banner type, a [custom icon](#custom-icon), or hidden by selecting "None". |
|
|
| **Message** | The banner's message. Supports [Markdown](https://www.markdownguide.org/basic-syntax/). |
|
|
|
|
### Custom icon
|
|
|
|
To further personalize your banner, you can configure it with a custom icon.
|
|
|
|
To use a custom icon in your banner:
|
|
1. Select "Custom" in the icon dropdown.
|
|
2. Enter the name of the desired [Material Symbol](https://fonts.google.com/icons).
|
|
- For example, for the "Rocket Launch" icon, enter `rocket_launch` in the custom icon field.
|
|
|
|
| Option | Description |
|
|
| --------------- | -------------------------------------------------------------------------------------------------------- |
|
|
| **Custom icon** | The custom icon to be displayed on the banner, using [Material Symbols](https://fonts.google.com/icons). |
|
|
|
|
## Banner action
|
|
|
|
You can set up an action for your banner:
|
|
|
|
| Option | Description |
|
|
| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| **Banner action** | The action activated when a user interacts with the banner link. Defaults to "None". Options include a [link](#link) or a [dialog](#dialog). |
|
|
|
|
### Link
|
|
|
|
When choosing the link action, a link will be displayed on the banner that directs users to a specified URL.
|
|
|
|
The configured URL can be absolute, as in e.g. `https://docs.getunleash.io/`, or relative as in e.g. `/admin/network`. Absolute URLs will open in a new tab.
|
|
|
|
| Option | Description |
|
|
| -------- | --------------------------------------------------------- |
|
|
| **URL** | The URL to open when the user uses the banner link. |
|
|
| **Text** | The text to display on the banner link. |
|
|
|
|
### Dialog
|
|
|
|
When opting for a dialog action, an interactable link appears on the banner which opens a dialog with additional information.
|
|
|
|
| Option | Description |
|
|
| ------------------ | ------------------------------------------------------------------------------------------------------- |
|
|
| **Text** | The text to display on the banner link. |
|
|
| **Dialog title** | The title to display on the dialog. |
|
|
| **Dialog content** | The content to display on the dialog. Supports [Markdown](https://www.markdownguide.org/basic-syntax/). |
|
|
|
|
## Sticky banner
|
|
|
|
For added visibility, banners can be configured to be "sticky," ensuring they remain at the top of the Unleash UI, even after scrolling the page. This is useful for banners that you want to make sure that your users see and interact with.
|
|
|
|
| Option | Description |
|
|
| ---------- | ---------------------------------------------------------- |
|
|
| **Sticky** | Whether the banner is sticky on the screen when scrolling. |
|