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

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

View file

@ -1,5 +1,14 @@
<script>
/**
* Specify the ARIA label for the button
* @type {string} [ariaLabel]
*/
export let ariaLabel = undefined;
/**
* Set to `true` to toggle the open state
* @type {boolean} [isOpen=false]
*/
export let isOpen = false;
import { fly } from "svelte/transition";

View file

@ -1,6 +1,15 @@
<script>
/**
* Specify the ARIA label for the nav
* @type {string} [ariaLabel]
*/
export let ariaLabel = undefined;
export let isOpen = undefined;
/**
* Set to `true` to toggle the expanded state
* @type {boolean} [isOpen=false]
*/
export let isOpen = false;
</script>
<nav

View file

@ -1,7 +1,26 @@
<script>
/**
* Set to `true` to select the current link
* @type {boolean} [isSelected=false]
*/
export let isSelected = false;
/**
* Specify the `href` attribute
* @type {string} [href]
*/
export let href = undefined;
/**
* Specify the text
* @type {string} [text]
*/
export let text = undefined;
/**
* Specify the icon props
* @type {{ render: typeof import("carbon-icons-svelte/lib/Add16").default; skeleton: boolean; }} [icon]
*/
export let icon = undefined;
import { Icon } from "../../Icon";
@ -9,7 +28,7 @@
<li class:bx--side-nav__item={true}>
<a
aria-current={isSelected ? 'page' : ''}
aria-current={isSelected ? 'page' : undefined}
{href}
class:bx--side-nav__link={true}
class:bx--side-nav__link--current={isSelected}

View file

@ -1,6 +1,20 @@
<script>
/**
* Set to `true` to toggle the expanded state
* @type {boolean} [expanded]
*/
export let expanded = false;
/**
* Specify the text
* @type {string} [text]
*/
export let text = undefined;
/**
* Specify the icon props
* @type {{ render: typeof import("carbon-icons-svelte/lib/Add16").default; skeleton: boolean; }} [icon]
*/
export let icon = undefined;
import ChevronDown16 from "carbon-icons-svelte/lib/ChevronDown16";

View file

@ -7,7 +7,7 @@
<li role="none" class:bx--side-nav__menu-item={true}>
<a
role="menuitem"
aria-current={isSelected ? 'page' : ''}
aria-current={isSelected ? 'page' : undefined}
{href}
class:bx--side-nav__link={true}
{...$$restProps}