kibana/x-pack/plugins/banners
Jean-Louis Leysens d9bbe9c9be
[Reporting] Remove banner from reports (#116147)
* remove banner from reports

* added types file

* updated types references and imports

* added screenshot mode public mock

* added jest tests for when screenshot mode is enabled

* Update x-pack/plugins/banners/public/plugin.test.tsx

Co-authored-by: Michael Dokolin <dokmic@gmail.com>

* Update x-pack/plugins/banners/public/plugin.test.tsx

Co-authored-by: Michael Dokolin <dokmic@gmail.com>

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Michael Dokolin <dokmic@gmail.com>
2021-11-01 15:31:56 +00:00
..
common
public [Reporting] Remove banner from reports (#116147) 2021-11-01 15:31:56 +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) 2021-11-01 15:31:56 +00:00
README.md
tsconfig.json [Reporting] Remove banner from reports (#116147) 2021-11-01 15:31:56 +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'