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,20 +1,14 @@
<script>
/**
* Specify the selected structured list row value
* @type {string} [selected]
* @type {string}
*/
export let selected = undefined;
/**
* Set to `true` to use the bordered variant
* @type {boolean} [border=false]
*/
/** Set to `true` to use the bordered variant */
export let border = false;
/**
* Set to `true` to use the selection variant
* @type {boolean} [selection=false]
*/
/** Set to `true` to use the selection variant */
export let selection = false;
import { createEventDispatcher, setContext } from "svelte";

View file

@ -1,14 +1,8 @@
<script>
/**
* Set to `true` to use as a header
* @type {boolean} [head=false]
*/
/** Set to `true` to use as a header */
export let head = false;
/**
* Set to `true` to prevent wrapping
* @type {boolean} [noWrap=false]
*/
/** Set to `true` to prevent wrapping */
export let noWrap = false;
</script>

View file

@ -1,37 +1,25 @@
<script>
/**
* Set to `true` to check the input
* @type {boolean} [checked=false]
*/
/** Set to `true` to check the input */
export let checked = false;
/**
* Specify the title of the input
* @type {string} [title="title"]
*/
/** Specify the title of the input */
export let title = "title";
/**
* Specify the value of the input
* @type {string} [value="value"]
*/
/** Specify the value of the input */
export let value = "value";
/**
* Set an id for the input element
* @type {string} [id]
* @type {string}
*/
export let id = "ccs-" + Math.random().toString(36);
/**
* Specify a name attribute for the input
* @type {string} [name=""]
*/
/** Specify a name attribute for the input */
export let name = "";
/**
* Obtain a reference to the input HTML element
* @type {null | HTMLInputElement} [ref=null]
* @type {null | HTMLInputElement}
*/
export let ref = null;

View file

@ -1,20 +1,11 @@
<script>
/**
* Set to `true` to use as a header
* @type {boolean} [head=false]
*/
/** Set to `true` to use as a header */
export let head = false;
/**
* Set to `true` to render a label slot
* @type {boolean} [label=false]
*/
/** Set to `true` to render a label slot */
export let label = false;
/**
* Specify the tabindex
* @type {string} [tabindex="0"]
*/
/** Specify the tabindex */
export let tabindex = "0";
</script>

View file

@ -1,14 +1,8 @@
<script>
/**
* Specify the number of rows
* @type {number} [rows=5]
*/
/** Specify the number of rows */
export let rows = 5;
/**
* Set to `true` to use the bordered variant
* @type {boolean} [border=false]
*/
/** Set to `true` to use the bordered variant */
export let border = false;
</script>

View file

@ -1,5 +1,5 @@
export { default as StructuredList } from "./StructuredList.svelte";
export { default as StructuredListSkeleton } from "./StructuredList.Skeleton.svelte";
export { default as StructuredListSkeleton } from "./StructuredListSkeleton.svelte";
export { default as StructuredListBody } from "./StructuredListBody.svelte";
export { default as StructuredListHead } from "./StructuredListHead.svelte";
export { default as StructuredListCell } from "./StructuredListCell.svelte";