mirror of
https://github.com/carbon-design-system/carbon-components-svelte.git
synced 2025-09-15 10:21:05 +00:00
chore: complete first pass of apply jsdoc annotations to component props
This commit is contained in:
parent
566a281d81
commit
f30755b237
97 changed files with 2327 additions and 259 deletions
|
@ -1,6 +1,15 @@
|
|||
<script>
|
||||
export let border = false;
|
||||
/**
|
||||
* Specify the number of rows
|
||||
* @type {number} [rows=5]
|
||||
*/
|
||||
export let rows = 5;
|
||||
|
||||
/**
|
||||
* Set to `true` to use the bordered variant
|
||||
* @type {boolean} [border=false]
|
||||
*/
|
||||
export let border = false;
|
||||
</script>
|
||||
|
||||
<section
|
||||
|
|
|
@ -1,6 +1,20 @@
|
|||
<script>
|
||||
/**
|
||||
* Specify the selected structured list row value
|
||||
* @type {string} [selected]
|
||||
*/
|
||||
export let selected = undefined;
|
||||
|
||||
/**
|
||||
* Set to `true` to use the bordered variant
|
||||
* @type {boolean} [border=false]
|
||||
*/
|
||||
export let border = false;
|
||||
|
||||
/**
|
||||
* Set to `true` to use the selection variant
|
||||
* @type {boolean} [selection=false]
|
||||
*/
|
||||
export let selection = false;
|
||||
|
||||
import { createEventDispatcher, setContext } from "svelte";
|
||||
|
|
|
@ -1,5 +1,14 @@
|
|||
<script>
|
||||
/**
|
||||
* Set to `true` to use as a header
|
||||
* @type {boolean} [head=false]
|
||||
*/
|
||||
export let head = false;
|
||||
|
||||
/**
|
||||
* Set to `true` to prevent wrapping
|
||||
* @type {boolean} [noWrap=false]
|
||||
*/
|
||||
export let noWrap = false;
|
||||
</script>
|
||||
|
||||
|
|
|
@ -1,6 +1,20 @@
|
|||
<script>
|
||||
/**
|
||||
* Set to `true` to check the input
|
||||
* @type {boolean} [checked=false]
|
||||
*/
|
||||
export let checked = false;
|
||||
|
||||
/**
|
||||
* Specify the title of the input
|
||||
* @type {string} [title="title"]
|
||||
*/
|
||||
export let title = "title";
|
||||
|
||||
/**
|
||||
* Specify the value of the input
|
||||
* @type {string} [value="value"]
|
||||
*/
|
||||
export let value = "value";
|
||||
|
||||
/**
|
||||
|
@ -8,7 +22,17 @@
|
|||
* @type {string} [id]
|
||||
*/
|
||||
export let id = "ccs-" + Math.random().toString(36);
|
||||
|
||||
/**
|
||||
* Specify a name attribute for the input
|
||||
* @type {string} [name=""]
|
||||
*/
|
||||
export let name = "";
|
||||
|
||||
/**
|
||||
* Obtain a reference to the input HTML element
|
||||
* @type {null | HTMLInputElement} [ref=null]
|
||||
*/
|
||||
export let ref = null;
|
||||
|
||||
import { getContext } from "svelte";
|
||||
|
|
|
@ -1,6 +1,20 @@
|
|||
<script>
|
||||
/**
|
||||
* Set to `true` to use as a header
|
||||
* @type {boolean} [head=false]
|
||||
*/
|
||||
export let head = false;
|
||||
|
||||
/**
|
||||
* Set to `true` to render a label slot
|
||||
* @type {boolean} [label=false]
|
||||
*/
|
||||
export let label = false;
|
||||
|
||||
/**
|
||||
* Specify the tabindex
|
||||
* @type {string} [tabindex="0"]
|
||||
*/
|
||||
export let tabindex = "0";
|
||||
</script>
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue