mirror of
https://github.com/carbon-design-system/carbon-components-svelte.git
synced 2025-09-15 02:11:05 +00:00
refactor(types): shorten ref, id JSDocs, use CarbonIcon type, export component props
This commit is contained in:
parent
d38e6d8be6
commit
75d4b4cf03
219 changed files with 5168 additions and 5259 deletions
64
types/TooltipIcon/TooltipIcon.d.ts
vendored
64
types/TooltipIcon/TooltipIcon.d.ts
vendored
|
@ -1,37 +1,39 @@
|
|||
/// <reference types="svelte" />
|
||||
|
||||
export interface TooltipIconProps extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["button"]> {
|
||||
/**
|
||||
* Specify the tooltip text
|
||||
* @default ""
|
||||
*/
|
||||
tooltipText?: string;
|
||||
|
||||
/**
|
||||
* 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;
|
||||
}
|
||||
|
||||
export default class TooltipIcon {
|
||||
$$prop_def: svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["button"]> & {
|
||||
/**
|
||||
* Specify the tooltip text
|
||||
* @default ""
|
||||
*/
|
||||
tooltipText?: string;
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
id?: string;
|
||||
|
||||
/**
|
||||
* Obtain a reference to the button HTML element
|
||||
* @default null
|
||||
*/
|
||||
ref?: null | HTMLButtonElement;
|
||||
};
|
||||
|
||||
$$prop_def: TooltipIconProps;
|
||||
$$slot_def: {
|
||||
default: {};
|
||||
};
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue