mirror of
https://github.com/carbon-design-system/carbon-components-svelte.git
synced 2025-09-14 18:01:06 +00:00
refactor(types): rewrite type definitions to account for intrinsic attributes
This commit is contained in:
parent
8c30452169
commit
3c04f122b0
158 changed files with 6997 additions and 5383 deletions
71
types/Notification/InlineNotification.d.ts
vendored
Normal file
71
types/Notification/InlineNotification.d.ts
vendored
Normal file
|
@ -0,0 +1,71 @@
|
|||
/// <reference types="svelte" />
|
||||
|
||||
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;
|
||||
};
|
||||
|
||||
$$slot_def: {
|
||||
default: {};
|
||||
actions: {};
|
||||
};
|
||||
|
||||
$on(eventname: "click", cb: (event: WindowEventMap["click"]) => void): () => void;
|
||||
$on(eventname: "mouseover", cb: (event: WindowEventMap["mouseover"]) => void): () => void;
|
||||
$on(eventname: "mouseenter", cb: (event: WindowEventMap["mouseenter"]) => void): () => void;
|
||||
$on(eventname: "mouseleave", cb: (event: WindowEventMap["mouseleave"]) => void): () => void;
|
||||
$on(eventname: "close", cb: (event: CustomEvent<any>) => void): () => void;
|
||||
$on(eventname: string, cb: (event: Event) => void): () => void;
|
||||
}
|
15
types/Notification/NotificationActionButton.d.ts
vendored
Normal file
15
types/Notification/NotificationActionButton.d.ts
vendored
Normal file
|
@ -0,0 +1,15 @@
|
|||
/// <reference types="svelte" />
|
||||
|
||||
export default class NotificationActionButton {
|
||||
$$prop_def: {};
|
||||
|
||||
$$slot_def: {
|
||||
default: {};
|
||||
};
|
||||
|
||||
$on(eventname: "click", cb: (event: WindowEventMap["click"]) => void): () => void;
|
||||
$on(eventname: "mouseover", cb: (event: WindowEventMap["mouseover"]) => void): () => void;
|
||||
$on(eventname: "mouseenter", cb: (event: WindowEventMap["mouseenter"]) => void): () => void;
|
||||
$on(eventname: "mouseleave", cb: (event: WindowEventMap["mouseleave"]) => void): () => void;
|
||||
$on(eventname: string, cb: (event: Event) => void): () => void;
|
||||
}
|
35
types/Notification/NotificationButton.d.ts
vendored
Normal file
35
types/Notification/NotificationButton.d.ts
vendored
Normal file
|
@ -0,0 +1,35 @@
|
|||
/// <reference types="svelte" />
|
||||
|
||||
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;
|
||||
};
|
||||
|
||||
$$slot_def: {};
|
||||
|
||||
$on(eventname: "click", cb: (event: WindowEventMap["click"]) => void): () => void;
|
||||
$on(eventname: "mouseover", cb: (event: WindowEventMap["mouseover"]) => void): () => void;
|
||||
$on(eventname: "mouseenter", cb: (event: WindowEventMap["mouseenter"]) => void): () => void;
|
||||
$on(eventname: "mouseleave", cb: (event: WindowEventMap["mouseleave"]) => void): () => void;
|
||||
$on(eventname: string, cb: (event: Event) => void): () => void;
|
||||
}
|
27
types/Notification/NotificationIcon.d.ts
vendored
Normal file
27
types/Notification/NotificationIcon.d.ts
vendored
Normal file
|
@ -0,0 +1,27 @@
|
|||
/// <reference types="svelte" />
|
||||
|
||||
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;
|
||||
};
|
||||
|
||||
$$slot_def: {};
|
||||
|
||||
$on(eventname: string, cb: (event: Event) => void): () => void;
|
||||
}
|
35
types/Notification/NotificationTextDetails.d.ts
vendored
Normal file
35
types/Notification/NotificationTextDetails.d.ts
vendored
Normal file
|
@ -0,0 +1,35 @@
|
|||
/// <reference types="svelte" />
|
||||
|
||||
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;
|
||||
};
|
||||
|
||||
$$slot_def: {
|
||||
default: {};
|
||||
};
|
||||
|
||||
$on(eventname: string, cb: (event: Event) => void): () => void;
|
||||
}
|
76
types/Notification/ToastNotification.d.ts
vendored
Normal file
76
types/Notification/ToastNotification.d.ts
vendored
Normal file
|
@ -0,0 +1,76 @@
|
|||
/// <reference types="svelte" />
|
||||
|
||||
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;
|
||||
};
|
||||
|
||||
$$slot_def: {
|
||||
default: {};
|
||||
};
|
||||
|
||||
$on(eventname: "click", cb: (event: WindowEventMap["click"]) => void): () => void;
|
||||
$on(eventname: "mouseover", cb: (event: WindowEventMap["mouseover"]) => void): () => void;
|
||||
$on(eventname: "mouseenter", cb: (event: WindowEventMap["mouseenter"]) => void): () => void;
|
||||
$on(eventname: "mouseleave", cb: (event: WindowEventMap["mouseleave"]) => void): () => void;
|
||||
$on(eventname: "close", cb: (event: CustomEvent<any>) => void): () => void;
|
||||
$on(eventname: string, cb: (event: Event) => void): () => void;
|
||||
}
|
Loading…
Add table
Add a link
Reference in a new issue