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
131
types/Modal/Modal.d.ts
vendored
Normal file
131
types/Modal/Modal.d.ts
vendored
Normal file
|
@ -0,0 +1,131 @@
|
|||
/// <reference types="svelte" />
|
||||
|
||||
export default class Modal {
|
||||
$$prop_def: svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> & {
|
||||
/**
|
||||
* Set the size of the modal
|
||||
*/
|
||||
size?: "xs" | "sm" | "lg";
|
||||
|
||||
/**
|
||||
* Set to `true` to open the modal
|
||||
* @default false
|
||||
*/
|
||||
open?: boolean;
|
||||
|
||||
/**
|
||||
* Set to `true` to use the danger variant
|
||||
* @default false
|
||||
*/
|
||||
danger?: boolean;
|
||||
|
||||
/**
|
||||
* Set to `true` to enable alert mode
|
||||
* @default false
|
||||
*/
|
||||
alert?: boolean;
|
||||
|
||||
/**
|
||||
* Set to `true` to use the passive variant
|
||||
* @default false
|
||||
*/
|
||||
passiveModal?: boolean;
|
||||
|
||||
/**
|
||||
* Specify the modal heading
|
||||
*/
|
||||
modalHeading?: string;
|
||||
|
||||
/**
|
||||
* Specify the modal label
|
||||
*/
|
||||
modalLabel?: string;
|
||||
|
||||
/**
|
||||
* Specify the ARIA label for the modal
|
||||
*/
|
||||
modalAriaLabel?: string;
|
||||
|
||||
/**
|
||||
* Specify the ARIA label for the close icon
|
||||
* @default "Close the modal"
|
||||
*/
|
||||
iconDescription?: string;
|
||||
|
||||
/**
|
||||
* Set to `true` if the modal contains form elements
|
||||
* @default false
|
||||
*/
|
||||
hasForm?: boolean;
|
||||
|
||||
/**
|
||||
* Set to `true` if the modal contains scrolling content
|
||||
* @default false
|
||||
*/
|
||||
hasScrollingContent?: boolean;
|
||||
|
||||
/**
|
||||
* Specify the primary button text
|
||||
* @default ""
|
||||
*/
|
||||
primaryButtonText?: string;
|
||||
|
||||
/**
|
||||
* Set to `true` to disable the primary button
|
||||
* @default false
|
||||
*/
|
||||
primaryButtonDisabled?: boolean;
|
||||
|
||||
/**
|
||||
* Set to `true` for the primary button to be triggered when pressing "Enter"
|
||||
* @default true
|
||||
*/
|
||||
shouldSubmitOnEnter?: boolean;
|
||||
|
||||
/**
|
||||
* Specify the secondary button text
|
||||
* @default ""
|
||||
*/
|
||||
secondaryButtonText?: string;
|
||||
|
||||
/**
|
||||
* Specify a selector to be focused when opening the modal
|
||||
* @default "[data-modal-primary-focus]"
|
||||
*/
|
||||
selectorPrimaryFocus?: string;
|
||||
|
||||
/**
|
||||
* Set to `true` to prevent the modal from closing when clicking outside
|
||||
* @default false
|
||||
*/
|
||||
preventCloseOnClickOutside?: boolean;
|
||||
|
||||
/**
|
||||
* Set an id for the top-level element
|
||||
*/
|
||||
id?: string;
|
||||
|
||||
/**
|
||||
* Obtain a reference to the top-level HTML element
|
||||
* @default null
|
||||
*/
|
||||
ref?: null | HTMLElement;
|
||||
};
|
||||
|
||||
$$slot_def: {
|
||||
default: {};
|
||||
label: {};
|
||||
heading: {};
|
||||
};
|
||||
|
||||
$on(eventname: "keydown", cb: (event: WindowEventMap["keydown"]) => void): () => void;
|
||||
$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: "submit", cb: (event: CustomEvent<any>) => void): () => void;
|
||||
$on(eventname: "click:button--secondary", cb: (event: CustomEvent<any>) => void): () => void;
|
||||
$on(eventname: "close", cb: (event: CustomEvent<any>) => void): () => void;
|
||||
$on(eventname: "open", 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