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

23
src/Search/Search.svelte
View file

@ -50,37 +50,28 @@
/**
* Specify the `autocomplete` attribute
* @type {"on" | "off"} [autocomplete="off"]
* @type {"on" | "off"}
*/
export let autocomplete = "off";
/**
* Set to `true` to auto focus the search element
* @type {boolean} [autofocus=false]
*/
/** Set to `true` to auto focus the search element */
export let autofocus = false;
/**
* Specify the close button label text
* @type {string} [closeButtonLabelText="Clear search input"]
*/
/** Specify the close button label text */
export let closeButtonLabelText = "Clear search input";
/**
* Specify the label text
* @type {string} [labelText=""]
*/
/** Specify the label text */
export let labelText = "";
/**
* Set an id for the input element
* @type {string} [id]
* @type {string}
*/
export let id = "ccs-" + Math.random().toString(36);
/**
* Obtain a reference to the input HTML element
* @type {null | HTMLInputElement} [ref=null]
* @type {null | HTMLInputElement}
*/
export let ref = null;
@ -88,7 +79,7 @@
import Close16 from "carbon-icons-svelte/lib/Close16";
import Close20 from "carbon-icons-svelte/lib/Close20";
import Search16 from "carbon-icons-svelte/lib/Search16";
import SearchSkeleton from "./Search.Skeleton.svelte";
import SearchSkeleton from "./SearchSkeleton.svelte";
const dispatch = createEventDispatcher();
</script>

3
src/Search/Search.Skeleton.svelte → src/Search/SearchSkeleton.svelte
View file

@ -2,13 +2,12 @@
/**
* @deprecated this prop will be removed in the next major release
* Set to `true` to use the small variant
* @type {boolean} [small=false]
*/
export let small = false;
/**
* Specify the size of the search input
* @type {"sm" | "lg" | "xl"} [size="xl"]
* @type {"sm" | "lg" | "xl"}
*/
export let size = "xl";
</script>

2
src/Search/index.js
View file

@ -1,2 +1,2 @@
export { default as Search } from "./Search.svelte";
export { default as SearchSkeleton } from "./Search.Skeleton.svelte";
export { default as SearchSkeleton } from "./SearchSkeleton.svelte";