# Banner

> For the complete documentation index, see [llms.txt](https://plugins.jetbrains.com/docs/intellij/llms.txt).

> **TL;DR**
> Implementation: [EditorNotificationProvider](https://github.com/JetBrains/intellij-community/tree/idea/263.7307.200/platform/platform-api/src/com/intellij/ui/EditorNotificationProvider.java)
>
>
>
> Related: [Editor Banner](informing-users.html#editor-banner)

A banner notification informs the user about the state of a specific context in the project. For example, when there is a missing or broken configuration for some file.

![Banner error](images/banner_error.png)

## When to use

Use a banner if user actions should attract attention in a file tab, tool window, or dialog, but are not required immediately.

![Tool window](images/tool-window.png) Reconnecting to the database is required to make edits.

![Dialog example](images/dialog-example.png) The component needs to be installed to run the available virtual devices.

Do not use a banner if there is no particular UI component it can be tied to. Use a [balloon notification](balloon.html) in the main window instead.

For all other cases, choose another notification type.

### Types of banners

#### Information

Use when actions can improve the user’s workflow but are considered optional and can be safely ignored.

![Information example](images/information-example.png) The new tool window UI is suggested to improve the workflow for version control.

#### Warning

Use to suggest actions that can impact the user’s workflow.

![Warning example](images/warning-example.png) Generated files should be edited directly.

#### Error

Use to suggest actions that are required to unblock the user’s workflow.

![Banner error](images/banner_error.png) Syntax highlighting and other inspections are broken until a JDK is defined for the project.

## How to use

![Banner structure](images/banner_structure.png)

### Message

* The message should be [short and descriptive](writing-short.html) (two sentences at most) and follow the [Punctuation](punctuation.html) guide.

* Use sentence case capitalization.

### Actions

* The action name should be [short and descriptive](writing-short.html), preferably not longer than two–three words.

* Use sentence case capitalization.

* Limit the number of actions to two to make the call to action clear in the specific context.

* Use the built-in 'Hide' action instead of creating a separate one.

### Icon (optional)

* 16×16 icons can be used to complement the message, e.g., a gift icon to advertise functionality.

### Placement

* Place the banner at the top of the related UI component.

* It can float or be adjacent to the content, depending on the amount of available space and whether the content’s vertical shifting needs to be minimized.

![Float example](images/float-example.png)

The banner floats on top of the preview surface to reduce shifting during code editing.