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

HeaderGlobalAction ref type specified explicitly in JSDoc, docs rebuilt

Browse source
This commit is contained in:
militant_gnome 2024-01-17 11:43:37 +02:00 • committed by Eric Liu
commit f27c533516
4 changed files with 8 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

2
COMPONENT_INDEX.md
View file

@ -1667,7 +1667,7 @@ None.
| Prop name | Required | Kind | Reactive | Type | Default value | Description | | Prop name | Required | Kind | Reactive | Type | Default value | Description |
| :-------- | :------- | :--------------- | :------- | --------------------------------------------------------- | ---------------------- | --------------------------------------------- | | :-------- | :------- | :--------------- | :------- | --------------------------------------------------------- | ---------------------- | --------------------------------------------- |
| ref | No | <code>let</code> | Yes | -- | <code>null</code> | Obtain a reference to the HTML button element | | ref | No | <code>let</code> | Yes | <code>HTMLButtonElement</code> | <code>null</code> | Obtain a reference to the HTML button element |
| isActive | No | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to use the active variant | | isActive | No | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to use the active variant |
| icon | No | <code>let</code> | No | <code>typeof import("svelte").SvelteComponent<any></code> | <code>undefined</code> | Specify the icon to render | | icon | No | <code>let</code> | No | <code>typeof import("svelte").SvelteComponent<any></code> | <code>undefined</code> | Specify the icon to render |

1
docs/src/COMPONENT_API.json
View file

@ -5104,6 +5104,7 @@
"name": "ref", "name": "ref",
"kind": "let", "kind": "let",
"description": "Obtain a reference to the HTML button element", "description": "Obtain a reference to the HTML button element",
"type": "HTMLButtonElement",
"value": "null", "value": "null",
"isFunction": false, "isFunction": false,
"isFunctionDeclaration": false, "isFunctionDeclaration": false,

4
src/UIShell/HeaderGlobalAction.svelte
View file

@ -12,7 +12,9 @@
*/ */
export let icon = undefined; export let icon = undefined;
/** Obtain a reference to the HTML button element */ /** Obtain a reference to the HTML button element
* @type {HTMLButtonElement}
*/
export let ref = null; export let ref = null;
import Button from "../Button/Button.svelte"; import Button from "../Button/Button.svelte";

8
types/UIShell/HeaderGlobalAction.svelte.d.ts vendored
View file

@ -1,9 +1,7 @@
import type { SvelteComponentTyped } from "svelte"; import type { SvelteComponentTyped } from "svelte";
import type { SvelteHTMLElements } from "svelte/elements"; import type { ButtonProps } from "../Button/Button.svelte";
type RestProps = SvelteHTMLElements["button"]; export interface HeaderGlobalActionProps extends ButtonProps {
export interface HeaderGlobalActionProps extends RestProps {
/** /**
* Set to `true` to use the active variant * Set to `true` to use the active variant
* @default false * @default false
@ -20,7 +18,7 @@ export interface HeaderGlobalActionProps extends RestProps {
* Obtain a reference to the HTML button element * Obtain a reference to the HTML button element
* @default null * @default null
*/ */
ref?: undefined; ref?: HTMLButtonElement;
} }
export default class HeaderGlobalAction extends SvelteComponentTyped< export default class HeaderGlobalAction extends SvelteComponentTyped<