@@ -504,6 +504,61 @@ For displaying a custom HTML in the plugin, HTML file can be stored in the Cloud
504504
505505|ui-custom-plugin.png |
506506
507+ Announcement Banner
508+ ======================
509+
510+ Admin can configure an **announcement banner ** in `config.json ` to display alerts or messages to all users.
511+ This banner is useful for communicating important notices such as performance issues, scheduled maintenance, or general announcements.
512+ To enable and customize the banner, use the `announcementBanner ` section in the config.json file.
513+
514+ This section supports the following properties:
515+
516+ **Configuration Example **
517+
518+ .. parsed-literal ::
519+
520+ "announcementBanner": {
521+ "enabled": true,
522+ "showIcon": true,
523+ "closable": true,
524+ "persistDismissal": true,
525+ "type": "warning",
526+ "message": "<strong>Performance Notice:</strong> We're experiencing high load. Some operations may be slower than usual.",
527+ "startDate": "2025-06-01T00:00:00Z",
528+ "endDate": "2025-07-16T00:00:00Z"
529+ }
530+
531+ **Banner Display Example **
532+
533+ Based on the configuration above, the following banner is shown in the user interface:
534+
535+ .. image :: /_static/images/ui-announcement-banner.png
536+ :align: center
537+ :alt: UI Announcement banner
538+
539+ --------
540+
541+ **Properties Description **
542+
543+ - **enabled **: Enables or disables the announcement banner (`true ` or `false `).
544+ - **showIcon **: Displays an icon alongside the message. The icon corresponds to the banner `type `.
545+ - **closable **: Allows users to close the banner.
546+ - **persistDismissal **: Remembers the user's dismissal of the banner, so it doesn't reappear.
547+ - **type **: Specifies the type of banner. Supported values are:
548+
549+ - `info `
550+ - `warning `
551+ - `error `
552+ - `success `
553+
554+ - **message **: The HTML-formatted content displayed in the banner.
555+ - **startDate ** / **endDate **: Define the visibility window for the banner using ISO 8601 format (`YYYY-MM-DDTHH:MM:SSZ `).
556+
557+ .. note ::
558+
559+ The `message ` property supports basic HTML, allowing styled content such as `<strong> ` tags for emphasis.
560+
561+
507562Advanced UI Customisation
508563~~~~~~~~~~~~~~~~~~~~~~~~~
509564
0 commit comments