carbon-components-svelte/types/TooltipDefinition/TooltipDefinition.svelte.d.ts
Gregor Wassmann 3350a412da feat(v11): TooltipDefinition
In v11 the definintion tooltip uses the `Popover` component internally. While the component is called `DefinitionTooltip` in the reference implementation, it is not renamed at this point.

- rename `tooltipText` to `definition`
- rename `tooltip` slot to `definition`
- remove `direction` (see `align`)
- use `align` values from `Popover` and set to `bottom-left` as default instead of `center`
2023-10-07 14:07:57 +02:00

59 lines
1.2 KiB
TypeScript

import type { SvelteComponentTyped } from "svelte";
export interface TooltipDefinitionProps {
/**
* Specify the term definition.
* @default ""
*/
definition?: string;
/**
* Set to `true` to open the tooltip
* @default false
*/
open?: boolean;
/**
* Set the alignment of the tooltip relative to the icon
* @default "bottom-left"
*/
align?:
| "top"
| "top-left"
| "top-right"
| "bottom"
| "bottom-left"
| "bottom-right"
| "left"
| "left-bottom"
| "left-top"
| "right"
| "right-bottom"
| "right-top";
/**
* 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: {}; definition: {} }
> {}