mirror of
https://github.com/carbon-design-system/carbon-components-svelte.git
synced 2025-09-14 18:01:06 +00:00
6bf72d4602Fixes https://github.com/carbon-design-system/carbon-icons-svelte/issues/207 `carbon-icons-svelte@13` and `carbon-pictograms-svelte@13` now only support TypeScript for Svelte 4/5. The new `Component` type is incompatible with the `icon` prop in `carbon-components-svelte`, causing a type error with Svelte 5, as `typeof SvelteComponent` doesn't match the new `Component` type. Since `Component` isn't available in Svelte 3/4, this PR changes the `icon` prop type to `any` for compatibility across Svelte 3, 4, and 5.
156 lines
3.2 KiB
TypeScript
156 lines
3.2 KiB
TypeScript
import type { SvelteComponentTyped } from "svelte";
|
|
import type { SvelteHTMLElements } from "svelte/elements";
|
|
|
|
type $RestProps = SvelteHTMLElements["div"];
|
|
|
|
type $Props = {
|
|
/**
|
|
* Set the size of the modal
|
|
* @default undefined
|
|
*/
|
|
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
|
|
* @default undefined
|
|
*/
|
|
modalHeading?: string;
|
|
|
|
/**
|
|
* Specify the modal label
|
|
* @default undefined
|
|
*/
|
|
modalLabel?: string;
|
|
|
|
/**
|
|
* Specify the ARIA label for the modal
|
|
* @default undefined
|
|
*/
|
|
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;
|
|
|
|
/**
|
|
* Specify the primary button icon
|
|
* @default undefined
|
|
*/
|
|
primaryButtonIcon?: any;
|
|
|
|
/**
|
|
* Set to `true` for the "submit" and "click:button--primary" events
|
|
* to be dispatched when pressing "Enter"
|
|
* @default true
|
|
*/
|
|
shouldSubmitOnEnter?: boolean;
|
|
|
|
/**
|
|
* Specify the secondary button text
|
|
* @default ""
|
|
*/
|
|
secondaryButtonText?: string;
|
|
|
|
/**
|
|
* 2-tuple prop to render two secondary buttons for a 3 button modal
|
|
* supersedes `secondaryButtonText`
|
|
* @default []
|
|
*/
|
|
secondaryButtons?: [{ text: string }, { text: 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
|
|
* @default "ccs-" + Math.random().toString(36)
|
|
*/
|
|
id?: string;
|
|
|
|
/**
|
|
* Obtain a reference to the top-level HTML element
|
|
* @default null
|
|
*/
|
|
ref?: null | HTMLDivElement;
|
|
|
|
[key: `data-${string}`]: any;
|
|
};
|
|
|
|
export type ModalProps = Omit<$RestProps, keyof $Props> & $Props;
|
|
|
|
export default class Modal extends SvelteComponentTyped<
|
|
ModalProps,
|
|
{
|
|
transitionend: CustomEvent<{ open: boolean }>;
|
|
["click:button--secondary"]: CustomEvent<{ text: string }>;
|
|
keydown: WindowEventMap["keydown"];
|
|
click: WindowEventMap["click"];
|
|
mouseover: WindowEventMap["mouseover"];
|
|
mouseenter: WindowEventMap["mouseenter"];
|
|
mouseleave: WindowEventMap["mouseleave"];
|
|
submit: CustomEvent<null>;
|
|
["click:button--primary"]: CustomEvent<null>;
|
|
close: CustomEvent<null>;
|
|
open: CustomEvent<null>;
|
|
},
|
|
{ default: {}; heading: {}; label: {} }
|
|
> {}
|