kibana/x-pack/plugins/banners
Tim Sullivan e4a32f8f3c
[SharedUX] Remove usage of deprecated React rendering utilities (#180516)
## Summary

Partially addresses https://github.com/elastic/kibana-team/issues/805

Follows https://github.com/elastic/kibana/pull/180003

These changes come up from searching in the code and finding where
certain kinds of deprecated AppEx-SharedUX modules are imported.
**Reviewers: Please interact with critical paths through the UI
components touched in this PR, ESPECIALLY in terms of testing dark mode
and i18n.**

This focuses on code within AppEx-SharedUX. [Reporting changes are
separate](https://github.com/elastic/kibana/pull/).

<img width="1107" alt="image"
src="c0d2ce08-ac35-45a7-8192-0b2256fceb0e">

### Checklist

Delete any items that are not applicable to this PR.

- [x] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [ ] This renders correctly on smaller devices using a responsive
layout. (You can test this [in your
browser](https://www.browserstack.com/guide/responsive-testing-on-local-server))
- [ ] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)
2024-04-17 07:52:41 -07:00
..
common [eslint] enable type-specific lint rules (#114184) 2021-11-03 16:56:17 -06:00
public [SharedUX] Remove usage of deprecated React rendering utilities (#180516) 2024-04-17 07:52:41 -07:00
server async-import plugins in the server side (#170856) 2023-11-15 00:55:56 -07:00
jest.config.js
kibana.jsonc [SharedUX] Remove usage of deprecated React rendering utilities (#180516) 2024-04-17 07:52:41 -07:00
README.md
tsconfig.json [SharedUX] Remove usage of deprecated React rendering utilities (#180516) 2024-04-17 07:52:41 -07: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'