chore: use jsdoc to annotate props

This commit is contained in:
Eric Liu 2020-07-24 22:35:20 -07:00
commit 8c1ffd4cb0
5 changed files with 51 additions and 11 deletions

View file

@ -1,5 +1,14 @@
<script>
export let align = "end"; // "start" | "end"
/**
* Specify alignment of accordion item chevron icon
* @type {"start" | "end"} [align="end"]
*/
export let align = "end";
/**
* Set to `true` to display skeleton state
* @type {boolean} [skeleton=false]
*/
export let skeleton = false;
import AccordionSkeleton from "./Accordion.Skeleton.svelte";

View file

@ -1,6 +1,21 @@
<script>
/**
* Specify title of accordion item heading
* Alternatively use the named slot "title"
* @type {string} [title="title"]
*/
export let title = "title";
/**
* Set to `true` to open the first accordion item
* @type {boolean} [open=false]
*/
export let open = false;
/**
* Define the ARIA label for accordion item chevron icon
* @type {string} [iconDescription="Expand/Collapse"]
*/
export let iconDescription = "Expand/Collapse";
import ChevronRight16 from "carbon-icons-svelte/lib/ChevronRight16";