carbon-components-svelte/types/TooltipDefinition/TooltipDefinition.svelte.d.ts
metonym 714f47a635
fix(types): dispatched events without a detail value should be null (#1124)
Currently, dispatched events without `e.detail` have a type of `any`.

We can be more specific as a `CustomEvent` detail value is `null`.
2022-02-21 09:42:42 -08:00

55 lines
1.2 KiB
TypeScript

/// <reference types="svelte" />
import { SvelteComponentTyped } from "svelte";
export interface TooltipDefinitionProps
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["span"]> {
/**
* Specify the tooltip text
* @default ""
*/
tooltipText?: string;
/**
* Set to `true` to open the tooltip
* @default false
*/
open?: 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" | "bottom";
/**
* Set an id for the tooltip div element
* @default "ccs-" + Math.random().toString(36)
*/
id?: string;
/**
* Obtain a reference to the button HTML element
* @default null
*/
ref?: null | HTMLButtonElement;
}
export default class TooltipDefinition extends SvelteComponentTyped<
TooltipDefinitionProps,
{
open: CustomEvent<null>;
close: CustomEvent<null>;
click: WindowEventMap["click"];
mouseover: WindowEventMap["mouseover"];
mouseenter: WindowEventMap["mouseenter"];
mouseleave: WindowEventMap["mouseleave"];
focus: WindowEventMap["focus"];
},
{ default: {}; tooltip: {} }
> {}