mirror of
https://github.com/Unleash/unleash.git
synced 2025-07-02 01:17:58 +02:00
45 lines
1.7 KiB
TypeScript
45 lines
1.7 KiB
TypeScript
/**
|
|
* Generated by Orval
|
|
* Do not edit manually.
|
|
* See `gen:api` script in package.json
|
|
*/
|
|
|
|
/**
|
|
* Describes the properties required to create or update a banner.
|
|
*/
|
|
export interface CreateBannerSchema {
|
|
/**
|
|
* The markdown to display on the dialog. If not specified, no dialog will be displayed.
|
|
* @nullable
|
|
*/
|
|
dialog?: string | null;
|
|
/**
|
|
* The title to display on the dialog. If not specified, this will be the same as `linkText`.
|
|
* @nullable
|
|
*/
|
|
dialogTitle?: string | null;
|
|
/** Whether the banner should be displayed currently. If not specified, defaults to true. */
|
|
enabled?: boolean;
|
|
/**
|
|
* The icon to display on the banner. Can be one of https://fonts.google.com/icons. If not specified, this will be the default icon for the variant. If "none", no icon will be displayed.
|
|
* @nullable
|
|
*/
|
|
icon?: string | null;
|
|
/**
|
|
* The link to display on the banner. Can either be an absolute or a relative link (e.g. absolute: "https://example.com" or relative: "/admin/service-accounts"). If "dialog", will display a dialog when clicked. If not specified, no link will be displayed.
|
|
* @nullable
|
|
*/
|
|
link?: string | null;
|
|
/**
|
|
* The text to display on the link. If not specified, will be displayed as "More info".
|
|
* @nullable
|
|
*/
|
|
linkText?: string | null;
|
|
/** The message to display to all users. Supports markdown. */
|
|
message: string;
|
|
/** Whether the banner should be sticky on the screen. If not specified, defaults to `false`. */
|
|
sticky?: boolean;
|
|
/** The variant of the banner. One of "info", "warning", "error", or "success". If not specified, defaults to "info". */
|
|
variant?: string;
|
|
}
|