@scania/tegel
Version:
Tegel Design System
42 lines (41 loc) • 1.56 kB
TypeScript
import { EventEmitter } from '../../stencil-public-runtime';
import { IconNames } from '../../types/Icons';
/**
* @slot header - Slot for the Header of the Banner
* @slot subheader - Slot for the Subheader of the Banner
* @slot actions - Slot for the bottom part of the Banner, used for links.
*/
export declare class TdsBanner {
host: HTMLElement;
/** Name of the icon for the component. For error and information variant, the icon is predefined. */
icon?: IconNames;
/** Header text. */
header?: string;
/** Subheader text. */
subheader?: string;
/** Variant of Banner */
variant: 'error' | 'information' | 'default';
/** ID used for internal table functionality and events, must be unique.
*
* **NOTE**: If you're listening for Banner close events, you need to set this ID yourself to identify the Banner,
* as the default ID is random and will be different every time.
*/
bannerId: string;
/** Hides the Banner */
hidden: boolean;
/** Defines the ARIA role of the banner. Defaults to "banner" for global use,
* but can be set to "region" or "alert" if used differently.
*/
roleType: 'banner' | 'region' | 'alert';
/** Sends a unique Banner identifier when the close button is pressed. */
tdsClose: EventEmitter<{
bannerId: string;
}>;
/** Hides the Banner. */
hideBanner(): Promise<void>;
/** Shows the Banner */
showBanner(): Promise<void>;
connectedCallback(): void;
handleClose: () => void;
render(): any;
}