mirror of
https://github.com/carbon-design-system/carbon-components-svelte.git
synced 2025-09-14 18:01:06 +00:00
refactor(types): shorten ref, id JSDocs, use CarbonIcon type, export component props
This commit is contained in:
Eric Liu
parent
d38e6d8be6
commit
75d4b4cf03
219 changed files with 5168 additions and 5259 deletions
113
types/Notification/InlineNotification.d.ts
vendored
113
types/Notification/InlineNotification.d.ts
vendored
|
|
@ -1,62 +1,63 @@
|
|||
/// <reference types="svelte" />
|
||||
|
||||
export interface InlineNotificationProps extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> {
|
||||
/**
|
||||
* Set the type of notification
|
||||
* @default "inline"
|
||||
*/
|
||||
notificationType?: "toast" | "inline";
|
||||
|
||||
/**
|
||||
* 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"
|
||||
*/
|
||||
title?: string;
|
||||
|
||||
/**
|
||||
* Specify the subtitle text
|
||||
* @default ""
|
||||
*/
|
||||
subtitle?: string;
|
||||
|
||||
/**
|
||||
* Set to `true` to hide the close button
|
||||
* @default false
|
||||
*/
|
||||
hideCloseButton?: boolean;
|
||||
|
||||
/**
|
||||
* Specify the ARIA label for the icon
|
||||
* @default "Closes notification"
|
||||
*/
|
||||
iconDescription?: string;
|
||||
}
|
||||
|
||||
export default class InlineNotification {
|
||||
$$prop_def: svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> & {
|
||||
/**
|
||||
* Set the type of notification
|
||||
* @default "inline"
|
||||
*/
|
||||
notificationType?: "toast" | "inline";
|
||||
|
||||
/**
|
||||
* 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"
|
||||
*/
|
||||
title?: string;
|
||||
|
||||
/**
|
||||
* Specify the subtitle text
|
||||
* @default ""
|
||||
*/
|
||||
subtitle?: string;
|
||||
|
||||
/**
|
||||
* Set to `true` to hide the close button
|
||||
* @default false
|
||||
*/
|
||||
hideCloseButton?: boolean;
|
||||
|
||||
/**
|
||||
* Specify the ARIA label for the icon
|
||||
* @default "Closes notification"
|
||||
*/
|
||||
iconDescription?: string;
|
||||
};
|
||||
|
||||
$$prop_def: InlineNotificationProps;
|
||||
$$slot_def: {
|
||||
default: {};
|
||||
actions: {};
|
||||
|
|
|
|||
|
|
@ -1,8 +1,9 @@
|
|||
/// <reference types="svelte" />
|
||||
|
||||
export default class NotificationActionButton {
|
||||
$$prop_def: {};
|
||||
export interface NotificationActionButtonProps {}
|
||||
|
||||
export default class NotificationActionButton {
|
||||
$$prop_def: NotificationActionButtonProps;
|
||||
$$slot_def: {
|
||||
default: {};
|
||||
};
|
||||
|
|
|
|||
49
types/Notification/NotificationButton.d.ts
vendored
49
types/Notification/NotificationButton.d.ts
vendored
|
|
@ -1,30 +1,31 @@
|
|||
/// <reference types="svelte" />
|
||||
|
||||
export interface NotificationButtonProps extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["button"]> {
|
||||
/**
|
||||
* Set the type of notification
|
||||
* @default "toast"
|
||||
*/
|
||||
notificationType?: "toast" | "inline";
|
||||
|
||||
/**
|
||||
* Specify the icon from `carbon-icons-svelte` to render
|
||||
*/
|
||||
renderIcon?: import("carbon-icons-svelte").CarbonIcon;
|
||||
|
||||
/**
|
||||
* Specify the title of the icon
|
||||
*/
|
||||
title?: string;
|
||||
|
||||
/**
|
||||
* Specify the ARIA label for the icon
|
||||
* @default "Close icon"
|
||||
*/
|
||||
iconDescription?: string;
|
||||
}
|
||||
|
||||
export default class NotificationButton {
|
||||
$$prop_def: svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["button"]> & {
|
||||
/**
|
||||
* Set the type of notification
|
||||
* @default "toast"
|
||||
*/
|
||||
notificationType?: "toast" | "inline";
|
||||
|
||||
/**
|
||||
* Specify the icon from `carbon-icons-svelte` to render
|
||||
*/
|
||||
renderIcon?: typeof import("carbon-icons-svelte/lib/Add16").default;
|
||||
|
||||
/**
|
||||
* Specify the title of the icon
|
||||
*/
|
||||
title?: string;
|
||||
|
||||
/**
|
||||
* Specify the ARIA label for the icon
|
||||
* @default "Close icon"
|
||||
*/
|
||||
iconDescription?: string;
|
||||
};
|
||||
|
||||
$$prop_def: NotificationButtonProps;
|
||||
$$slot_def: {};
|
||||
|
||||
$on(eventname: "click", cb: (event: WindowEventMap["click"]) => void): () => void;
|
||||
|
|
|
|||
41
types/Notification/NotificationIcon.d.ts
vendored
41
types/Notification/NotificationIcon.d.ts
vendored
|
|
@ -1,26 +1,27 @@
|
|||
/// <reference types="svelte" />
|
||||
|
||||
export interface NotificationIconProps {
|
||||
/**
|
||||
* Specify the kind of notification icon
|
||||
* @default "error"
|
||||
*/
|
||||
kind?: "error" | "info" | "info-square" | "success" | "warning" | "warning-alt";
|
||||
|
||||
/**
|
||||
* Set the type of notification
|
||||
* @default "toast"
|
||||
*/
|
||||
notificationType?: "toast" | "inline";
|
||||
|
||||
/**
|
||||
* Specify the ARIA label for the icon
|
||||
* @default "Closes notification"
|
||||
*/
|
||||
iconDescription?: string;
|
||||
}
|
||||
|
||||
export default class NotificationIcon {
|
||||
$$prop_def: {
|
||||
/**
|
||||
* Specify the kind of notification icon
|
||||
* @default "error"
|
||||
*/
|
||||
kind?: "error" | "info" | "info-square" | "success" | "warning" | "warning-alt";
|
||||
|
||||
/**
|
||||
* Set the type of notification
|
||||
* @default "toast"
|
||||
*/
|
||||
notificationType?: "toast" | "inline";
|
||||
|
||||
/**
|
||||
* Specify the ARIA label for the icon
|
||||
* @default "Closes notification"
|
||||
*/
|
||||
iconDescription?: string;
|
||||
};
|
||||
|
||||
$$prop_def: NotificationIconProps;
|
||||
$$slot_def: {};
|
||||
|
||||
$on(eventname: string, cb: (event: Event) => void): () => void;
|
||||
|
|
|
|||
53
types/Notification/NotificationTextDetails.d.ts
vendored
53
types/Notification/NotificationTextDetails.d.ts
vendored
|
|
@ -1,32 +1,33 @@
|
|||
/// <reference types="svelte" />
|
||||
|
||||
export interface NotificationTextDetailsProps {
|
||||
/**
|
||||
* Set the type of notification
|
||||
* @default "toast"
|
||||
*/
|
||||
notificationType?: "toast" | "inline";
|
||||
|
||||
/**
|
||||
* Specify the title text
|
||||
* @default "Title"
|
||||
*/
|
||||
title?: string;
|
||||
|
||||
/**
|
||||
* Specify the subtitle text
|
||||
* @default ""
|
||||
*/
|
||||
subtitle?: string;
|
||||
|
||||
/**
|
||||
* Specify the caption text
|
||||
* @default "Caption"
|
||||
*/
|
||||
caption?: string;
|
||||
}
|
||||
|
||||
export default class NotificationTextDetails {
|
||||
$$prop_def: {
|
||||
/**
|
||||
* Set the type of notification
|
||||
* @default "toast"
|
||||
*/
|
||||
notificationType?: "toast" | "inline";
|
||||
|
||||
/**
|
||||
* Specify the title text
|
||||
* @default "Title"
|
||||
*/
|
||||
title?: string;
|
||||
|
||||
/**
|
||||
* Specify the subtitle text
|
||||
* @default ""
|
||||
*/
|
||||
subtitle?: string;
|
||||
|
||||
/**
|
||||
* Specify the caption text
|
||||
* @default "Caption"
|
||||
*/
|
||||
caption?: string;
|
||||
};
|
||||
|
||||
$$prop_def: NotificationTextDetailsProps;
|
||||
$$slot_def: {
|
||||
default: {};
|
||||
};
|
||||
|
|
|
|||
125
types/Notification/ToastNotification.d.ts
vendored
125
types/Notification/ToastNotification.d.ts
vendored
|
|
@ -1,68 +1,69 @@
|
|||
/// <reference types="svelte" />
|
||||
|
||||
export interface ToastNotificationProps extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> {
|
||||
/**
|
||||
* Set the type of notification
|
||||
* @default "toast"
|
||||
*/
|
||||
notificationType?: "toast" | "inline";
|
||||
|
||||
/**
|
||||
* 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"
|
||||
*/
|
||||
title?: string;
|
||||
|
||||
/**
|
||||
* Specify the subtitle text
|
||||
* @default ""
|
||||
*/
|
||||
subtitle?: string;
|
||||
|
||||
/**
|
||||
* Specify the caption text
|
||||
* @default "Caption"
|
||||
*/
|
||||
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;
|
||||
}
|
||||
|
||||
export default class ToastNotification {
|
||||
$$prop_def: svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> & {
|
||||
/**
|
||||
* Set the type of notification
|
||||
* @default "toast"
|
||||
*/
|
||||
notificationType?: "toast" | "inline";
|
||||
|
||||
/**
|
||||
* 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"
|
||||
*/
|
||||
title?: string;
|
||||
|
||||
/**
|
||||
* Specify the subtitle text
|
||||
* @default ""
|
||||
*/
|
||||
subtitle?: string;
|
||||
|
||||
/**
|
||||
* Specify the caption text
|
||||
* @default "Caption"
|
||||
*/
|
||||
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;
|
||||
};
|
||||
|
||||
$$prop_def: ToastNotificationProps;
|
||||
$$slot_def: {
|
||||
default: {};
|
||||
};
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue