mcp/carbon-components-svelte
1
0
Fork 0
mirror of https://github.com/carbon-design-system/carbon-components-svelte.git synced 2025-09-16 02:41:05 +00:00
Code Issues Projects Releases Packages Wiki Activity

refactor: update/fix JSDoc props

Browse source
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
Download patch file Download diff file Expand all files Collapse all files

12
src/Tile/ClickableTile.svelte
View file

@ -1,19 +1,13 @@
<script>
/**
* Set to `true` to click the tile
* @type {boolean} [clicked=false]
*/
/** Set to `true` to click the tile */
export let clicked = false;
/**
* Set to `true` to enable the light variant
* @type {boolean} [light=false]
*/
/** Set to `true` to enable the light variant */
export let light = false;
/**
* Set the `href`
* @type {string} [href]
* @type {string}
*/
export let href = undefined;
</script>

41
src/Tile/ExpandableTile.svelte
View file

@ -1,55 +1,34 @@
<script>
/**
* Set to `true` to expand the tile
* @type {boolean} [expanded=false]
*/
/** Set to `true` to expand the tile */
export let expanded = false;
/**
* Set to `true` to enable the light variant
* @type {boolean} [light=false]
*/
/** Set to `true` to enable the light variant */
export let light = false;
/**
* Specify the max height of the tile (number of pixels)
* @type {number} [tileMaxHeight=0]
*/
/** Specify the max height of the tile (number of pixels) */
export let tileMaxHeight = 0;
/**
* Specify the padding of the tile (number of pixels)
* @type {number} [tilePadding=0]
*/
/** Specify the padding of the tile (number of pixels) */
export let tilePadding = 0;
/**
* Specify the icon text of the collapsed tile
* @type {string} [tileCollapsedIconText="Interact to expand Tile"]
*/
/** Specify the icon text of the collapsed tile */
export let tileCollapsedIconText = "Interact to expand Tile";
/**
* Specify the icon text of the expanded tile
* @type {string} [tileExpandedIconText="Interact to collapse Tile"]
*/
/** Specify the icon text of the expanded tile */
export let tileExpandedIconText = "Interact to collapse Tile";
/**
* Specify the tabindex
* @type {string} [tabindex="0"]
*/
/** Specify the tabindex */
export let tabindex = "0";
/**
* Set an id for the top-level div element
* @type {string} [id]
* @type {string}
*/
export let id = "ccs-" + Math.random().toString(36);
/**
* Obtain a reference to the input HTML element
* @type {null | HTMLElement} [ref=null]
* Obtain a reference to the top-level element
* @type {null | HTMLDivElement}
*/
export let ref = null;

32
src/Tile/RadioTile.svelte
View file

@ -1,44 +1,26 @@
<script>
/**
* Set to `true` to check the tile
* @type {boolean} [checked=false]
*/
/** Set to `true` to check the tile */
export let checked = false;
/**
* Set to `true` to enable the light variant
* @type {boolean} [light=false]
*/
/** Set to `true` to enable the light variant */
export let light = false;
/**
* Specify the value of the radio input
* @type {string} [value=""]
*/
/** Specify the value of the radio input */
export let value = "";
/**
* Specify the tabindex
* @type {string} [tabindex="0"]
*/
/** Specify the tabindex */
export let tabindex = "0";
/**
* Specify the ARIA label for the radio tile checkmark icon
* @type {string} [iconDescription="Tile checkmark"]
*/
/** Specify the ARIA label for the radio tile checkmark icon */
export let iconDescription = "Tile checkmark";
/**
* 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 = "";
import { getContext } from "svelte";

36
src/Tile/SelectableTile.svelte
View file

@ -1,55 +1,37 @@
<script>
/**
* Set to `true` to select the tile
* @type {boolean} [selected=false]
*/
/** Set to `true` to select the tile */
export let selected = false;
/**
* Set to `true` to enable the light variant
* @type {boolean} [light=false]
*/
/** Set to `true` to enable the light variant */
export let light = false;
/**
* Specify the title of the selectable tile
* @type {string} [title="title"]
*/
/** Specify the title of the selectable tile */
export let title = "title";
/**
* Specify the value of the selectable tile
* @type {string} [value="value"]
*/
/** Specify the value of the selectable tile */
export let value = "value";
/**
* Specify the tabindex
* @type {string} [tabindex="0"]
*/
/** Specify the tabindex */
export let tabindex = "0";
/**
* Specify the ARIA label for the selectable tile checkmark icon
* @type {string} [iconDescription="Tile checkmark"]
*/
/** Specify the ARIA label for the selectable tile checkmark icon */
export let iconDescription = "Tile checkmark";
/**
* 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=""]
* @type {string}
*/
export let name = "";
/**
* Obtain a reference to the input HTML element
* @type {null | HTMLInputElement} [ref=null]
* @type {null | HTMLInputElement}
*/
export let ref = null;

5
src/Tile/Tile.svelte
View file

@ -1,8 +1,5 @@
<script>
/**
* Set to `true` to enable the light variant
* @type {boolean} [light=false]
*/
/** Set to `true` to enable the light variant */
export let light = false;
</script>

12
src/Tile/TileGroup.svelte
View file

@ -1,20 +1,14 @@
<script>
/**
* Specify the selected tile value
* @type {string} [selected]
* @type {string}
*/
export let selected = undefined;
/**
* Set to `true` to disable the tile group
* @type {boolean} [disabled=false]
*/
/** Set to `true` to disable the tile group */
export let disabled = false;
/**
* Specify the legend text
* @type {string} [legend]
*/
/** Specify the legend text */
export let legend = "";
import { createEventDispatcher, setContext } from "svelte";