mcp/carbon-components-svelte
1
0
Fork 0
mirror of https://github.com/carbon-design-system/carbon-components-svelte.git synced 2025-09-15 02:11: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

36
src/RadioButton/RadioButton.svelte
View file

@ -1,55 +1,37 @@
<script>
/**
* Specify the value of the radio button
* @type {string} [value=""]
*/
/** Specify the value of the radio button */
export let value = "";
/**
* Set to `true` to check the radio button
* @type {boolean} [checked=false]
*/
/** Set to `true` to check the radio button */
export let checked = false;
/**
* Set to `true` to disable the radio button
* @type {boolean} [disabled=false]
*/
/** et to `true` to disable the radio button */
export let disabled = false;
/**
* Specify the label position
* @type {"right" | "left"} [labelPosition="right"]
* @type {"right" | "left"}
*/
export let labelPosition = "right";
/**
* Specify the label text
* @type {string} [labelText=""]
*/
/** Specify the label text */
export let labelText = "";
/**
* Set to `true` to visually hide the label text
* @type {boolean} [hideLabel=false]
*/
/** Set to `true` to visually hide the label text */
export let hideLabel = false;
/**
* 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 checkbox input
* @type {string} [name=""]
*/
/** Specify a name attribute for the checkbox input */
export let name = "";
/**
* Obtain a reference to the input HTML element
* @type {null | HTMLInputElement} [ref=null]
* @type {null | HTMLInputElement}
*/
export let ref = null;