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.
65 lines
1.4 KiB
TypeScript
65 lines
1.4 KiB
TypeScript
import type { SvelteComponentTyped } from "svelte";
|
|
import type { SvelteHTMLElements } from "svelte/elements";
|
|
|
|
type $RestProps = SvelteHTMLElements["button"];
|
|
|
|
type $Props = {
|
|
/**
|
|
* Specify the tooltip text.
|
|
* Alternatively, use the "tooltipText" slot
|
|
* @default ""
|
|
*/
|
|
tooltipText?: string;
|
|
|
|
/**
|
|
* Specify the icon to render
|
|
* @default undefined
|
|
*/
|
|
icon?: any;
|
|
|
|
/**
|
|
* Set to `true` to disable the tooltip icon
|
|
* @default false
|
|
*/
|
|
disabled?: boolean;
|
|
|
|
/**
|
|
* Set the alignment of the tooltip relative to the icon
|
|
* @default "center"
|
|
*/
|
|
align?: "start" | "center" | "end";
|
|
|
|
/**
|
|
* Set the direction of the tooltip relative to the icon
|
|
* @default "bottom"
|
|
*/
|
|
direction?: "top" | "right" | "bottom" | "left";
|
|
|
|
/**
|
|
* Set an id for the span element
|
|
* @default "ccs-" + Math.random().toString(36)
|
|
*/
|
|
id?: string;
|
|
|
|
/**
|
|
* Obtain a reference to the button HTML element
|
|
* @default null
|
|
*/
|
|
ref?: null | HTMLButtonElement;
|
|
|
|
[key: `data-${string}`]: any;
|
|
};
|
|
|
|
export type TooltipIconProps = Omit<$RestProps, keyof $Props> & $Props;
|
|
|
|
export default class TooltipIcon extends SvelteComponentTyped<
|
|
TooltipIconProps,
|
|
{
|
|
click: WindowEventMap["click"];
|
|
mouseover: WindowEventMap["mouseover"];
|
|
mouseenter: WindowEventMap["mouseenter"];
|
|
mouseleave: WindowEventMap["mouseleave"];
|
|
focus: WindowEventMap["focus"];
|
|
},
|
|
{ default: {}; tooltipText: {} }
|
|
> {}
|