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

refactor: update/fix JSDoc props

Browse source
This commit is contained in:
Eric Liu 2020-11-04 06:04:25 -08:00
commit d38e6d8be6
204 changed files with 992 additions and 2359 deletions
Download patch file Download diff file Expand all files Collapse all files

11
src/UIShell/GlobalHeader/HeaderAction.svelte
View file

@ -1,26 +1,23 @@
<script>
/**
* Set to `true` to open the panel
* @type {boolean} [isOpen=false]
*/
/** Set to `true` to open the panel */
export let isOpen = false;
/**
* Specify the icon props
* @type {{ render: typeof import("carbon-icons-svelte/lib/Add16").default; skeleton: boolean; }} [icon]
* @type {{ render: typeof import("carbon-icons-svelte/lib/Add16").default; skeleton: boolean; }}
*/
export let icon = undefined;
/**
* Specify the text
* Alternatively, use the named slot "text" (e.g. <div slot="text">...</div>)
* @type {string} [text]
* @type {string}
*/
export let text = undefined;
/**
* Obtain a reference to the button HTML element
* @type {null | HTMLButtonElement} [ref=null]
* @type {null | HTMLButtonElement}
*/
export let ref = null;