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

6
src/CodeSnippet/CodeSnippet.Skeleton.svelte
View file

@ -1,5 +1,9 @@
<script>
export let type = "single"; // "single" | "multi"
/**
* Set the type of code snippet
* @type {"single" | "inline" | "multi"} [type="single"]
*/
export let type = "single";
</script>
<div

39
src/CodeSnippet/CodeSnippet.svelte
View file

@ -29,12 +29,49 @@
* @type {boolean} [skeleton=false]
*/
export let skeleton = false;
/**
* Specify the ARIA label for the copy button icon
* @type {string} [copyButtonDescription]
*/
export let copyButtonDescription = undefined;
/**
* Specify the ARIA label of the copy button
* @type {string} [copyLabel]
*/
export let copyLabel = undefined;
/**
* Specify the feedback text displayed when clicking the snippet
* @type {string} [feedback="Copied!"]
*/
export let feedback = "Copied!";
/**
* Set the timeout duration (ms) to display feedback text
* @type {number} [feedbackTimeout=2000]
*/
export let feedbackTimeout = 2000;
/**
* Specify the show less text
* `type` must be "multi"
* @type {string} [showLessText="Show less"]
*/
export let showLessText = "Show less";
/**
* Specify the show more text
* `type` must be "multi"
* @type {string} [showLessText="Show more"]
*/
export let showMoreText = "Show more";
/**
* Set to `true` to enable the show more/less button
* @type {boolean} [showMoreLess=false]
*/
export let showMoreLess = false;
/**
@ -45,7 +82,7 @@
/**
* Obtain a reference to the pre HTML element
* @type {null | HTMLElement} [ref=null]
* @type {null | HTMLPreElement} [ref=null]
*/
export let ref = null;