mirror of
https://github.com/carbon-design-system/carbon-components-svelte.git
synced 2025-09-15 18:31:06 +00:00
8fea168ffd* feat(toast-notification): add `fullWidth` prop * Run "yarn build:docs" * test(toast-notification): assert `fullWidth` prop * docs(toast-notification): add "Full width" example
84 lines
1.7 KiB
TypeScript
84 lines
1.7 KiB
TypeScript
/// <reference types="svelte" />
|
|
import type { SvelteComponentTyped } from "svelte";
|
|
|
|
export interface ToastNotificationProps
|
|
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> {
|
|
/**
|
|
* Specify the kind of notification
|
|
* @default "error"
|
|
*/
|
|
kind?:
|
|
| "error"
|
|
| "info"
|
|
| "info-square"
|
|
| "success"
|
|
| "warning"
|
|
| "warning-alt";
|
|
|
|
/**
|
|
* Set to `true` to use the low contrast variant
|
|
* @default false
|
|
*/
|
|
lowContrast?: boolean;
|
|
|
|
/**
|
|
* Set the timeout duration (ms) to hide the notification after opening it
|
|
* @default 0
|
|
*/
|
|
timeout?: number;
|
|
|
|
/**
|
|
* Set the `role` attribute
|
|
* @default "alert"
|
|
*/
|
|
role?: string;
|
|
|
|
/**
|
|
* Specify the title text
|
|
* @default ""
|
|
*/
|
|
title?: string;
|
|
|
|
/**
|
|
* Specify the subtitle text
|
|
* @default ""
|
|
*/
|
|
subtitle?: string;
|
|
|
|
/**
|
|
* Specify the caption text
|
|
* @default ""
|
|
*/
|
|
caption?: string;
|
|
|
|
/**
|
|
* Specify the ARIA label for the icon
|
|
* @default "Closes notification"
|
|
*/
|
|
iconDescription?: string;
|
|
|
|
/**
|
|
* Set to `true` to hide the close button
|
|
* @default false
|
|
*/
|
|
hideCloseButton?: boolean;
|
|
|
|
/**
|
|
* Set to `true` for the notification to span
|
|
* the full width of its containing element.
|
|
* @default false
|
|
*/
|
|
fullWidth?: boolean;
|
|
}
|
|
|
|
export default class ToastNotification extends SvelteComponentTyped<
|
|
ToastNotificationProps,
|
|
{
|
|
close: CustomEvent<{ timeout: boolean }>;
|
|
click: WindowEventMap["click"];
|
|
mouseover: WindowEventMap["mouseover"];
|
|
mouseenter: WindowEventMap["mouseenter"];
|
|
mouseleave: WindowEventMap["mouseleave"];
|
|
},
|
|
{ default: {}; caption: {}; subtitle: {}; title: {} }
|
|
> {}
|