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

chore: complete first pass of apply jsdoc annotations to component props

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

55
src/DatePicker/DatePicker.svelte
View file

@ -1,28 +1,63 @@
<script>
/**
* Specify the date picker type
* @type {"simple" | "single" | "range"} [datePickerType="simple"]
*/
export let datePickerType = "simple";
/**
* Specify the date picker input value
* @type {string} [value=""]
*/
export let value = "";
/**
* Specify the element to append the calendar to
* @type {HTMLElement} [appendTo=document.body]
*/
export let appendTo = document.body;
export let dateFormat = "m/d/Y";
export let datePickerType = "simple";
/**
* Set an id for the date picker element
* @type {string} [id]
* Specify the date format
* @type {string} [dateFormat="m/d/Y"]
*/
export let id = "ccs-" + Math.random().toString(36);
export let dateFormat = "m/d/Y";
/**
* Specify the maximum date
* @type {null | string | Date} [maxDate=null]
*/
export let maxDate = null;
/**
* Specify the minimum date
* @type {null | string | Date} [minDate=null]
*/
export let minDate = null;
/**
* Specify the locale
* @type {string} [locale="en"]
*/
export let locale = "en";
/**
* Set to `true` to use the short variant
* @type {boolean} [short=false]
*/
export let short = false;
/**
* Set to `true` to enable the light variant
* @type {boolean} [light=false]
*/
export let light = false;
export let locale = "en";
export let maxDate = null;
export let minDate = null;
export let short = false;
export let value = "";
/**
* Set an id for the date picker element
* @type {string} [id]
*/
export let id = "ccs-" + Math.random().toString(36);
import {
createEventDispatcher,

9
src/DatePicker/DatePickerInput.svelte
View file

@ -4,6 +4,11 @@
* @type {"sm" | "xl"} [size]
*/
export let size = undefined;
/**
* Specify the input type
* @type {string} [type="text"]
*/
export let type = "text";
/**
@ -15,7 +20,7 @@
export let disabled = false;
/**
* Define the ARIA label for the calendar icon
* Specify the ARIA label for the calendar icon
* @type {string} [iconDescription=""]
*/
export let iconDescription = "";
@ -44,7 +49,7 @@
/**
* Obtain a reference to the input HTML element
* @type {null | HTMLElement} [ref=null]
* @type {null | HTMLInputElement} [ref=null]
*/
export let ref = null;