refactor: update/fix JSDoc props

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

View file

@ -1,19 +1,16 @@
<script>
/**
* Specify the ARIA label for the button
* @type {string} [ariaLabel]
* @type {string}
*/
export let ariaLabel = undefined;
/**
* Set to `true` to toggle the open state
* @type {boolean} [isOpen=false]
*/
/** Set to `true` to toggle the open state */
export let isOpen = false;
/**
* Obtain a reference to the HTML button element
* @type {null | HTMLButtonElement} [ref=null]
* @type {null | HTMLButtonElement}
*/
export let ref = null;

View file

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

View file

@ -1,31 +1,28 @@
<script>
/**
* Set to `true` to select the current link
* @type {boolean} [isSelected=false]
*/
/** Set to `true` to select the current link */
export let isSelected = false;
/**
* Specify the `href` attribute
* @type {string} [href]
* @type {string}
*/
export let href = undefined;
/**
* Specify the text
* @type {string} [text]
* @type {string}
*/
export let text = undefined;
/**
* 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;
/**
* Obtain a reference to the HTML anchor element
* @type {null | HTMLAnchorElement} [ref=null]
* @type {null | HTMLAnchorElement}
*/
export let ref = null;

View file

@ -1,25 +1,22 @@
<script>
/**
* Set to `true` to toggle the expanded state
* @type {boolean} [expanded]
*/
/** Set to `true` to toggle the expanded state */
export let expanded = false;
/**
* Specify the text
* @type {string} [text]
* @type {string}
*/
export let text = undefined;
/**
* 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;
/**
* Obtain a reference to the HTML button element
* @type {null | HTMLButtonElement} [ref=null]
* @type {null | HTMLButtonElement}
*/
export let ref = null;

View file

@ -1,25 +1,25 @@
<script>
/**
* Set to `true` to select the item
* @type {boolean} [isSelected]
* @type {boolean}
*/
export let isSelected = undefined;
/**
* Specify the `href` attribute
* @type {string} [href]
* @type {string}
*/
export let href = undefined;
/**
* Specify the item text
* @type {string} [text]
* @type {string}
*/
export let text = undefined;
/**
* Obtain a reference to the HTML anchor element
* @type {null | HTMLAnchorElement} [ref=null]
* @type {null | HTMLAnchorElement}
*/
export let ref = null;
</script>