File: Banner.d.ts

package info (click to toggle)
cockpit 355-1
  • links: PTS, VCS
  • area: main
  • in suites: forky
  • size: 311,568 kB
  • sloc: javascript: 774,787; python: 40,655; ansic: 35,157; cpp: 11,141; sh: 3,512; makefile: 580; xml: 261
file content (30 lines) | stat: -rw-r--r-- 1,315 bytes parent folder | download | duplicates (20)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
/// <reference types="react" />
export type BannerColor = 'red' | 'orangered' | 'orange' | 'yellow' | 'green' | 'teal' | 'blue' | 'purple';
export type BannerStatus = 'success' | 'warning' | 'danger' | 'info' | 'custom';
export interface BannerProps extends React.HTMLProps<HTMLDivElement> {
    /** Content rendered inside the banner. */
    children?: React.ReactNode;
    /** Additional classes added to the banner. */
    className?: string;
    /** If set to true, the banner sticks to the top of its container */
    isSticky?: boolean;
    /** Text announced by screen readers to indicate the type of banner. This prop should only
     * be passed in when the banner conveys status/severity.
     */
    screenReaderText?: string;
    /** Color options for the banner, will be overwritten by any applied using the status prop. */
    color?: BannerColor;
    /** Status style options for the banner, will overwrite any color applied using the color prop. */
    status?: BannerStatus;
}
interface StatusBanner extends BannerProps {
    color?: never;
    status?: BannerStatus;
}
interface NonStatusBanner extends BannerProps {
    color?: BannerColor;
    status?: never;
}
export declare const Banner: React.FunctionComponent<StatusBanner | NonStatusBanner>;
export {};
//# sourceMappingURL=Banner.d.ts.map