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,26 +1,14 @@
<script>
/**
* Specify the current step index
* @type {number} [currentIndex=0]
*/
/** Specify the current step index */
export let currentIndex = 0;
/**
* Set to `true` to use the vertical variant
* @type {boolean} [vertical=false]
*/
/** Set to `true` to use the vertical variant */
export let vertical = false;
/**
* Set to `true` to specify whether the progress steps should be split equally in size in the div
* @type {boolean} [spaceEqually=false]
*/
/** Set to `true` to specify whether the progress steps should be split equally in size in the div */
export let spaceEqually = false;
/**
* Set to `true` to prevent updating `currentIndex`
* @type {boolean} [preventChangeOnClick=false]
*/
/** Set to `true` to prevent updating `currentIndex` */
export let preventChangeOnClick = false;
import { createEventDispatcher, setContext } from "svelte";

View file

@ -1,14 +1,8 @@
<script>
/**
* Set to `true` to use the vertical variant
* @type {boolean} [vertical=false]
*/
/** Set to `true` to use the vertical variant */
export let vertical = false;
/**
* Specify the number of steps to render
* @type {number} [count=4]
*/
/** Specify the number of steps to render */
export let count = 4;
</script>

View file

@ -1,49 +1,28 @@
<script>
/**
* Set to `true` for the complete variant
* @type {boolean} [complete=false]
*/
/** Set to `true` for the complete variant */
export let complete = false;
/**
* Set to `true` to use the current variant
* @type {boolean} [current=false]
*/
/** Set to `true` to use the current variant */
export let current = false;
/**
* Set to `true` to disable the progress step
* @type {boolean} [disabled=false]
*/
/** Set to `true` to disable the progress step */
export let disabled = false;
/**
* Set to `true` to indicate an invalid state
* @type {boolean} [invalid=false]
*/
/** Set to `true` to indicate an invalid state */
export let invalid = false;
/**
* Specify the step description
* @type {string} [descripton=""]
*/
/** Specify the step description */
export let description = "";
/**
* Specify the step label
* @type {string} [label=""]
*/
/** Specify the step label */
export let label = "";
/**
* Specify the step secondary label
* @type {string} [secondaryLabel=""]
*/
/** Specify the step secondary label */
export let secondaryLabel = "";
/**
* Set an id for the top-level element
* @type {string} [id]
* @type {string}
*/
export let id = "ccs-" + Math.random().toString(36);

View file

@ -1,3 +1,3 @@
export { default as ProgressIndicator } from "./ProgressIndicator.svelte";
export { default as ProgressIndicatorSkeleton } from "./ProgressIndicator.Skeleton.svelte";
export { default as ProgressIndicatorSkeleton } from "./ProgressIndicatorSkeleton.svelte";
export { default as ProgressStep } from "./ProgressStep.svelte";