kibana/x-pack/plugins/banners
Spencer 7d3d79e6a1
[8.0] [eslint] enable type-specific lint rules (#114184) (#117444)
* [eslint] enable type-specific lint rules (#114184)

* [eslint] enable type-specific lint rules

* autofix violations

* duplicate eslint-disable to new export statement

Co-authored-by: spalger <spalger@users.noreply.github.com>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
# Conflicts:
#	src/plugins/share/common/index.ts

* autofix more types

Co-authored-by: spalger <spalger@users.noreply.github.com>
2021-11-04 03:02:56 +00:00
..
common [8.0] [eslint] enable type-specific lint rules (#114184) (#117444) 2021-11-04 03:02:56 +00:00
public [Reporting] Remove banner from reports (#116147) (#116965) 2021-11-01 18:14:58 +00:00
server Removes unused and renamed deprecated core settings and deprecated settings from core plugins (#113653) 2021-10-05 12:30:49 -07:00
jest.config.js [jest] update config files to get coverage per plugin (#111299) 2021-09-09 08:14:56 +02:00
kibana.json [Reporting] Remove banner from reports (#116147) (#116965) 2021-11-01 18:14:58 +00:00
README.md add per space configuration to custom header banner (#94449) 2021-03-31 10:57:06 +02:00
tsconfig.json [Reporting] Remove banner from reports (#116147) (#116965) 2021-11-01 18:14:58 +00:00

Kibana banners plugin

Allow to add a header banner that will be displayed on every page of the Kibana application

Configuration

The plugin's configuration prefix is xpack.banners

The options are

  • placement

The placement of the banner. The allowed values are:

  • disabled - The banner will be disabled

  • top - The banner will be displayed in the header

  • textContent

The text content that will be displayed inside the banner, either plain text or markdown

  • textColor

The color of the banner's text. Must be a valid hex color

  • backgroundColor

The color for the banner's background. Must be a valid hex color

Configuration example

kibana.yml

xpack.banners:
  placement: 'top'
  textContent: 'Production environment - Proceed with **special levels** of caution'
  textColor: '#FF0000'
  backgroundColor: '#CC2211'