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,7 +1,26 @@
<script>
export let size = undefined; // "sm" | "xl"
export let type = "";
/**
* Set the size of the input
* @type {"sm" | "xl"} [size]
*/
export let size = undefined;
/**
* Specify the input value
* @type {string} [value=""]
*/
export let value = "";
/**
* Specify the input type
* @type {string} [type=""]
*/
export let type = "";
/**
* Specify the placeholder text
* @type {string} [placeholder=""]
*/
export let placeholder = "";
/**
@ -10,15 +29,30 @@
*/
export let light = false;
/**
* Set to `true` to disable the input
* @type {boolean} [disabled=false]
*/
export let disabled = false;
/**
* Specify the helper text
* @type {string} [helperText=""]
*/
export let helperText = "";
/**
* Set an id for the input element
* @type {string} [id]
*/
export let id = "ccs-" + Math.random().toString(36);
/**
* Specify a name attribute for the input
* @type {string} [name]
*/
export let name = undefined;
export let helperText = "";
/**
* Specify the label text
* @type {string} [labelText=""]
@ -43,6 +77,10 @@
*/
export let invalidText = "";
/**
* Obtain a reference to the input HTML element
* @type {null | HTMLInputElement} [ref=null]
*/
export let ref = null;
import WarningFilled16 from "carbon-icons-svelte/lib/WarningFilled16";