mcp/carbon-components-svelte
1
0
Fork 0
mirror of https://github.com/carbon-design-system/carbon-components-svelte.git synced 2025-09-22 05:03:44 +00:00
Code Issues Projects Releases Packages Wiki Activity

Run "yarn build:docs"

Browse source
This commit is contained in:
Eric Liu 2022-02-01 07:10:58 -08:00
commit 653a46a232
4 changed files with 36 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

5
COMPONENT_INDEX.md
View file

@ -4691,6 +4691,7 @@ None.
| Prop name | Kind | Reactive | Type | Default value | Description |
| :---------- | :--------------- | :------- | :------------------------------------------------ | ------------------------------------------------ | ----------------------------------------------------- |
| ref | <code>let</code> | Yes | <code>null &#124; HTMLButtonElement</code> | <code>null</code> | Obtain a reference to the button HTML element |
| open | <code>let</code> | Yes | <code>boolean</code> | <code>false</code> | Set to `true` to open the tooltip |
| tooltipText | <code>let</code> | No | <code>string</code> | <code>""</code> | Specify the tooltip text |
| align | <code>let</code> | No | <code>"start" &#124; "center" &#124; "end"</code> | <code>"center"</code> | Set the alignment of the tooltip relative to the icon |
| direction | <code>let</code> | No | <code>"top" &#124; "bottom"</code> | <code>"bottom"</code> | Set the direction of the tooltip relative to the icon |
@ -4706,7 +4707,9 @@ None.
### Events
| Event name | Type | Detail |
| :--------- | :-------- | :----- |
| :--------- | :--------- | :--------------- |
| open | dispatched | <code>any</code> |
| close | dispatched | <code>any</code> |
| click | forwarded | -- |
| mouseover | forwarded | -- |
| mouseenter | forwarded | -- |

13
docs/src/COMPONENT_API.json
View file

@ -13111,6 +13111,17 @@
"constant": false,
"reactive": false
},
{
"name": "open",
"kind": "let",
"description": "Set to `true` to open the tooltip",
"type": "boolean",
"value": "false",
"isFunction": false,
"isFunctionDeclaration": false,
"constant": false,
"reactive": true
},
{
"name": "align",
"kind": "let",
@ -13166,6 +13177,8 @@
}
],
"events": [
{ "type": "dispatched", "name": "open", "detail": "any" },
{ "type": "dispatched", "name": "close", "detail": "any" },
{ "type": "forwarded", "name": "click", "element": "button" },
{ "type": "forwarded", "name": "mouseover", "element": "button" },
{ "type": "forwarded", "name": "mouseenter", "element": "button" },

5
src/TooltipDefinition/TooltipDefinition.svelte
View file

@ -1,4 +1,9 @@
<script>
/**
* @event {any} open
* @event {any} close
*/
/** Specify the tooltip text */
export let tooltipText = "";

8
types/TooltipDefinition/TooltipDefinition.svelte.d.ts vendored
View file

@ -9,6 +9,12 @@ export interface TooltipDefinitionProps
*/
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"
@ -37,6 +43,8 @@ export interface TooltipDefinitionProps
export default class TooltipDefinition extends SvelteComponentTyped<
TooltipDefinitionProps,
{
open: CustomEvent<any>;
close: CustomEvent<any>;
click: WindowEventMap["click"];
mouseover: WindowEventMap["mouseover"];
mouseenter: WindowEventMap["mouseenter"];