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

chore: complete first pass of apply jsdoc annotations to component props

Browse source
This commit is contained in:
Eric Liu 2020-07-26 17:42:12 -07:00
commit f30755b237
97 changed files with 2327 additions and 259 deletions
Download patch file Download diff file Expand all files Collapse all files

33
src/OverflowMenu/OverflowMenu.svelte
View file

@ -5,6 +5,10 @@
*/
export let direction = "bottom";
/**
* Set to `true` to open the menu
* @type {boolean} [open=false]
*/
export let open = false;
/**
@ -12,11 +16,35 @@
* @type {boolean} [light=false]
*/
export let light = false;
/**
* Set to `true` to flip the menu relative to the button
* @type {boolean} [flipped=false]
*/
export let flipped = false;
export let tabindex = "0";
/**
* Specify the menu options class
* @type {string} [menuOptionsClass]
*/
export let menuOptionsClass = undefined;
/**
* Specify the icon from `carbon-icons-svelte` to render
* @type {typeof import("carbon-icons-svelte/lib/Add16").default} [icon]
*/
export let icon = OverflowMenuVertical16;
/**
* Specify the icon class
* @type {string} [iconClass]
*/
export let iconClass = undefined;
/**
* Specify the ARIA label for the icon
* @type {string} [iconDescription="Open and close list of options"]
*/
export let iconDescription = "Open and close list of options";
/**
@ -24,7 +52,6 @@
* @type {string} [id]
*/
export let id = "ccs-" + Math.random().toString(36);
export let menuOptionsClass = undefined;
import { createEventDispatcher, setContext, afterUpdate } from "svelte";
import { writable } from "svelte/store";
@ -133,11 +160,11 @@
<button
bind:this={buttonRef}
tabindex="0"
aria-haspopup
aria-expanded={open}
aria-label={ariaLabel}
{id}
{tabindex}
class:bx--overflow-menu={true}
class:bx--overflow-menu--open={open}
class:bx--overflow-menu--light={light}