mcp/carbon-components-svelte
1
0
Fork 0
mirror of https://github.com/carbon-design-system/carbon-components-svelte.git synced 2025-09-14 18:01:06 +00:00
Code Issues Projects Releases Packages Wiki Activity
carbon-components-svelte/COMPONENT_API.json

10185 lines
310 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"total": 154,
"components": [
{
"moduleName": "SkeletonText",
"filePath": "/src/SkeletonText/SkeletonText.svelte",
"props": [
{
"name": "lines",
"kind": "let",
"description": "Specify the number of lines to render",
"type": "number",
"value": "3",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "heading",
"kind": "let",
"description": "Set to `true` to use the heading size variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "paragraph",
"kind": "let",
"description": "Set to `true` to use the paragraph size variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "width",
"kind": "let",
"description": "Specify the width of the text (% or px)",
"type": "string",
"value": "\"100%\"",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "AccordionSkeleton",
"filePath": "/src/Accordion/AccordionSkeleton.svelte",
"props": [
{
"name": "count",
"kind": "let",
"description": "Specify the number of accordion items to render",
"type": "number",
"value": "4",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "align",
"kind": "let",
"description": "Specify alignment of accordion item chevron icon",
"type": "\"start\" | \"end\"",
"value": "\"end\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "size",
"kind": "let",
"description": "Specify the size of the accordion",
"type": "\"sm\" | \"xl\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "open",
"kind": "let",
"description": "Set to `false` to close the first accordion item",
"type": "boolean",
"value": "true",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "ul" },
{ "type": "forwarded", "name": "mouseover", "element": "ul" },
{ "type": "forwarded", "name": "mouseenter", "element": "ul" },
{ "type": "forwarded", "name": "mouseleave", "element": "ul" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "ul" }
},
{
"moduleName": "Accordion",
"filePath": "/src/Accordion/Accordion.svelte",
"props": [
{
"name": "align",
"kind": "let",
"description": "Specify alignment of accordion item chevron icon",
"type": "\"start\" | \"end\"",
"value": "\"end\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "size",
"kind": "let",
"description": "Specify the size of the accordion",
"type": "\"sm\" | \"xl\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "disabled",
"kind": "let",
"description": "Set to `true` to disable the accordion",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "skeleton",
"kind": "let",
"description": "Set to `true` to display the skeleton state",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{
"type": "forwarded",
"name": "click",
"element": "AccordionSkeleton"
},
{
"type": "forwarded",
"name": "mouseover",
"element": "AccordionSkeleton"
},
{
"type": "forwarded",
"name": "mouseenter",
"element": "AccordionSkeleton"
},
{
"type": "forwarded",
"name": "mouseleave",
"element": "AccordionSkeleton"
}
],
"typedefs": [],
"rest_props": { "type": "InlineComponent", "name": "AccordionSkeleton" }
},
{
"moduleName": "AccordionItem",
"filePath": "/src/Accordion/AccordionItem.svelte",
"props": [
{
"name": "title",
"kind": "let",
"description": "Specify the title of the accordion item heading\nAlternatively, use the named slot \"title\" (e.g. <div slot=\"title\">...</div>)",
"type": "string",
"value": "\"title\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "open",
"kind": "let",
"description": "Set to `true` to open the first accordion item",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "disabled",
"kind": "let",
"description": "Set to `true` to disable the accordion item",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "iconDescription",
"kind": "let",
"description": "Specify the ARIA label for the accordion item chevron icon",
"type": "string",
"value": "\"Expand/Collapse\"",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [
{ "name": "__default__", "default": true, "slot_props": "{}" },
{
"name": "title",
"default": false,
"fallback": "{title}",
"slot_props": "{}"
}
],
"events": [
{ "type": "forwarded", "name": "animationend", "element": "li" },
{ "type": "forwarded", "name": "click", "element": "button" },
{ "type": "forwarded", "name": "mouseover", "element": "button" },
{ "type": "forwarded", "name": "mouseenter", "element": "button" },
{ "type": "forwarded", "name": "mouseleave", "element": "button" },
{ "type": "forwarded", "name": "keydown", "element": "button" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "li" }
},
{
"moduleName": "AspectRatio",
"filePath": "/src/AspectRatio/AspectRatio.svelte",
"props": [
{
"name": "ratio",
"kind": "let",
"description": "Specify the aspect ratio",
"type": "\"2x1\" | \"16x9\" | \"4x3\" | \"1x1\" | \"3x4\" | \"9x16\" | \"1x2\"",
"value": "\"2x1\"",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "BreadcrumbSkeleton",
"filePath": "/src/Breadcrumb/BreadcrumbSkeleton.svelte",
"props": [
{
"name": "noTrailingSlash",
"kind": "let",
"description": "Set to `true` to hide the breadcrumb trailing slash",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "count",
"kind": "let",
"description": "Specify the number of breadcrumb items to render",
"type": "number",
"value": "3",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "Breadcrumb",
"filePath": "/src/Breadcrumb/Breadcrumb.svelte",
"props": [
{
"name": "noTrailingSlash",
"kind": "let",
"description": "Set to `true` to hide the breadcrumb trailing slash",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "skeleton",
"kind": "let",
"description": "Set to `true` to display skeleton state",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{
"type": "forwarded",
"name": "click",
"element": "BreadcrumbSkeleton"
},
{
"type": "forwarded",
"name": "mouseover",
"element": "BreadcrumbSkeleton"
},
{
"type": "forwarded",
"name": "mouseenter",
"element": "BreadcrumbSkeleton"
},
{
"type": "forwarded",
"name": "mouseleave",
"element": "BreadcrumbSkeleton"
}
],
"typedefs": [],
"rest_props": { "type": "InlineComponent", "name": "BreadcrumbSkeleton" }
},
{
"moduleName": "Link",
"filePath": "/src/Link/Link.svelte",
"props": [
{
"name": "size",
"kind": "let",
"description": "Specify the size of the link",
"type": "\"sm\" | \"lg\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "href",
"kind": "let",
"description": "Specify the href value",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "inline",
"kind": "let",
"description": "Set to `true` to use the inline variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "disabled",
"kind": "let",
"description": "Set to `true` to disable the checkbox",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "visited",
"kind": "let",
"description": "Set to `true` to allow visited styles",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the top-level HTML element",
"type": "null | HTMLAnchorElement | HTMLParagraphElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{ "type": "forwarded", "name": "click", "element": "p" },
{ "type": "forwarded", "name": "mouseover", "element": "p" },
{ "type": "forwarded", "name": "mouseenter", "element": "p" },
{ "type": "forwarded", "name": "mouseleave", "element": "p" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "p" }
},
{
"moduleName": "BreadcrumbItem",
"filePath": "/src/Breadcrumb/BreadcrumbItem.svelte",
"props": [
{
"name": "href",
"kind": "let",
"description": "Set the `href` to use an anchor link",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "isCurrentPage",
"kind": "let",
"description": "Set to `true` if the breadcrumb item represents the current page",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{ "type": "forwarded", "name": "click", "element": "li" },
{ "type": "forwarded", "name": "mouseover", "element": "li" },
{ "type": "forwarded", "name": "mouseenter", "element": "li" },
{ "type": "forwarded", "name": "mouseleave", "element": "li" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "li" }
},
{
"moduleName": "ButtonSkeleton",
"filePath": "/src/Button/ButtonSkeleton.svelte",
"props": [
{
"name": "href",
"kind": "let",
"description": "Set the `href` to use an anchor link",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "size",
"kind": "let",
"description": "Specify the size of button skeleton",
"type": "\"default\" | \"field\" | \"small\"",
"value": "\"default\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "small",
"kind": "let",
"description": "Set to `true` to use the small variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "a" },
{ "type": "forwarded", "name": "mouseover", "element": "a" },
{ "type": "forwarded", "name": "mouseenter", "element": "a" },
{ "type": "forwarded", "name": "mouseleave", "element": "a" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "a" }
},
{
"moduleName": "Button",
"filePath": "/src/Button/Button.svelte",
"props": [
{
"name": "kind",
"kind": "let",
"description": "Specify the kind of button",
"type": "\"primary\" | \"secondary\" | \"tertiary\" | \"ghost\" | \"danger\" | \"danger-tertiary\" | \"danger-ghost\"",
"value": "\"primary\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "size",
"kind": "let",
"description": "Specify the size of button",
"type": "\"default\" | \"field\" | \"small\"",
"value": "\"default\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "hasIconOnly",
"kind": "let",
"description": "Set to `true` for the icon-only variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "icon",
"kind": "let",
"description": "Specify the icon from `carbon-icons-svelte` to render",
"type": "import(\"carbon-icons-svelte\").CarbonIcon",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "iconDescription",
"kind": "let",
"description": "Specify the ARIA label for the button icon",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "tooltipAlignment",
"kind": "let",
"description": "Set the alignment of the tooltip relative to the icon\n`hasIconOnly` must be set to `true`",
"type": "\"start\" | \"center\" | \"end\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "tooltipPosition",
"kind": "let",
"description": "Set the position of the tooltip relative to the icon",
"type": "\"top\" | \"right\" | \"bottom\" | \"left\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "as",
"kind": "let",
"description": "Set to `true` to render a custom HTML element\nProps are destructured as `props` in the default slot (e.g. <Button let:props><div {...props}>...</div></Button>)",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "skeleton",
"kind": "let",
"description": "Set to `true` to display the skeleton state",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "disabled",
"kind": "let",
"description": "Set to `true` to disable the button",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "href",
"kind": "let",
"description": "Set the `href` to use an anchor link",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "tabindex",
"kind": "let",
"description": "Specify the tabindex",
"type": "string",
"value": "\"0\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "type",
"kind": "let",
"description": "Specify the `type` attribute for the button element",
"type": "string",
"value": "\"button\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the HTML element",
"type": "null | HTMLAnchorElement | HTMLButtonElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [
{
"name": "__default__",
"default": true,
"slot_props": "{ props?: { role: \"button\"; type?: string; tabindex: string; disabled: boolean; href?: string; class: string; [key: string]: any; } }"
}
],
"events": [
{ "type": "forwarded", "name": "click", "element": "ButtonSkeleton" },
{
"type": "forwarded",
"name": "mouseover",
"element": "ButtonSkeleton"
},
{
"type": "forwarded",
"name": "mouseenter",
"element": "ButtonSkeleton"
},
{
"type": "forwarded",
"name": "mouseleave",
"element": "ButtonSkeleton"
}
],
"typedefs": [],
"rest_props": { "type": "InlineComponent", "name": "ButtonSkeleton" }
},
{
"moduleName": "ButtonSet",
"filePath": "/src/Button/ButtonSet.svelte",
"props": [
{
"name": "stacked",
"kind": "let",
"description": "Set to `true` to stack the buttons vertically",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "CheckboxSkeleton",
"filePath": "/src/Checkbox/CheckboxSkeleton.svelte",
"props": [],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "Checkbox",
"filePath": "/src/Checkbox/Checkbox.svelte",
"props": [
{
"name": "checked",
"kind": "let",
"description": "Specify whether the checkbox is checked",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "indeterminate",
"kind": "let",
"description": "Specify whether the checkbox is indeterminate",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "skeleton",
"kind": "let",
"description": "Set to `true` to display the skeleton state",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "readonly",
"kind": "let",
"description": "Set to `true` for the checkbox to be read-only",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "disabled",
"kind": "let",
"description": "Set to `true` to disable the checkbox",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "labelText",
"kind": "let",
"description": "Specify the label text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "hideLabel",
"kind": "let",
"description": "Set to `true` to visually hide the label text",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "name",
"kind": "let",
"description": "Set a name for the input element",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "title",
"kind": "let",
"description": "Specify the title attribute for the label element",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the input label",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the input HTML element",
"type": "null | HTMLInputElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [],
"events": [
{ "type": "dispatched", "name": "check", "detail": "boolean" },
{ "type": "forwarded", "name": "click", "element": "CheckboxSkeleton" },
{
"type": "forwarded",
"name": "mouseover",
"element": "CheckboxSkeleton"
},
{
"type": "forwarded",
"name": "mouseenter",
"element": "CheckboxSkeleton"
},
{
"type": "forwarded",
"name": "mouseleave",
"element": "CheckboxSkeleton"
},
{ "type": "forwarded", "name": "change", "element": "input" }
],
"typedefs": [],
"rest_props": { "type": "InlineComponent", "name": "CheckboxSkeleton" }
},
{
"moduleName": "ContentSwitcher",
"filePath": "/src/ContentSwitcher/ContentSwitcher.svelte",
"props": [
{
"name": "selectedIndex",
"kind": "let",
"description": "Set the selected index of the switch item",
"type": "number",
"value": "0",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "light",
"kind": "let",
"description": "Set to `true` to enable the light variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "size",
"kind": "let",
"description": "Specify the size of the content switcher",
"type": "\"sm\" | \"xl\"",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{ "type": "dispatched", "name": "change", "detail": "number" },
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "Switch",
"filePath": "/src/ContentSwitcher/Switch.svelte",
"props": [
{
"name": "text",
"kind": "let",
"description": "Specify the switch text\nAlternatively, use the named slot \"text\" (e.g. <span slot=\"text\">...</span>)",
"type": "string",
"value": "\"Provide text\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "selected",
"kind": "let",
"description": "Set to `true` for the switch to be selected",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "disabled",
"kind": "let",
"description": "Set to `true` to disable the switch",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the button element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the button HTML element",
"type": "null | HTMLButtonElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [
{
"name": "__default__",
"default": true,
"fallback": "{text}",
"slot_props": "{}"
}
],
"events": [
{ "type": "forwarded", "name": "click", "element": "button" },
{ "type": "forwarded", "name": "mouseover", "element": "button" },
{ "type": "forwarded", "name": "mouseenter", "element": "button" },
{ "type": "forwarded", "name": "mouseleave", "element": "button" },
{ "type": "forwarded", "name": "keydown", "element": "button" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "button" }
},
{
"moduleName": "Copy",
"filePath": "/src/Copy/Copy.svelte",
"props": [
{
"name": "feedback",
"kind": "let",
"description": "Set the feedback text shown after clicking the button",
"type": "string",
"value": "\"Copied!\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "feedbackTimeout",
"kind": "let",
"description": "Set the timeout duration (ms) to display feedback text",
"type": "number",
"value": "2000",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the button HTML element",
"type": "null | HTMLButtonElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [
{
"name": "__default__",
"default": true,
"fallback": "{#if animation}{feedback || $$restProps['aria-label']}{/if}",
"slot_props": "{}"
}
],
"events": [
{ "type": "forwarded", "name": "click", "element": "button" },
{ "type": "forwarded", "name": "animationend", "element": "button" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "button" }
},
{
"moduleName": "CopyButton",
"filePath": "/src/CopyButton/CopyButton.svelte",
"props": [
{
"name": "iconDescription",
"kind": "let",
"description": "Set the title and ARIA label for the copy button",
"type": "string",
"value": "\"Copy to clipboard\"",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "Copy" },
{ "type": "forwarded", "name": "animationend", "element": "Copy" }
],
"typedefs": [],
"rest_props": { "type": "InlineComponent", "name": "Copy" }
},
{
"moduleName": "ListBox",
"filePath": "/src/ListBox/ListBox.svelte",
"props": [
{
"name": "size",
"kind": "let",
"description": "Set the size of the list box",
"type": "\"sm\" | \"xl\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "type",
"kind": "let",
"description": "Set the type of the list box",
"type": "\"default\" | \"inline\"",
"value": "\"default\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "open",
"kind": "let",
"description": "Set to `true` to open the list box",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "light",
"kind": "let",
"description": "Set to `true` to enable the light variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "disabled",
"kind": "let",
"description": "Set to `true` to disable the list box",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "invalid",
"kind": "let",
"description": "Set to `true` to indicate an invalid state",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "invalidText",
"kind": "let",
"description": "Specify the invalid state text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{ "type": "forwarded", "name": "keydown", "element": "div" },
{ "type": "forwarded", "name": "click", "element": "div" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "ListBoxField",
"filePath": "/src/ListBox/ListBoxField.svelte",
"props": [
{
"name": "disabled",
"kind": "let",
"description": "Set to `true` to disable the list box field",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "role",
"kind": "let",
"description": "Specify the role attribute",
"type": "string",
"value": "\"combobox\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "tabindex",
"kind": "let",
"description": "Specify the tabindex",
"type": "string",
"value": "\"-1\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "translationIds",
"kind": "const",
"description": "Default translation ids",
"type": "{ close: \"close\", open: \"open\" }",
"value": "{ close: \"close\", open: \"open\" }",
"isFunction": false,
"constant": true,
"reactive": false
},
{
"name": "translateWithId",
"kind": "let",
"description": "Override the default translation ids",
"type": "(id: ListBoxFieldTranslationId) => string",
"value": "(id) => defaultTranslations[id]",
"isFunction": true,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the top-level element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the top-level HTML element",
"type": "null | HTMLDivElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" },
{ "type": "forwarded", "name": "keydown", "element": "div" },
{ "type": "forwarded", "name": "blur", "element": "div" }
],
"typedefs": [
{
"type": "\"close\" | \"open\"",
"name": "ListBoxFieldTranslationId",
"ts": "type ListBoxFieldTranslationId = \"close\" | \"open\""
}
],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "ListBoxMenu",
"filePath": "/src/ListBox/ListBoxMenu.svelte",
"props": [
{
"name": "id",
"kind": "let",
"description": "Set an id for the top-level element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the HTML element",
"type": "null | HTMLDivElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [{ "type": "forwarded", "name": "scroll", "element": "div" }],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "ListBoxMenuIcon",
"filePath": "/src/ListBox/ListBoxMenuIcon.svelte",
"props": [
{
"name": "open",
"kind": "let",
"description": "Set to `true` to open the list box menu icon",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "translationIds",
"kind": "const",
"description": "Default translation ids",
"type": "{ close: \"close\", open: \"open\" }",
"value": "{ close: \"close\", open: \"open\" }",
"isFunction": false,
"constant": true,
"reactive": false
},
{
"name": "translateWithId",
"kind": "let",
"description": "Override the default translation ids",
"type": "(id: ListBoxMenuIconTranslationId) => string",
"value": "(id) => defaultTranslations[id]",
"isFunction": true,
"constant": false,
"reactive": false
}
],
"slots": [],
"events": [{ "type": "forwarded", "name": "click", "element": "div" }],
"typedefs": [
{
"type": "\"close\" | \"open\"",
"name": "ListBoxMenuIconTranslationId",
"ts": "type ListBoxMenuIconTranslationId = \"close\" | \"open\""
}
],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "ListBoxMenuItem",
"filePath": "/src/ListBox/ListBoxMenuItem.svelte",
"props": [
{
"name": "active",
"kind": "let",
"description": "Set to `true` to enable the active state",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "highlighted",
"kind": "let",
"description": "Set to `true` to enable the highlighted state",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "ListBoxSelection",
"filePath": "/src/ListBox/ListBoxSelection.svelte",
"props": [
{
"name": "selectionCount",
"kind": "let",
"description": "Specify the number of selected items",
"type": "any",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "disabled",
"kind": "let",
"description": "Set to `true` to disable the list box selection",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "translationIds",
"kind": "const",
"description": "Default translation ids",
"type": "{ clearAll: \"clearAll\", clearSelection: \"clearSelection\", }",
"value": "{ clearAll: \"clearAll\", clearSelection: \"clearSelection\", }",
"isFunction": false,
"constant": true,
"reactive": false
},
{
"name": "translateWithId",
"kind": "let",
"description": "Override the default translation ids",
"type": "(id: ListBoxSelectionTranslationId) => string",
"value": "(id) => defaultTranslations[id]",
"isFunction": true,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the top-level HTML element",
"type": "null | HTMLDivElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [],
"events": [{ "type": "dispatched", "name": "clear" }],
"typedefs": [
{
"type": "\"clearAll\" | \"clearSelection\"",
"name": "ListBoxSelectionTranslationId",
"ts": "type ListBoxSelectionTranslationId = \"clearAll\" | \"clearSelection\""
}
],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "ComboBox",
"filePath": "/src/ComboBox/ComboBox.svelte",
"props": [
{
"name": "items",
"kind": "let",
"description": "Set the combobox items",
"type": "ComboBoxItem[]",
"value": "[]",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "itemToString",
"kind": "let",
"description": "Override the display of a combobox item",
"type": "(item: ComboBoxItem) => string",
"value": "(item) => item.text || item.id",
"isFunction": true,
"constant": false,
"reactive": false
},
{
"name": "selectedIndex",
"kind": "let",
"description": "Set the selected item by value index",
"type": "number",
"value": "-1",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "value",
"kind": "let",
"description": "Specify the selected combobox value",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "size",
"kind": "let",
"description": "Set the size of the combobox",
"type": "\"sm\" | \"xl\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "disabled",
"kind": "let",
"description": "Set to `true` to disable the combobox",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "titleText",
"kind": "let",
"description": "Specify the title text of the combobox",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "placeholder",
"kind": "let",
"description": "Specify the placeholder text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "helperText",
"kind": "let",
"description": "Specify the helper text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "invalidText",
"kind": "let",
"description": "Specify the invalid state text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "invalid",
"kind": "let",
"description": "Set to `true` to indicate an invalid state",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "light",
"kind": "let",
"description": "Set to `true` to enable the light variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "open",
"kind": "let",
"description": "Set to `true` to open the combobox menu dropdown",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "shouldFilterItem",
"kind": "let",
"description": "Determine if an item should be filtered given the current combobox value",
"type": "(item: ComboBoxItem, value: string) => boolean",
"value": "() => true",
"isFunction": true,
"constant": false,
"reactive": false
},
{
"name": "translateWithId",
"kind": "let",
"description": "Override the default translation ids",
"type": "(id: any) => string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the list box component",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "name",
"kind": "let",
"description": "Specify a name attribute for the input",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the input HTML element",
"type": "null | HTMLInputElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "listRef",
"kind": "let",
"description": "Obtain a reference to the list HTML element",
"type": "null | HTMLDivElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [],
"events": [
{
"type": "dispatched",
"name": "select",
"detail": "{ selectedId: string; selectedIndex: number; selectedItem: ComboBoxItem }"
},
{ "type": "forwarded", "name": "keydown", "element": "input" },
{ "type": "forwarded", "name": "focus", "element": "input" },
{ "type": "forwarded", "name": "blur", "element": "input" },
{ "type": "forwarded", "name": "clear", "element": "ListBoxSelection" },
{ "type": "forwarded", "name": "scroll", "element": "ListBoxMenu" }
],
"typedefs": [
{
"type": "{ id: string; text: string; }",
"name": "ComboBoxItem",
"ts": "interface ComboBoxItem { id: string; text: string; }"
}
],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "ComposedModal",
"filePath": "/src/ComposedModal/ComposedModal.svelte",
"props": [
{
"name": "size",
"kind": "let",
"description": "Set the size of the composed modal",
"type": "\"xs\" | \"sm\" | \"lg\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "open",
"kind": "let",
"description": "Set to `true` to open the modal",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "danger",
"kind": "let",
"description": "Set to `true` to use the danger variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "preventCloseOnClickOutside",
"kind": "let",
"description": "Set to `true` to prevent the modal from closing when clicking outside",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "containerClass",
"kind": "let",
"description": "Specify a class for the inner modal",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "selectorPrimaryFocus",
"kind": "let",
"description": "Specify a selector to be focused when opening the modal",
"type": "string",
"value": "\"[data-modal-primary-focus]\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the top-level HTML element",
"type": "null | HTMLDivElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" },
{ "type": "forwarded", "name": "transitionend", "element": "div" },
{ "type": "dispatched", "name": "submit" },
{ "type": "dispatched", "name": "close" },
{ "type": "dispatched", "name": "open" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "ModalHeader",
"filePath": "/src/ComposedModal/ModalHeader.svelte",
"props": [
{
"name": "title",
"kind": "let",
"description": "Specify the modal title",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "label",
"kind": "let",
"description": "Specify the modal label",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "labelClass",
"kind": "let",
"description": "Specify the label class",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "titleClass",
"kind": "let",
"description": "Specify the title class",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "closeClass",
"kind": "let",
"description": "Specify the close class",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "closeIconClass",
"kind": "let",
"description": "Specify the close icon class",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "iconDescription",
"kind": "let",
"description": "Specify the ARIA label for the close icon",
"type": "string",
"value": "\"Close\"",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [{ "type": "forwarded", "name": "click", "element": "button" }],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "ModalBody",
"filePath": "/src/ComposedModal/ModalBody.svelte",
"props": [
{
"name": "hasForm",
"kind": "let",
"description": "Set to `true` if the modal contains form elements",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "hasScrollingContent",
"kind": "let",
"description": "Set to `true` if the modal contains scrolling content",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "ModalFooter",
"filePath": "/src/ComposedModal/ModalFooter.svelte",
"props": [
{
"name": "primaryButtonText",
"kind": "let",
"description": "Specify the primary button text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "primaryButtonDisabled",
"kind": "let",
"description": "Set to `true` to disable the primary button",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "primaryClass",
"kind": "let",
"description": "Specify a class for the primary button",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "secondaryButtonText",
"kind": "let",
"description": "Specify the secondary button text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "secondaryClass",
"kind": "let",
"description": "Specify a class for the secondary button",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "danger",
"kind": "let",
"description": "Set to `true` to use the danger variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "CodeSnippetSkeleton",
"filePath": "/src/CodeSnippet/CodeSnippetSkeleton.svelte",
"props": [
{
"name": "type",
"kind": "let",
"description": "Set the type of code snippet",
"type": "\"single\" | \"inline\" | \"multi\"",
"value": "\"single\"",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "CodeSnippet",
"filePath": "/src/CodeSnippet/CodeSnippet.svelte",
"props": [
{
"name": "type",
"kind": "let",
"description": "Set the type of code snippet",
"type": "\"single\" | \"inline\" | \"multi\"",
"value": "\"single\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "code",
"kind": "let",
"description": "Set the code snippet text\nAlternatively, use the default slot (e.g. <CodeSnippet>{`code`}</CodeSnippet>)",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "expanded",
"kind": "let",
"description": "Set to `true` to expand a multi-line code snippet (type=\"multi\")",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "hideCopyButton",
"kind": "let",
"description": "Set to `true` to hide the copy button",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "wrapText",
"kind": "let",
"description": "Set to `true` to wrap the text\nNote that `type` must be \"multi\"",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "light",
"kind": "let",
"description": "Set to `true` to enable the light variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "skeleton",
"kind": "let",
"description": "Set to `true` to display the skeleton state",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "copyButtonDescription",
"kind": "let",
"description": "Specify the ARIA label for the copy button icon",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "copyLabel",
"kind": "let",
"description": "Specify the ARIA label of the copy button",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "feedback",
"kind": "let",
"description": "Specify the feedback text displayed when clicking the snippet",
"type": "string",
"value": "\"Copied!\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "feedbackTimeout",
"kind": "let",
"description": "Set the timeout duration (ms) to display feedback text",
"type": "number",
"value": "2000",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "showLessText",
"kind": "let",
"description": "Specify the show less text\n`type` must be \"multi\"",
"type": "string",
"value": "\"Show less\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "showMoreText",
"kind": "let",
"description": "Specify the show more text\n`type` must be \"multi\"",
"type": "string",
"value": "\"Show more\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "showMoreLess",
"kind": "let",
"description": "Set to `true` to enable the show more/less button",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the code element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the pre HTML element",
"type": "null | HTMLPreElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [
{
"name": "__default__",
"default": true,
"fallback": "{code}",
"slot_props": "{}"
}
],
"events": [
{
"type": "forwarded",
"name": "click",
"element": "CodeSnippetSkeleton"
},
{
"type": "forwarded",
"name": "mouseover",
"element": "CodeSnippetSkeleton"
},
{
"type": "forwarded",
"name": "mouseenter",
"element": "CodeSnippetSkeleton"
},
{
"type": "forwarded",
"name": "mouseleave",
"element": "CodeSnippetSkeleton"
},
{ "type": "forwarded", "name": "animationend", "element": "CopyButton" }
],
"typedefs": [],
"rest_props": { "type": "InlineComponent", "name": "CodeSnippetSkeleton" }
},
{
"moduleName": "RadioButton",
"filePath": "/src/RadioButton/RadioButton.svelte",
"props": [
{
"name": "value",
"kind": "let",
"description": "Specify the value of the radio button",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "checked",
"kind": "let",
"description": "Set to `true` to check the radio button",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "disabled",
"kind": "let",
"description": "et to `true` to disable the radio button",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "labelPosition",
"kind": "let",
"description": "Specify the label position",
"type": "\"right\" | \"left\"",
"value": "\"right\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "labelText",
"kind": "let",
"description": "Specify the label text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "hideLabel",
"kind": "let",
"description": "Set to `true` to visually hide the label text",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the input element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "name",
"kind": "let",
"description": "Specify a name attribute for the checkbox input",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the input HTML element",
"type": "null | HTMLInputElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [],
"events": [{ "type": "forwarded", "name": "change", "element": "input" }],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "RadioButtonSkeleton",
"filePath": "/src/RadioButton/RadioButtonSkeleton.svelte",
"props": [],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "Table",
"filePath": "/src/DataTable/Table.svelte",
"props": [
{
"name": "size",
"kind": "let",
"description": "Set the size of the table",
"type": "\"compact\" | \"short\" | \"tall\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "zebra",
"kind": "let",
"description": "Set to `true` to use zebra styles",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "useStaticWidth",
"kind": "let",
"description": "Set to `true` to use static width",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "shouldShowBorder",
"kind": "let",
"description": "Set to `true` for the bordered variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "sortable",
"kind": "let",
"description": "Set to `true` for the sortable variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "stickyHeader",
"kind": "let",
"description": "Set to `true` to enable a sticky header",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [],
"typedefs": [],
"rest_props": { "type": "Element", "name": "section" }
},
{
"moduleName": "TableBody",
"filePath": "/src/DataTable/TableBody.svelte",
"props": [],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [],
"typedefs": [],
"rest_props": { "type": "Element", "name": "tbody" }
},
{
"moduleName": "TableCell",
"filePath": "/src/DataTable/TableCell.svelte",
"props": [],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{ "type": "forwarded", "name": "click", "element": "td" },
{ "type": "forwarded", "name": "mouseover", "element": "td" },
{ "type": "forwarded", "name": "mouseenter", "element": "td" },
{ "type": "forwarded", "name": "mouseleave", "element": "td" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "td" }
},
{
"moduleName": "TableContainer",
"filePath": "/src/DataTable/TableContainer.svelte",
"props": [
{
"name": "title",
"kind": "let",
"description": "Specify the title of the data table",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "description",
"kind": "let",
"description": "Specify the description of the data table",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "stickyHeader",
"kind": "let",
"description": "Set to `true` to enable a sticky header",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "TableHead",
"filePath": "/src/DataTable/TableHead.svelte",
"props": [],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{ "type": "forwarded", "name": "click", "element": "thead" },
{ "type": "forwarded", "name": "mouseover", "element": "thead" },
{ "type": "forwarded", "name": "mouseenter", "element": "thead" },
{ "type": "forwarded", "name": "mouseleave", "element": "thead" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "thead" }
},
{
"moduleName": "TableHeader",
"filePath": "/src/DataTable/TableHeader.svelte",
"props": [
{
"name": "scope",
"kind": "let",
"description": "Specify the `scope` attribute",
"type": "string",
"value": "\"col\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "translateWithId",
"kind": "let",
"description": "Override the default id translations",
"type": "() => string",
"value": "() => \"\"",
"isFunction": true,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the top-level element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{ "type": "forwarded", "name": "mouseover", "element": "th" },
{ "type": "forwarded", "name": "mouseenter", "element": "th" },
{ "type": "forwarded", "name": "mouseleave", "element": "th" },
{ "type": "forwarded", "name": "click", "element": "button" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "th" }
},
{
"moduleName": "TableRow",
"filePath": "/src/DataTable/TableRow.svelte",
"props": [],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{ "type": "forwarded", "name": "click", "element": "tr" },
{ "type": "forwarded", "name": "mouseover", "element": "tr" },
{ "type": "forwarded", "name": "mouseenter", "element": "tr" },
{ "type": "forwarded", "name": "mouseleave", "element": "tr" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "tr" }
},
{
"moduleName": "DataTable",
"filePath": "/src/DataTable/DataTable.svelte",
"props": [
{
"name": "headers",
"kind": "let",
"description": "Specify the data table headers",
"type": "Headers",
"value": "[]",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "rows",
"kind": "let",
"description": "Specify the rows the data table should render\nkeys defined in `headers` are used for the row ids",
"type": "Object[]",
"value": "[]",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "size",
"kind": "let",
"description": "Set the size of the data table",
"type": "\"compact\" | \"short\" | \"tall\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "title",
"kind": "let",
"description": "Specify the title of the data table",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "description",
"kind": "let",
"description": "Specify the description of the data table",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "zebra",
"kind": "let",
"description": "Set to `true` to use zebra styles",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "sortable",
"kind": "let",
"description": "Set to `true` for the sortable variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "expandable",
"kind": "let",
"description": "Set to `true` for the expandable variant\nAutomatically set to `true` if `batchExpansion` is `true`",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "batchExpansion",
"kind": "let",
"description": "Set to `true` to enable batch expansion",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "expandedRowIds",
"kind": "let",
"description": "Specify the row ids to be expanded",
"type": "string[]",
"value": "[]",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "radio",
"kind": "let",
"description": "Set to `true` for the radio selection variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "selectable",
"kind": "let",
"description": "Set to `true` for the selectable variant\nAutomatically set to `true` if `radio` or `batchSelection` are `true`",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "batchSelection",
"kind": "let",
"description": "Set to `true` to enable batch selection",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "selectedRowIds",
"kind": "let",
"description": "Specify the row ids to be selected",
"type": "string[]",
"value": "[]",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "stickyHeader",
"kind": "let",
"description": "Set to `true` to enable a sticky header",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [
{ "name": "__default__", "default": true, "slot_props": "{}" },
{
"name": "cell",
"default": false,
"fallback": "{headers[j].display ? headers[j].display(cell.value) : cell.value}",
"slot_props": "{ row: Object; cell: Object; }"
},
{
"name": "cell-header",
"default": false,
"fallback": "{header.value}",
"slot_props": "{ header: Header}"
},
{
"name": "expanded-row",
"default": false,
"slot_props": "{ row: Object; }"
}
],
"events": [
{
"type": "dispatched",
"name": "click",
"detail": "{ header?: Header; row?: Object; cell?: Object; }"
},
{
"type": "dispatched",
"name": "click:header--expand",
"detail": "{ expanded: boolean; }"
},
{
"type": "dispatched",
"name": "click:header",
"detail": "{ header: Header; sortDirection: \"ascending\" | \"descending\" | \"none\" }"
},
{ "type": "dispatched", "name": "click:row", "detail": "Object" },
{ "type": "dispatched", "name": "mouseenter:row", "detail": "Object" },
{ "type": "dispatched", "name": "mouseleave:row", "detail": "Object" },
{
"type": "dispatched",
"name": "click:row--expand",
"detail": "{ expanded: boolean; row: Object; }"
},
{ "type": "dispatched", "name": "click:cell", "detail": "Object" }
],
"typedefs": [
{
"type": "{ key: string; value: string; display?: (item) => string; sort?: (a, b) => number; empty?: boolean; columnMenu?: boolean; }",
"name": "Header",
"ts": "interface Header { key: string; value: string; display?: (item) => string; sort?: (a, b) => number; empty?: boolean; columnMenu?: boolean; }"
},
{
"type": "Header[]",
"name": "Headers",
"ts": "type Headers = Header[]"
}
],
"rest_props": { "type": "InlineComponent", "name": "TableContainer" }
},
{
"moduleName": "Toolbar",
"filePath": "/src/DataTable/Toolbar.svelte",
"props": [
{
"name": "size",
"kind": "let",
"description": "Specify the toolbar size",
"type": "\"sm\" | \"default\"",
"value": "\"default\"",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [],
"typedefs": [],
"rest_props": { "type": "Element", "name": "section" }
},
{
"moduleName": "ToolbarContent",
"filePath": "/src/DataTable/ToolbarContent.svelte",
"props": [],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [],
"typedefs": []
},
{
"moduleName": "SearchSkeleton",
"filePath": "/src/Search/SearchSkeleton.svelte",
"props": [
{
"name": "small",
"kind": "let",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "size",
"kind": "let",
"description": "Specify the size of the search input",
"type": "\"sm\" | \"lg\" | \"xl\"",
"value": "\"xl\"",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "Search",
"filePath": "/src/Search/Search.svelte",
"props": [
{
"name": "small",
"kind": "let",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "size",
"kind": "let",
"description": "Specify the size of the search input",
"type": "\"sm\" | \"lg\" | \"xl\"",
"value": "\"xl\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "skeleton",
"kind": "let",
"description": "Set to `true` to display the skeleton state",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "light",
"kind": "let",
"description": "Set to `true` to enable the light variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "disabled",
"kind": "let",
"description": "Set to `true` to disable the search input",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "value",
"kind": "let",
"description": "Specify the value of the search input",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "type",
"kind": "let",
"description": "Specify the `type` attribute of the search input",
"type": "string",
"value": "\"text\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "placeholder",
"kind": "let",
"description": "Specify the `placeholder` attribute of the search input",
"type": "string",
"value": "\"Search...\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "autocomplete",
"kind": "let",
"description": "Specify the `autocomplete` attribute",
"type": "\"on\" | \"off\"",
"value": "\"off\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "autofocus",
"kind": "let",
"description": "Set to `true` to auto focus the search element",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "closeButtonLabelText",
"kind": "let",
"description": "Specify the close button label text",
"type": "string",
"value": "\"Clear search input\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "labelText",
"kind": "let",
"description": "Specify the label text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the input element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the input HTML element",
"type": "null | HTMLInputElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "SearchSkeleton" },
{
"type": "forwarded",
"name": "mouseover",
"element": "SearchSkeleton"
},
{
"type": "forwarded",
"name": "mouseenter",
"element": "SearchSkeleton"
},
{
"type": "forwarded",
"name": "mouseleave",
"element": "SearchSkeleton"
},
{ "type": "forwarded", "name": "change", "element": "input" },
{ "type": "forwarded", "name": "input", "element": "input" },
{ "type": "forwarded", "name": "focus", "element": "input" },
{ "type": "forwarded", "name": "blur", "element": "input" },
{ "type": "dispatched", "name": "clear" }
],
"typedefs": [],
"rest_props": { "type": "InlineComponent", "name": "SearchSkeleton" }
},
{
"moduleName": "ToolbarSearch",
"filePath": "/src/DataTable/ToolbarSearch.svelte",
"props": [
{
"name": "value",
"kind": "let",
"description": "Specify the value of the search input",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "expanded",
"kind": "let",
"description": "Set to `true` to expand the search bar",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "persistent",
"kind": "let",
"description": "Set to `true` to keep the search bar expanded",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "tabindex",
"kind": "let",
"description": "Specify the tabindex",
"type": "string",
"value": "\"0\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the input HTML element",
"type": "null | HTMLInputElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [],
"events": [
{ "type": "forwarded", "name": "change", "element": "Search" },
{ "type": "forwarded", "name": "input", "element": "Search" },
{ "type": "forwarded", "name": "focus", "element": "Search" },
{ "type": "forwarded", "name": "blur", "element": "Search" }
],
"typedefs": [],
"rest_props": { "type": "InlineComponent", "name": "Search" }
},
{
"moduleName": "ToolbarBatchActions",
"filePath": "/src/DataTable/ToolbarBatchActions.svelte",
"props": [
{
"name": "formatTotalSelected",
"kind": "let",
"description": "Override the total items selected text",
"type": "(totalSelected: number) => string",
"value": "(totalSelected) => `${totalSelected} item${totalSelected === 1 ? \"\" : \"s\"} selected`",
"isFunction": true,
"constant": false,
"reactive": false
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "OverflowMenu",
"filePath": "/src/OverflowMenu/OverflowMenu.svelte",
"props": [
{
"name": "size",
"kind": "let",
"description": "Specify the size of the overflow menu",
"type": "\"sm\" | \"xl\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "direction",
"kind": "let",
"description": "Specify the direction of the overflow menu relative to the button",
"type": "\"top\" | \"bottom\"",
"value": "\"bottom\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "open",
"kind": "let",
"description": "Set to `true` to open the menu",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "light",
"kind": "let",
"description": "Set to `true` to enable the light variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "flipped",
"kind": "let",
"description": "Set to `true` to flip the menu relative to the button",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "menuOptionsClass",
"kind": "let",
"description": "Specify the menu options class",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "icon",
"kind": "let",
"description": "Specify the icon from `carbon-icons-svelte` to render",
"type": "import(\"carbon-icons-svelte\").CarbonIcon",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "iconClass",
"kind": "let",
"description": "Specify the icon class",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "iconDescription",
"kind": "let",
"description": "Specify the ARIA label for the icon",
"type": "string",
"value": "\"Open and close list of options\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the button element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "buttonRef",
"kind": "let",
"description": "Obtain a reference to the trigger button element",
"type": "null | HTMLButtonElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "menuRef",
"kind": "let",
"description": "Obtain a reference to the overflow menu element",
"type": "null | HTMLUListElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [
{ "name": "__default__", "default": true, "slot_props": "{}" },
{
"name": "menu",
"default": false,
"fallback": "<svelte:component\n this=\"{icon}\"\n aria-label=\"{iconDescription}\"\n title=\"{iconDescription}\"\n class=\"bx--overflow-menu__icon {iconClass}\"\n />",
"slot_props": "{}"
}
],
"events": [
{ "type": "forwarded", "name": "click", "element": "button" },
{ "type": "forwarded", "name": "mouseover", "element": "button" },
{ "type": "forwarded", "name": "mouseenter", "element": "button" },
{ "type": "forwarded", "name": "mouseleave", "element": "button" },
{ "type": "forwarded", "name": "keydown", "element": "button" },
{ "type": "dispatched", "name": "close" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "button" }
},
{
"moduleName": "OverflowMenuItem",
"filePath": "/src/OverflowMenu/OverflowMenuItem.svelte",
"props": [
{
"name": "text",
"kind": "let",
"description": "Specify the item text\nAlternatively, use the default slot for a custom element",
"type": "string",
"value": "\"Provide text\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "href",
"kind": "let",
"description": "Specify the `href` attribute if the item is a link",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "primaryFocus",
"kind": "let",
"description": "Set to `true` if the item should be focused when opening the menu",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "disabled",
"kind": "let",
"description": "Set to `true` to disable the item",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "hasDivider",
"kind": "let",
"description": "Set to `true` to include a divider",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "danger",
"kind": "let",
"description": "Set to `true` to use the danger variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "requireTitle",
"kind": "let",
"description": "Set to `false` to omit the button `title` attribute",
"type": "boolean",
"value": "true",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the top-level element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the HTML element",
"type": "null | HTMLAnchorElement | HTMLButtonElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [
{
"name": "__default__",
"default": true,
"fallback": "<div class:bx--overflow-menu-options__option-content=\"{true}\">\n {text}\n </div>",
"slot_props": "{}"
}
],
"events": [
{ "type": "forwarded", "name": "click", "element": "a" },
{ "type": "forwarded", "name": "keydown", "element": "a" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "li" }
},
{
"moduleName": "ToolbarMenu",
"filePath": "/src/DataTable/ToolbarMenu.svelte",
"props": [],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [],
"typedefs": [],
"rest_props": { "type": "InlineComponent", "name": "OverflowMenu" }
},
{
"moduleName": "ToolbarMenuItem",
"filePath": "/src/DataTable/ToolbarMenuItem.svelte",
"props": [],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{ "type": "forwarded", "name": "click", "element": "OverflowMenuItem" },
{
"type": "forwarded",
"name": "keydown",
"element": "OverflowMenuItem"
}
],
"typedefs": [],
"rest_props": { "type": "InlineComponent", "name": "OverflowMenuItem" }
},
{
"moduleName": "DataTableSkeleton",
"filePath": "/src/DataTableSkeleton/DataTableSkeleton.svelte",
"props": [
{
"name": "columns",
"kind": "let",
"description": "Specify the number of columns",
"type": "number",
"value": "5",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "rows",
"kind": "let",
"description": "Specify the number of rows",
"type": "number",
"value": "5",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "size",
"kind": "let",
"description": "Set the size of the data table",
"type": "\"compact\" | \"short\" | \"tall\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "zebra",
"kind": "let",
"description": "Set to `true` to apply zebra styles to the datatable rows",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "showHeader",
"kind": "let",
"description": "Set to `false` to hide the header",
"type": "boolean",
"value": "true",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "headers",
"kind": "let",
"description": "Set the column headers\nIf `headers` has one more items, `count` is ignored",
"type": "string[]",
"value": "[]",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "showToolbar",
"kind": "let",
"description": "Set to `false` to hide the toolbar",
"type": "boolean",
"value": "true",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "table" },
{ "type": "forwarded", "name": "mouseover", "element": "table" },
{ "type": "forwarded", "name": "mouseenter", "element": "table" },
{ "type": "forwarded", "name": "mouseleave", "element": "table" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "table" }
},
{
"moduleName": "DatePicker",
"filePath": "/src/DatePicker/DatePicker.svelte",
"props": [
{
"name": "datePickerType",
"kind": "let",
"description": "Specify the date picker type",
"type": "\"simple\" | \"single\" | \"range\"",
"value": "\"simple\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "value",
"kind": "let",
"description": "Specify the date picker input value",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "appendTo",
"kind": "let",
"description": "Specify the element to append the calendar to",
"type": "HTMLElement",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "dateFormat",
"kind": "let",
"description": "Specify the date format",
"type": "string",
"value": "\"m/d/Y\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "maxDate",
"kind": "let",
"description": "Specify the maximum date",
"type": "null | string | Date",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "minDate",
"kind": "let",
"description": "Specify the minimum date",
"type": "null | string | Date",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "locale",
"kind": "let",
"description": "Specify the locale",
"type": "string",
"value": "\"en\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "short",
"kind": "let",
"description": "Set to `true` to use the short variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "light",
"kind": "let",
"description": "Set to `true` to enable the light variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the date picker element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" },
{ "type": "dispatched", "name": "change" },
{ "type": "dispatched" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "DatePickerInput",
"filePath": "/src/DatePicker/DatePickerInput.svelte",
"props": [
{
"name": "size",
"kind": "let",
"description": "Set the size of the input",
"type": "\"sm\" | \"xl\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "type",
"kind": "let",
"description": "Specify the input type",
"type": "string",
"value": "\"text\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "placeholder",
"kind": "let",
"description": "Specify the input placeholder text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "pattern",
"kind": "let",
"description": "Specify the Regular Expression for the input value",
"type": "string",
"value": "\"\\\\d{1,2}\\\\/\\\\d{1,2}\\\\/\\\\d{4}\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "disabled",
"kind": "let",
"description": "Set to `true` to disable the input",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "iconDescription",
"kind": "let",
"description": "Specify the ARIA label for the calendar icon",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the input element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "labelText",
"kind": "let",
"description": "Specify the label text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "hideLabel",
"kind": "let",
"description": "Set to `true` to visually hide the label text",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "invalid",
"kind": "let",
"description": "Set to `true` to indicate an invalid state",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "invalidText",
"kind": "let",
"description": "Specify the invalid state text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "name",
"kind": "let",
"description": "Set a name for the input element",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the input HTML element",
"type": "null | HTMLInputElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [],
"events": [
{ "type": "forwarded", "name": "input", "element": "input" },
{ "type": "forwarded", "name": "keydown", "element": "input" },
{ "type": "forwarded", "name": "blur", "element": "input" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "DatePickerSkeleton",
"filePath": "/src/DatePicker/DatePickerSkeleton.svelte",
"props": [
{
"name": "range",
"kind": "let",
"description": "Set to `true` to use the range variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id to be used by the label element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "Dropdown",
"filePath": "/src/Dropdown/Dropdown.svelte",
"props": [
{
"name": "items",
"kind": "let",
"description": "Set the dropdown items",
"type": "DropdownItem[]",
"value": "[]",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "itemToString",
"kind": "let",
"description": "Override the display of a dropdown item",
"type": "(item: DropdownItem) => string",
"value": "(item) => item.text || item.id",
"isFunction": true,
"constant": false,
"reactive": false
},
{
"name": "selectedIndex",
"kind": "let",
"description": "Specify the selected item index",
"type": "number",
"value": "-1",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "type",
"kind": "let",
"description": "Specify the type of dropdown",
"type": "\"default\" | \"inline\"",
"value": "\"default\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "size",
"kind": "let",
"description": "Specify the size of the dropdown field",
"type": "\"sm\" | \"lg\" | \"xl\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "open",
"kind": "let",
"description": "Set to `true` to open the dropdown",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "inline",
"kind": "let",
"description": "Set to `true` to use the inline variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "light",
"kind": "let",
"description": "Set to `true` to enable the light variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "disabled",
"kind": "let",
"description": "Set to `true` to disable the dropdown",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "titleText",
"kind": "let",
"description": "Specify the title text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "invalid",
"kind": "let",
"description": "Set to `true` to indicate an invalid state",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "invalidText",
"kind": "let",
"description": "Specify the invalid state text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "helperText",
"kind": "let",
"description": "Specify the helper text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "label",
"kind": "let",
"description": "Specify the list box label",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "translateWithId",
"kind": "let",
"description": "Override the default translation ids",
"type": "(id: any) => string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the list box component",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "name",
"kind": "let",
"description": "Specify a name attribute for the list box",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the button HTML element",
"type": "null | HTMLButtonElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [],
"events": [
{
"type": "dispatched",
"name": "select",
"detail": "{ selectedId: DropdownItemId, selectedIndex: number, selectedItem: DropdownItem }"
}
],
"typedefs": [
{
"type": "string",
"name": "DropdownItemId",
"ts": "type DropdownItemId = string"
},
{
"type": "string",
"name": "DropdownItemText",
"ts": "type DropdownItemText = string"
},
{
"type": "{ id: DropdownItemId; text: DropdownItemText; }",
"name": "DropdownItem",
"ts": "interface DropdownItem { id: DropdownItemId; text: DropdownItemText; }"
}
],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "DropdownSkeleton",
"filePath": "/src/Dropdown/DropdownSkeleton.svelte",
"props": [
{
"name": "inline",
"kind": "let",
"description": "Set to `true` to use the inline variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "Loading",
"filePath": "/src/Loading/Loading.svelte",
"props": [
{
"name": "small",
"kind": "let",
"description": "Set to `true` to use the small variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "active",
"kind": "let",
"description": "Set to `false` to disable the active state",
"type": "boolean",
"value": "true",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "withOverlay",
"kind": "let",
"description": "Set to `false` to disable the overlay",
"type": "boolean",
"value": "true",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "description",
"kind": "let",
"description": "Specify the label description",
"type": "string",
"value": "\"Active loading indicator\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the label element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [],
"events": [],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "Filename",
"filePath": "/src/FileUploader/Filename.svelte",
"props": [
{
"name": "status",
"kind": "let",
"description": "Specify the file name status",
"type": "\"uploading\" | \"edit\" | \"complete\"",
"value": "\"uploading\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "iconDescription",
"kind": "let",
"description": "Specify the ARIA label used for the status icons",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "invalid",
"kind": "let",
"description": "Set to `true` to indicate an invalid state",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "Close16" },
{ "type": "forwarded", "name": "keydown", "element": "Close16" }
],
"typedefs": [],
"rest_props": { "type": "InlineComponent", "name": "Loading" }
},
{
"moduleName": "FileUploaderButton",
"filePath": "/src/FileUploader/FileUploaderButton.svelte",
"props": [
{
"name": "accept",
"kind": "let",
"description": "Specify the accepted file types",
"type": "Files",
"value": "[]",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "multiple",
"kind": "let",
"description": "Set to `true` to allow multiple files",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "disabled",
"kind": "let",
"description": "Set to `true` to disable the input",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "disableLabelChanges",
"kind": "let",
"description": "Set to `true` to disable label changes",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "kind",
"kind": "let",
"description": "Specify the kind of file uploader button",
"type": "\"primary\" | \"secondary\" | \"tertiary\" | \"ghost\" | \"danger\"",
"value": "\"primary\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "labelText",
"kind": "let",
"description": "Specify the label text",
"type": "string",
"value": "\"Add file\"",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "role",
"kind": "let",
"description": "Specify the label role",
"type": "string",
"value": "\"button\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "tabindex",
"kind": "let",
"description": "Specify `tabindex` attribute",
"type": "string",
"value": "\"0\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the input element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "name",
"kind": "let",
"description": "Specify a name attribute for the input",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the input HTML element",
"type": "null | HTMLInputElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [],
"events": [
{ "type": "forwarded", "name": "keydown", "element": "label" },
{ "type": "forwarded", "name": "change", "element": "input" },
{ "type": "forwarded", "name": "click", "element": "input" }
],
"typedefs": [
{ "type": "string[]", "name": "Files", "ts": "type Files = string[]" }
],
"rest_props": { "type": "Element", "name": "input" }
},
{
"moduleName": "FileUploader",
"filePath": "/src/FileUploader/FileUploader.svelte",
"props": [
{
"name": "status",
"kind": "let",
"description": "Specify the file uploader status",
"type": "\"uploading\" | \"edit\" | \"complete\"",
"value": "\"uploading\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "accept",
"kind": "let",
"description": "Specify the accepted file types",
"type": "Files",
"value": "[]",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "files",
"kind": "let",
"description": "Obtain the uploaded file names",
"type": "Files",
"value": "[]",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "multiple",
"kind": "let",
"description": "Set to `true` to allow multiple files",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "clearFiles",
"kind": "const",
"description": "Override the default behavior of clearing the array of uploaded files",
"type": "() => void",
"value": "() => { files = []; }",
"isFunction": true,
"constant": true,
"reactive": false
},
{
"name": "labelDescription",
"kind": "let",
"description": "Specify the label description",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "labelTitle",
"kind": "let",
"description": "Specify the label title",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "kind",
"kind": "let",
"description": "Specify the kind of file uploader button",
"type": "\"primary\" | \"secondary\" | \"tertiary\" | \"ghost\" | \"danger\"",
"value": "\"primary\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "buttonLabel",
"kind": "let",
"description": "Specify the button label",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "iconDescription",
"kind": "let",
"description": "Specify the ARIA label used for the status icons",
"type": "string",
"value": "\"Provide icon description\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "name",
"kind": "let",
"description": "Specify a name attribute for the file button uploader input",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [],
"events": [
{ "type": "dispatched", "name": "add", "detail": "Files" },
{ "type": "dispatched", "name": "remove", "detail": "Files" },
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" },
{
"type": "forwarded",
"name": "change",
"element": "FileUploaderButton"
},
{ "type": "forwarded", "name": "keydown", "element": "Filename" }
],
"typedefs": [
{ "type": "string[]", "name": "Files", "ts": "type Files = string[]" }
],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "FileUploaderItem",
"filePath": "/src/FileUploader/FileUploaderItem.svelte",
"props": [
{
"name": "status",
"kind": "let",
"description": "Specify the file uploader status",
"type": "\"uploading\" | \"edit\" | \"complete\"",
"value": "\"uploading\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "iconDescription",
"kind": "let",
"description": "Specify the ARIA label used for the status icons",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "invalid",
"kind": "let",
"description": "Set to `true` to indicate an invalid state",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "errorSubject",
"kind": "let",
"description": "Specify the error subject text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "errorBody",
"kind": "let",
"description": "Specify the error body text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the top-level element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "name",
"kind": "let",
"description": "Specify the file uploader name",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [],
"events": [
{ "type": "dispatched", "name": "delete", "detail": "string" },
{ "type": "forwarded", "name": "mouseover", "element": "span" },
{ "type": "forwarded", "name": "mouseenter", "element": "span" },
{ "type": "forwarded", "name": "mouseleave", "element": "span" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "span" }
},
{
"moduleName": "FileUploaderDropContainer",
"filePath": "/src/FileUploader/FileUploaderDropContainer.svelte",
"props": [
{
"name": "accept",
"kind": "let",
"description": "Specify the accepted file types",
"type": "Files",
"value": "[]",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "multiple",
"kind": "let",
"description": "Set to `true` to allow multiple files",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "validateFiles",
"kind": "let",
"description": "Override the default behavior of validating uploaded files\nThe default behavior does not validate files",
"type": "(files: Files) => Files",
"value": "(files) => files",
"isFunction": true,
"constant": false,
"reactive": false
},
{
"name": "labelText",
"kind": "let",
"description": "Specify the label text",
"type": "string",
"value": "\"Add file\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "role",
"kind": "let",
"description": "Specify the `role` attribute of the drop container",
"type": "string",
"value": "\"button\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "disabled",
"kind": "let",
"description": "Set to `true` to disable the input",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "tabindex",
"kind": "let",
"description": "Specify `tabindex` attribute",
"type": "string",
"value": "\"0\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the input element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "name",
"kind": "let",
"description": "Specify a name attribute for the input",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the input HTML element",
"type": "null | HTMLInputElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [],
"events": [
{ "type": "dispatched", "name": "add", "detail": "Files" },
{ "type": "forwarded", "name": "dragover", "element": "div" },
{ "type": "forwarded", "name": "dragleave", "element": "div" },
{ "type": "forwarded", "name": "drop", "element": "div" },
{ "type": "forwarded", "name": "keydown", "element": "label" },
{ "type": "forwarded", "name": "change", "element": "input" },
{ "type": "forwarded", "name": "click", "element": "input" }
],
"typedefs": [
{ "type": "string[]", "name": "Files", "ts": "type Files = string[]" }
],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "FileUploaderSkeleton",
"filePath": "/src/FileUploader/FileUploaderSkeleton.svelte",
"props": [],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "Form",
"filePath": "/src/Form/Form.svelte",
"props": [],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{ "type": "forwarded", "name": "click", "element": "form" },
{ "type": "forwarded", "name": "mouseover", "element": "form" },
{ "type": "forwarded", "name": "mouseenter", "element": "form" },
{ "type": "forwarded", "name": "mouseleave", "element": "form" },
{ "type": "forwarded", "name": "submit", "element": "form" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "form" }
},
{
"moduleName": "FluidForm",
"filePath": "/src/FluidForm/FluidForm.svelte",
"props": [],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [],
"typedefs": [],
"rest_props": { "type": "InlineComponent", "name": "Form" }
},
{
"moduleName": "FormGroup",
"filePath": "/src/FormGroup/FormGroup.svelte",
"props": [
{
"name": "invalid",
"kind": "let",
"description": "Set to `true` to indicate an invalid state",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "message",
"kind": "let",
"description": "Set to `true` to render a form requirement",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "messageText",
"kind": "let",
"description": "Specify the message text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "legendText",
"kind": "let",
"description": "Specify the legend text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{ "type": "forwarded", "name": "click", "element": "fieldset" },
{ "type": "forwarded", "name": "mouseover", "element": "fieldset" },
{ "type": "forwarded", "name": "mouseenter", "element": "fieldset" },
{ "type": "forwarded", "name": "mouseleave", "element": "fieldset" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "fieldset" }
},
{
"moduleName": "FormItem",
"filePath": "/src/FormItem/FormItem.svelte",
"props": [],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "FormLabel",
"filePath": "/src/FormLabel/FormLabel.svelte",
"props": [
{
"name": "id",
"kind": "let",
"description": "Set an id to be used by the label element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{ "type": "forwarded", "name": "click", "element": "label" },
{ "type": "forwarded", "name": "mouseover", "element": "label" },
{ "type": "forwarded", "name": "mouseenter", "element": "label" },
{ "type": "forwarded", "name": "mouseleave", "element": "label" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "label" }
},
{
"moduleName": "Grid",
"filePath": "/src/Grid/Grid.svelte",
"props": [
{
"name": "as",
"kind": "let",
"description": "Set to `true` to render a custom HTML element\nProps are destructured as `props` in the default slot (e.g. <Grid let:props><header {...props}>...</header></Grid>)",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "condensed",
"kind": "let",
"description": "Set to `true` to use the condensed variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "narrow",
"kind": "let",
"description": "Set to `true` to use the narrow variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "fullWidth",
"kind": "let",
"description": "Set to `true` to use the fullWidth variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "noGutter",
"kind": "let",
"description": "Set to `true` to remove the gutter",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "noGutterLeft",
"kind": "let",
"description": "Set to `true` to remove the left gutter",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "noGutterRight",
"kind": "let",
"description": "Set to `true` to remove the right gutter",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [
{
"name": "__default__",
"default": true,
"slot_props": "{ props?: { class: string; } }"
}
],
"events": [],
"typedefs": []
},
{
"moduleName": "Row",
"filePath": "/src/Grid/Row.svelte",
"props": [
{
"name": "as",
"kind": "let",
"description": "Set to `true` to render a custom HTML element\nProps are destructured as `props` in the default slot (e.g. <Row let:props><section {...props}>...</section></Row>)",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "condensed",
"kind": "let",
"description": "Set to `true` to use the condensed variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "narrow",
"kind": "let",
"description": "Set to `true` to use the narrow variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "noGutter",
"kind": "let",
"description": "Set to `true` to remove the gutter",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "noGutterLeft",
"kind": "let",
"description": "Set to `true` to remove the left gutter",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "noGutterRight",
"kind": "let",
"description": "Set to `true` to remove the right gutter",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [
{
"name": "__default__",
"default": true,
"slot_props": "{ props?: { class: string; [key: string]: any; } }"
}
],
"events": [],
"typedefs": []
},
{
"moduleName": "Column",
"filePath": "/src/Grid/Column.svelte",
"props": [
{
"name": "as",
"kind": "let",
"description": "Set to `true` to render a custom HTML element\nProps are destructured as `props` in the default slot (e.g. <Column let:props><article {...props}>...</article></Column>)",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "noGutter",
"kind": "let",
"description": "Set to `true` to remove the gutter",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "noGutterLeft",
"kind": "let",
"description": "Set to `true` to remove the left gutter",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "noGutterRight",
"kind": "let",
"description": "Set to `true` to remove the right gutter",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "aspectRatio",
"kind": "let",
"description": "Specify the aspect ratio of the column",
"type": "\"2x1\" | \"16x9\" | \"9x16\" | \"1x2\" | \"4x3\" | \"3x4\" | \"1x1\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "sm",
"kind": "let",
"description": "Set the small breakpoint",
"type": "ColumnBreakpoint",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "md",
"kind": "let",
"description": "Set the medium breakpoint",
"type": "ColumnBreakpoint",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "lg",
"kind": "let",
"description": "Set the large breakpoint",
"type": "ColumnBreakpoint",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "xlg",
"kind": "let",
"description": "Set the extra large breakpoint",
"type": "ColumnBreakpoint",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "max",
"kind": "let",
"description": "Set the maximum breakpoint",
"type": "ColumnBreakpoint",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [
{
"name": "__default__",
"default": true,
"slot_props": "{ props?: { class: string; } }"
}
],
"events": [],
"typedefs": [
{
"type": "boolean | number",
"name": "ColumnSize",
"ts": "type ColumnSize = boolean | number"
},
{
"type": "{span?: ColumnSize; offset: number;}",
"name": "ColumnSizeDescriptor",
"ts": "interface ColumnSizeDescriptor {span?: ColumnSize; offset: number;}"
},
{
"type": "ColumnSize | ColumnSizeDescriptor",
"name": "ColumnBreakpoint",
"ts": "type ColumnBreakpoint = ColumnSize | ColumnSizeDescriptor"
}
]
},
{
"moduleName": "IconSkeleton",
"filePath": "/src/Icon/IconSkeleton.svelte",
"props": [
{
"name": "size",
"kind": "let",
"description": "Set the size of the icon",
"type": "number",
"value": "16",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "Icon",
"filePath": "/src/Icon/Icon.svelte",
"props": [
{
"name": "render",
"kind": "let",
"description": "Specify the icon from `carbon-icons-svelte` to render\nIcon size must be 16px (e.g. `Add16`, `Task16`)",
"type": "import(\"carbon-icons-svelte\").CarbonIcon",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "skeleton",
"kind": "let",
"description": "Set to `true` to display the skeleton state",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "IconSkeleton" },
{ "type": "forwarded", "name": "mouseover", "element": "IconSkeleton" },
{
"type": "forwarded",
"name": "mouseenter",
"element": "IconSkeleton"
},
{ "type": "forwarded", "name": "mouseleave", "element": "IconSkeleton" }
],
"typedefs": [],
"rest_props": { "type": "InlineComponent", "name": "IconSkeleton" }
},
{
"moduleName": "InlineLoading",
"filePath": "/src/InlineLoading/InlineLoading.svelte",
"props": [
{
"name": "status",
"kind": "let",
"description": "Set the loading status",
"type": "\"active\" | \"inactive\" | \"finished\" | \"error\"",
"value": "\"active\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "description",
"kind": "let",
"description": "Set the loading description",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "iconDescription",
"kind": "let",
"description": "Specify the ARIA label for the loading icon",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "successDelay",
"kind": "let",
"description": "Specify the timeout delay (ms) after `status` is set to \"success\"",
"type": "number",
"value": "1500",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" },
{ "type": "dispatched", "name": "success" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "ListItem",
"filePath": "/src/ListItem/ListItem.svelte",
"props": [],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{ "type": "forwarded", "name": "click", "element": "li" },
{ "type": "forwarded", "name": "mouseover", "element": "li" },
{ "type": "forwarded", "name": "mouseenter", "element": "li" },
{ "type": "forwarded", "name": "mouseleave", "element": "li" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "li" }
},
{
"moduleName": "MultiSelect",
"filePath": "/src/MultiSelect/MultiSelect.svelte",
"props": [
{
"name": "items",
"kind": "let",
"description": "Set the multiselect items",
"type": "MultiSelectItem[]",
"value": "[]",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "itemToString",
"kind": "let",
"description": "Override the display of a multiselect item",
"type": "(item: MultiSelectItem) => string",
"value": "(item) => item.text || item.id",
"isFunction": true,
"constant": false,
"reactive": false
},
{
"name": "selectedIds",
"kind": "let",
"description": "Set the selected ids",
"type": "MultiSelectItemId[]",
"value": "[]",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "value",
"kind": "let",
"description": "Specify the multiselect value",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "size",
"kind": "let",
"description": "Set the size of the combobox",
"type": "\"sm\" | \"lg\" | \"xl\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "type",
"kind": "let",
"description": "Specify the type of multiselect",
"type": "\"default\" | \"inline\"",
"value": "\"default\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "selectionFeedback",
"kind": "let",
"description": "Specify the selection feedback after selecting items",
"type": "\"top\" | \"fixed\" | \"top-after-reopen\"",
"value": "\"top-after-reopen\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "disabled",
"kind": "let",
"description": "Set to `true` to disable the dropdown",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "filterable",
"kind": "let",
"description": "Set to `true` to filter items",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "filterItem",
"kind": "let",
"description": "Override the filtering logic\nThe default filtering is an exact string comparison",
"type": "(item: MultiSelectItem, value: string) => string",
"value": "(item, value) => item.text.toLowerCase().includes(value.toLowerCase())",
"isFunction": true,
"constant": false,
"reactive": false
},
{
"name": "open",
"kind": "let",
"description": "Set to `true` to open the dropdown",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "light",
"kind": "let",
"description": "Set to `true` to enable the light variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "locale",
"kind": "let",
"description": "Specify the locale",
"type": "string",
"value": "\"en\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "placeholder",
"kind": "let",
"description": "Specify the placeholder text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "sortItem",
"kind": "let",
"description": "Override the sorting logic\nThe default sorting compare the item text value",
"type": "(a: MultiSelectItem, b: MultiSelectItem) => MultiSelectItem",
"value": "(a, b) => a.text.localeCompare(b.text, locale, { numeric: true })",
"isFunction": true,
"constant": false,
"reactive": false
},
{
"name": "translateWithId",
"kind": "let",
"description": "Override the default translation ids",
"type": "(id: any) => string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "titleText",
"kind": "let",
"description": "Specify the title text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "useTitleInItem",
"kind": "let",
"description": "Set to `true` to pass the item to `itemToString` in the checkbox",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "invalid",
"kind": "let",
"description": "Set to `true` to indicate an invalid state",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "invalidText",
"kind": "let",
"description": "Specify the invalid state text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "helperText",
"kind": "let",
"description": "Specify the helper text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "label",
"kind": "let",
"description": "Specify the list box label",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the list box component",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "name",
"kind": "let",
"description": "Specify a name attribute for the select",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [],
"events": [
{ "type": "forwarded", "name": "clear", "element": "ListBoxSelection" },
{ "type": "forwarded", "name": "keydown", "element": "input" },
{ "type": "forwarded", "name": "focus", "element": "input" },
{ "type": "forwarded", "name": "blur", "element": "input" },
{ "type": "dispatched", "name": "select" }
],
"typedefs": [
{
"type": "string",
"name": "MultiSelectItemId",
"ts": "type MultiSelectItemId = string"
},
{
"type": "string",
"name": "MultiSelectItemText",
"ts": "type MultiSelectItemText = string"
},
{
"type": "{ id: MultiSelectItemId; text: MultiSelectItemText; }",
"name": "MultiSelectItem",
"ts": "interface MultiSelectItem { id: MultiSelectItemId; text: MultiSelectItemText; }"
}
],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "Modal",
"filePath": "/src/Modal/Modal.svelte",
"props": [
{
"name": "size",
"kind": "let",
"description": "Set the size of the modal",
"type": "\"xs\" | \"sm\" | \"lg\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "open",
"kind": "let",
"description": "Set to `true` to open the modal",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "danger",
"kind": "let",
"description": "Set to `true` to use the danger variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "alert",
"kind": "let",
"description": "Set to `true` to enable alert mode",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "passiveModal",
"kind": "let",
"description": "Set to `true` to use the passive variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "modalHeading",
"kind": "let",
"description": "Specify the modal heading",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "modalLabel",
"kind": "let",
"description": "Specify the modal label",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "modalAriaLabel",
"kind": "let",
"description": "Specify the ARIA label for the modal",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "iconDescription",
"kind": "let",
"description": "Specify the ARIA label for the close icon",
"type": "string",
"value": "\"Close the modal\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "hasForm",
"kind": "let",
"description": "Set to `true` if the modal contains form elements",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "hasScrollingContent",
"kind": "let",
"description": "Set to `true` if the modal contains scrolling content",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "primaryButtonText",
"kind": "let",
"description": "Specify the primary button text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "primaryButtonDisabled",
"kind": "let",
"description": "Set to `true` to disable the primary button",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "shouldSubmitOnEnter",
"kind": "let",
"description": "Set to `true` for the primary button to be triggered when pressing \"Enter\"",
"type": "boolean",
"value": "true",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "secondaryButtonText",
"kind": "let",
"description": "Specify the secondary button text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "selectorPrimaryFocus",
"kind": "let",
"description": "Specify a selector to be focused when opening the modal",
"type": "string",
"value": "\"[data-modal-primary-focus]\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "preventCloseOnClickOutside",
"kind": "let",
"description": "Set to `true` to prevent the modal from closing when clicking outside",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the top-level element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the top-level HTML element",
"type": "null | HTMLDivElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [
{ "name": "__default__", "default": true, "slot_props": "{}" },
{
"name": "heading",
"default": false,
"fallback": "{modalHeading}",
"slot_props": "{}"
},
{
"name": "label",
"default": false,
"fallback": "{modalLabel}",
"slot_props": "{}"
}
],
"events": [
{ "type": "forwarded", "name": "keydown", "element": "div" },
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" },
{ "type": "dispatched", "name": "submit" },
{ "type": "dispatched", "name": "click:button--secondary" },
{ "type": "dispatched", "name": "close" },
{ "type": "dispatched", "name": "open" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "NotificationButton",
"filePath": "/src/Notification/NotificationButton.svelte",
"props": [
{
"name": "notificationType",
"kind": "let",
"description": "Set the type of notification",
"type": "\"toast\" | \"inline\"",
"value": "\"toast\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "renderIcon",
"kind": "let",
"description": "Specify the icon from `carbon-icons-svelte` to render",
"type": "import(\"carbon-icons-svelte\").CarbonIcon",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "title",
"kind": "let",
"description": "Specify the title of the icon",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "iconDescription",
"kind": "let",
"description": "Specify the ARIA label for the icon",
"type": "string",
"value": "\"Close icon\"",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "button" },
{ "type": "forwarded", "name": "mouseover", "element": "button" },
{ "type": "forwarded", "name": "mouseenter", "element": "button" },
{ "type": "forwarded", "name": "mouseleave", "element": "button" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "button" }
},
{
"moduleName": "NotificationIcon",
"filePath": "/src/Notification/NotificationIcon.svelte",
"props": [
{
"name": "kind",
"kind": "let",
"description": "Specify the kind of notification icon",
"type": "\"error\" | \"info\" | \"info-square\" | \"success\" | \"warning\" | \"warning-alt\"",
"value": "\"error\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "notificationType",
"kind": "let",
"description": "Set the type of notification",
"type": "\"toast\" | \"inline\"",
"value": "\"toast\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "iconDescription",
"kind": "let",
"description": "Specify the ARIA label for the icon",
"type": "string",
"value": "\"Closes notification\"",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [],
"events": [],
"typedefs": []
},
{
"moduleName": "NotificationTextDetails",
"filePath": "/src/Notification/NotificationTextDetails.svelte",
"props": [
{
"name": "notificationType",
"kind": "let",
"description": "Set the type of notification",
"type": "\"toast\" | \"inline\"",
"value": "\"toast\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "title",
"kind": "let",
"description": "Specify the title text",
"type": "string",
"value": "\"Title\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "subtitle",
"kind": "let",
"description": "Specify the subtitle text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "caption",
"kind": "let",
"description": "Specify the caption text",
"type": "string",
"value": "\"Caption\"",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [],
"typedefs": []
},
{
"moduleName": "ToastNotification",
"filePath": "/src/Notification/ToastNotification.svelte",
"props": [
{
"name": "notificationType",
"kind": "let",
"description": "Set the type of notification",
"type": "\"toast\" | \"inline\"",
"value": "\"toast\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "kind",
"kind": "let",
"description": "Specify the kind of notification",
"type": "\"error\" | \"info\" | \"info-square\" | \"success\" | \"warning\" | \"warning-alt\"",
"value": "\"error\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "lowContrast",
"kind": "let",
"description": "Set to `true` to use the low contrast variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "timeout",
"kind": "let",
"description": "Set the timeout duration (ms) to hide the notification after opening it",
"type": "number",
"value": "0",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "role",
"kind": "let",
"description": "Set the `role` attribute",
"type": "string",
"value": "\"alert\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "title",
"kind": "let",
"description": "Specify the title text",
"type": "string",
"value": "\"Title\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "subtitle",
"kind": "let",
"description": "Specify the subtitle text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "caption",
"kind": "let",
"description": "Specify the caption text",
"type": "string",
"value": "\"Caption\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "iconDescription",
"kind": "let",
"description": "Specify the ARIA label for the icon",
"type": "string",
"value": "\"Closes notification\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "hideCloseButton",
"kind": "let",
"description": "Set to `true` to hide the close button",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" },
{ "type": "dispatched", "name": "close" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "InlineNotification",
"filePath": "/src/Notification/InlineNotification.svelte",
"props": [
{
"name": "notificationType",
"kind": "let",
"description": "Set the type of notification",
"type": "\"toast\" | \"inline\"",
"value": "\"inline\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "kind",
"kind": "let",
"description": "Specify the kind of notification",
"type": "\"error\" | \"info\" | \"info-square\" | \"success\" | \"warning\" | \"warning-alt\"",
"value": "\"error\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "lowContrast",
"kind": "let",
"description": "Set to `true` to use the low contrast variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "timeout",
"kind": "let",
"description": "Set the timeout duration (ms) to hide the notification after opening it",
"type": "number",
"value": "0",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "role",
"kind": "let",
"description": "Set the `role` attribute",
"type": "string",
"value": "\"alert\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "title",
"kind": "let",
"description": "Specify the title text",
"type": "string",
"value": "\"Title\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "subtitle",
"kind": "let",
"description": "Specify the subtitle text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "hideCloseButton",
"kind": "let",
"description": "Set to `true` to hide the close button",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "iconDescription",
"kind": "let",
"description": "Specify the ARIA label for the icon",
"type": "string",
"value": "\"Closes notification\"",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [
{ "name": "__default__", "default": true, "slot_props": "{}" },
{ "name": "actions", "default": false, "slot_props": "{}" }
],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" },
{ "type": "dispatched", "name": "close" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "NotificationActionButton",
"filePath": "/src/Notification/NotificationActionButton.svelte",
"props": [],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{ "type": "forwarded", "name": "click", "element": "Button" },
{ "type": "forwarded", "name": "mouseover", "element": "Button" },
{ "type": "forwarded", "name": "mouseenter", "element": "Button" },
{ "type": "forwarded", "name": "mouseleave", "element": "Button" }
],
"typedefs": [],
"rest_props": { "type": "InlineComponent", "name": "Button" }
},
{
"moduleName": "NumberInput",
"filePath": "/src/NumberInput/NumberInput.svelte",
"props": [
{
"name": "size",
"kind": "let",
"description": "Set the size of the input",
"type": "\"sm\" | \"xl\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "value",
"kind": "let",
"description": "Specify the input value",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "step",
"kind": "let",
"description": "Specify the step increment",
"type": "number",
"value": "1",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "max",
"kind": "let",
"description": "Specify the maximum value",
"type": "number",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "min",
"kind": "let",
"description": "Specify the minimum value",
"type": "number",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "light",
"kind": "let",
"description": "Set to `true` to enable the light variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "readonly",
"kind": "let",
"description": "Set to `true` for the input to be read-only",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "mobile",
"kind": "let",
"description": "Set to `true` to enable the mobile variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "allowEmpty",
"kind": "let",
"description": "Set to `true` to allow for an empty value",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "disabled",
"kind": "let",
"description": "Set to `true` to disable the input",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "iconDescription",
"kind": "let",
"description": "Specify the ARIA label for the increment icons",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "invalid",
"kind": "let",
"description": "Set to `true` to indicate an invalid state",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "invalidText",
"kind": "let",
"description": "Specify the invalid state text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "helperText",
"kind": "let",
"description": "Specify the helper text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "label",
"kind": "let",
"description": "Specify the label text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "hideLabel",
"kind": "let",
"description": "Set to `true` to visually hide the label text",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "translateWithId",
"kind": "let",
"description": "Override the default translation ids",
"type": "(id: NumberInputTranslationId) => string",
"value": "(id) => defaultTranslations[id]",
"isFunction": true,
"constant": false,
"reactive": false
},
{
"name": "translationIds",
"kind": "const",
"description": "Default translation ids",
"type": "{ increment: \"increment\"; decrement: \"decrement\" }",
"value": "{ increment: \"increment\", decrement: \"decrement\", }",
"isFunction": false,
"constant": true,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the input element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "name",
"kind": "let",
"description": "Specify a name attribute for the input",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the input HTML element",
"type": "null | HTMLInputElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [
{
"name": "label",
"default": false,
"fallback": "{label}",
"slot_props": "{}"
}
],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" },
{ "type": "forwarded", "name": "input", "element": "input" },
{ "type": "dispatched", "name": "change" }
],
"typedefs": [
{
"type": "\"increment\" | \"decrement\"",
"name": "NumberInputTranslationId",
"ts": "type NumberInputTranslationId = \"increment\" | \"decrement\""
}
],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "NumberInputSkeleton",
"filePath": "/src/NumberInput/NumberInputSkeleton.svelte",
"props": [
{
"name": "hideLabel",
"kind": "let",
"description": "Set to `true` to hide the label text",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "OrderedList",
"filePath": "/src/OrderedList/OrderedList.svelte",
"props": [
{
"name": "nested",
"kind": "let",
"description": "Set to `true` to use the nested variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "native",
"kind": "let",
"description": "Set to `true` to use native list styles",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{ "type": "forwarded", "name": "click", "element": "ol" },
{ "type": "forwarded", "name": "mouseover", "element": "ol" },
{ "type": "forwarded", "name": "mouseenter", "element": "ol" },
{ "type": "forwarded", "name": "mouseleave", "element": "ol" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "ol" }
},
{
"moduleName": "Select",
"filePath": "/src/Select/Select.svelte",
"props": [
{
"name": "selected",
"kind": "let",
"description": "Specify the selected item value",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "size",
"kind": "let",
"description": "Set the size of the select input",
"type": "\"sm\" | \"xl\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "inline",
"kind": "let",
"description": "Set to `true` to use the inline variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "light",
"kind": "let",
"description": "Set to `true` to enable the light variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "disabled",
"kind": "let",
"description": "Set to `true` to disable the select element",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the select element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "name",
"kind": "let",
"description": "Specify a name attribute for the select element",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "invalid",
"kind": "let",
"description": "Set to `true` to indicate an invalid state",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "invalidText",
"kind": "let",
"description": "Specify the invalid state text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "helperText",
"kind": "let",
"description": "Specify the helper text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "noLabel",
"kind": "let",
"description": "Set to `true` to not render a label",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "labelText",
"kind": "let",
"description": "Specify the label text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "hideLabel",
"kind": "let",
"description": "Set to `true` to visually hide the label text",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the select HTML element",
"type": "null | HTMLSelectElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{ "type": "forwarded", "name": "blur", "element": "select" },
{ "type": "dispatched", "name": "change" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "SelectSkeleton",
"filePath": "/src/Select/SelectSkeleton.svelte",
"props": [
{
"name": "hideLabel",
"kind": "let",
"description": "Set to `true` to hide the label text",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "SelectItem",
"filePath": "/src/Select/SelectItem.svelte",
"props": [
{
"name": "value",
"kind": "let",
"description": "Specify the option value",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "text",
"kind": "let",
"description": "Specify the option text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "hidden",
"kind": "let",
"description": "Set to `true` to hide the option",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "disabled",
"kind": "let",
"description": "Set to `true` to disable the option",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [],
"events": [],
"typedefs": []
},
{
"moduleName": "SelectItemGroup",
"filePath": "/src/Select/SelectItemGroup.svelte",
"props": [
{
"name": "disabled",
"kind": "let",
"description": "Set to `true` to disable the optgroup element",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "label",
"kind": "let",
"description": "Specify the label attribute of the optgroup element",
"type": "string",
"value": "\"Provide label\"",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [],
"typedefs": [],
"rest_props": { "type": "Element", "name": "optgroup" }
},
{
"moduleName": "Pagination",
"filePath": "/src/Pagination/Pagination.svelte",
"props": [
{
"name": "page",
"kind": "let",
"description": "Specify the current page index",
"type": "number",
"value": "1",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "totalItems",
"kind": "let",
"description": "Specify the total number of items",
"type": "number",
"value": "0",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "disabled",
"kind": "let",
"description": "Set to `true` to disable the pagination",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "forwardText",
"kind": "let",
"description": "Specify the forward button text",
"type": "string",
"value": "\"Next page\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "backwardText",
"kind": "let",
"description": "Specify the backward button text",
"type": "string",
"value": "\"Previous page\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "itemsPerPageText",
"kind": "let",
"description": "Specify the items per page text",
"type": "string",
"value": "\"Items per page:\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "itemText",
"kind": "let",
"description": "Override the item text",
"type": "(min: number, max: number) => string",
"value": "(min, max) => `${min}–${max} items`",
"isFunction": true,
"constant": false,
"reactive": false
},
{
"name": "itemRangeText",
"kind": "let",
"description": "Override the item range text",
"type": "(min: number, max: number, total: number) => string",
"value": "(min, max, total) => `${min}–${max} of ${total} items`",
"isFunction": true,
"constant": false,
"reactive": false
},
{
"name": "pageInputDisabled",
"kind": "let",
"description": "Set to `true` to disable the page input",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "pageSizeInputDisabled",
"kind": "let",
"description": "Set to `true` to disable the page size input",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "pageSize",
"kind": "let",
"description": "Specify the number of items to display in a page",
"type": "number",
"value": "10",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "pageSizes",
"kind": "let",
"description": "Specify the available page sizes",
"type": "number[]",
"value": "[10]",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "pagesUnknown",
"kind": "let",
"description": "Set to `true` if the number of pages is unknown",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "pageText",
"kind": "let",
"description": "Override the page text",
"type": "(page: number) => string",
"value": "(page) => `page ${page}`",
"isFunction": true,
"constant": false,
"reactive": false
},
{
"name": "pageRangeText",
"kind": "let",
"description": "Override the page range text",
"type": "(current: number, total: number) => string",
"value": "(current, total) => `of ${total} page${total === 1 ? \"\" : \"s\"}`",
"isFunction": true,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the top-level element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [],
"events": [{ "type": "dispatched", "name": "update" }],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "PaginationSkeleton",
"filePath": "/src/Pagination/PaginationSkeleton.svelte",
"props": [],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "PaginationNav",
"filePath": "/src/PaginationNav/PaginationNav.svelte",
"props": [
{
"name": "page",
"kind": "let",
"description": "Specify the current page index",
"type": "number",
"value": "0",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "total",
"kind": "let",
"description": "Specify the total number of pages",
"type": "number",
"value": "10",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "shown",
"kind": "let",
"description": "Specify the total number of pages to show",
"type": "number",
"value": "10",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "loop",
"kind": "let",
"description": "Set to `true` to loop the navigation",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "forwardText",
"kind": "let",
"description": "Specify the forward button text",
"type": "string",
"value": "\"Next page\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "backwardText",
"kind": "let",
"description": "Specify the backward button text",
"type": "string",
"value": "\"Previous page\"",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [],
"events": [
{ "type": "dispatched", "name": "click:button--previous" },
{ "type": "dispatched", "name": "click:button--next" },
{ "type": "dispatched", "name": "change" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "nav" }
},
{
"moduleName": "ProgressIndicator",
"filePath": "/src/ProgressIndicator/ProgressIndicator.svelte",
"props": [
{
"name": "currentIndex",
"kind": "let",
"description": "Specify the current step index",
"type": "number",
"value": "0",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "vertical",
"kind": "let",
"description": "Set to `true` to use the vertical variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "spaceEqually",
"kind": "let",
"description": "Set to `true` to specify whether the progress steps should be split equally in size in the div",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "preventChangeOnClick",
"kind": "let",
"description": "Set to `true` to prevent updating `currentIndex`",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{ "type": "forwarded", "name": "click", "element": "ul" },
{ "type": "forwarded", "name": "mouseover", "element": "ul" },
{ "type": "forwarded", "name": "mouseenter", "element": "ul" },
{ "type": "forwarded", "name": "mouseleave", "element": "ul" },
{ "type": "dispatched", "name": "change" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "ul" }
},
{
"moduleName": "ProgressIndicatorSkeleton",
"filePath": "/src/ProgressIndicator/ProgressIndicatorSkeleton.svelte",
"props": [
{
"name": "vertical",
"kind": "let",
"description": "Set to `true` to use the vertical variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "count",
"kind": "let",
"description": "Specify the number of steps to render",
"type": "number",
"value": "4",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "ul" },
{ "type": "forwarded", "name": "mouseover", "element": "ul" },
{ "type": "forwarded", "name": "mouseenter", "element": "ul" },
{ "type": "forwarded", "name": "mouseleave", "element": "ul" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "ul" }
},
{
"moduleName": "ProgressStep",
"filePath": "/src/ProgressIndicator/ProgressStep.svelte",
"props": [
{
"name": "complete",
"kind": "let",
"description": "Set to `true` for the complete variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "current",
"kind": "let",
"description": "Set to `true` to use the current variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "disabled",
"kind": "let",
"description": "Set to `true` to disable the progress step",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "invalid",
"kind": "let",
"description": "Set to `true` to indicate an invalid state",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "description",
"kind": "let",
"description": "Specify the step description",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "label",
"kind": "let",
"description": "Specify the step label",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "secondaryLabel",
"kind": "let",
"description": "Specify the step secondary label",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the top-level element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [
{
"name": "__default__",
"default": true,
"fallback": "<p class:bx--progress-label=\"{true}\">{label}</p>",
"slot_props": "{ props: { class: 'bx--progress-label' } }"
}
],
"events": [
{ "type": "forwarded", "name": "click", "element": "button" },
{ "type": "forwarded", "name": "mouseover", "element": "button" },
{ "type": "forwarded", "name": "mouseenter", "element": "button" },
{ "type": "forwarded", "name": "mouseleave", "element": "button" },
{ "type": "forwarded", "name": "keydown", "element": "button" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "li" }
},
{
"moduleName": "RadioButtonGroup",
"filePath": "/src/RadioButtonGroup/RadioButtonGroup.svelte",
"props": [
{
"name": "selected",
"kind": "let",
"description": "Set the selected radio button value",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "disabled",
"kind": "let",
"description": "Set to `true` to disable the radio buttons",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "labelPosition",
"kind": "let",
"description": "Specify the label position",
"type": "\"right\" | \"left\"",
"value": "\"right\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "orientation",
"kind": "let",
"description": "Specify the orientation of the radio buttons",
"type": "\"horizontal\" | \"vertical\"",
"value": "\"horizontal\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the container div element",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" },
{ "type": "dispatched", "name": "change" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "SkeletonPlaceholder",
"filePath": "/src/SkeletonPlaceholder/SkeletonPlaceholder.svelte",
"props": [],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "Slider",
"filePath": "/src/Slider/Slider.svelte",
"props": [
{
"name": "value",
"kind": "let",
"description": "Specify the value of the slider",
"type": "number",
"value": "0",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "max",
"kind": "let",
"description": "Set the maximum slider value",
"type": "number",
"value": "100",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "maxLabel",
"kind": "let",
"description": "Specify the label for the max value",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "min",
"kind": "let",
"description": "Set the minimum slider value",
"type": "number",
"value": "0",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "minLabel",
"kind": "let",
"description": "Specify the label for the min value",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "step",
"kind": "let",
"description": "Set the step value",
"type": "number",
"value": "1",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "stepMultiplier",
"kind": "let",
"description": "Set the step multiplier value",
"type": "number",
"value": "4",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "required",
"kind": "let",
"description": "Set to `true` to require a value",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "inputType",
"kind": "let",
"description": "Specify the input type",
"type": "string",
"value": "\"number\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "disabled",
"kind": "let",
"description": "Set to `true` to disable the slider",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "light",
"kind": "let",
"description": "Set to `true` to enable the light variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "hideTextInput",
"kind": "let",
"description": "Set to `true` to hide the text input",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the slider div element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "invalid",
"kind": "let",
"description": "Set to `true` to indicate an invalid state",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "labelText",
"kind": "let",
"description": "Specify the label text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "name",
"kind": "let",
"description": "Set a name for the slider element",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the HTML element",
"type": "null | HTMLDivElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" },
{ "type": "dispatched", "name": "change" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "SliderSkeleton",
"filePath": "/src/Slider/SliderSkeleton.svelte",
"props": [
{
"name": "hideLabel",
"kind": "let",
"description": "Set to `true` to hide the label text",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "StructuredList",
"filePath": "/src/StructuredList/StructuredList.svelte",
"props": [
{
"name": "selected",
"kind": "let",
"description": "Specify the selected structured list row value",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "border",
"kind": "let",
"description": "Set to `true` to use the bordered variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "selection",
"kind": "let",
"description": "Set to `true` to use the selection variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" },
{ "type": "dispatched", "name": "change" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "StructuredListSkeleton",
"filePath": "/src/StructuredList/StructuredListSkeleton.svelte",
"props": [
{
"name": "rows",
"kind": "let",
"description": "Specify the number of rows",
"type": "number",
"value": "5",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "border",
"kind": "let",
"description": "Set to `true` to use the bordered variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "StructuredListBody",
"filePath": "/src/StructuredList/StructuredListBody.svelte",
"props": [],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "StructuredListHead",
"filePath": "/src/StructuredList/StructuredListHead.svelte",
"props": [],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "StructuredListCell",
"filePath": "/src/StructuredList/StructuredListCell.svelte",
"props": [
{
"name": "head",
"kind": "let",
"description": "Set to `true` to use as a header",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "noWrap",
"kind": "let",
"description": "Set to `true` to prevent wrapping",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "StructuredListRow",
"filePath": "/src/StructuredList/StructuredListRow.svelte",
"props": [
{
"name": "head",
"kind": "let",
"description": "Set to `true` to use as a header",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "label",
"kind": "let",
"description": "Set to `true` to render a label slot",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "tabindex",
"kind": "let",
"description": "Specify the tabindex",
"type": "string",
"value": "\"0\"",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{ "type": "forwarded", "name": "click", "element": "label" },
{ "type": "forwarded", "name": "mouseover", "element": "label" },
{ "type": "forwarded", "name": "mouseenter", "element": "label" },
{ "type": "forwarded", "name": "mouseleave", "element": "label" },
{ "type": "forwarded", "name": "keydown", "element": "label" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "label" }
},
{
"moduleName": "StructuredListInput",
"filePath": "/src/StructuredList/StructuredListInput.svelte",
"props": [
{
"name": "checked",
"kind": "let",
"description": "Set to `true` to check the input",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "title",
"kind": "let",
"description": "Specify the title of the input",
"type": "string",
"value": "\"title\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "value",
"kind": "let",
"description": "Specify the value of the input",
"type": "string",
"value": "\"value\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the input element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "name",
"kind": "let",
"description": "Specify a name attribute for the input",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the input HTML element",
"type": "null | HTMLInputElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [],
"events": [],
"typedefs": [],
"rest_props": { "type": "Element", "name": "input" }
},
{
"moduleName": "Tabs",
"filePath": "/src/Tabs/Tabs.svelte",
"props": [
{
"name": "selected",
"kind": "let",
"description": "Specify the selected tab index",
"type": "number",
"value": "0",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "type",
"kind": "let",
"description": "Specify the type of tabs",
"type": "\"default\" | \"container\"",
"value": "\"default\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "iconDescription",
"kind": "let",
"description": "Specify the ARIA label for the chevron icon",
"type": "string",
"value": "\"Show menu options\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "triggerHref",
"kind": "let",
"description": "Specify the tab trigger href attribute",
"type": "string",
"value": "\"#\"",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [
{ "name": "__default__", "default": true, "slot_props": "{}" },
{ "name": "content", "default": false, "slot_props": "{}" }
],
"events": [
{ "type": "forwarded", "name": "keypress", "element": "div" },
{ "type": "forwarded", "name": "click", "element": "a" },
{ "type": "dispatched", "name": "change" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "Tab",
"filePath": "/src/Tabs/Tab.svelte",
"props": [
{
"name": "label",
"kind": "let",
"description": "Specify the tab label\nAlternatively, use the default slot (e.g. <Tab><span>Label</span></Tab>)",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "href",
"kind": "let",
"description": "Specify the href attribute",
"type": "string",
"value": "\"#\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "disabled",
"kind": "let",
"description": "Set to `true` to disable the tab",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "tabindex",
"kind": "let",
"description": "Specify the tabindex",
"type": "string",
"value": "\"0\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the top-level element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the anchor HTML element",
"type": "null | HTMLAnchorElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [
{
"name": "__default__",
"default": true,
"fallback": "{label}",
"slot_props": "{}"
}
],
"events": [
{ "type": "forwarded", "name": "mouseover", "element": "li" },
{ "type": "forwarded", "name": "mouseenter", "element": "li" },
{ "type": "forwarded", "name": "mouseleave", "element": "li" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "li" }
},
{
"moduleName": "TabContent",
"filePath": "/src/Tabs/TabContent.svelte",
"props": [
{
"name": "id",
"kind": "let",
"description": "Set an id for the top-level element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "TabsSkeleton",
"filePath": "/src/Tabs/TabsSkeleton.svelte",
"props": [
{
"name": "count",
"kind": "let",
"description": "Specify the number of tabs to render",
"type": "number",
"value": "4",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "TagSkeleton",
"filePath": "/src/Tag/TagSkeleton.svelte",
"props": [],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "span" },
{ "type": "forwarded", "name": "mouseover", "element": "span" },
{ "type": "forwarded", "name": "mouseenter", "element": "span" },
{ "type": "forwarded", "name": "mouseleave", "element": "span" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "span" }
},
{
"moduleName": "Tag",
"filePath": "/src/Tag/Tag.svelte",
"props": [
{
"name": "type",
"kind": "let",
"description": "Specify the type of tag",
"type": "\"red\" | \"magenta\" | \"purple\" | \"blue\" | \"cyan\" | \"teal\" | \"green\" | \"gray\" | \"cool-gray\" | \"warm-gray\" | \"high-contrast\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "filter",
"kind": "let",
"description": "Set to `true` to use filterable variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "disabled",
"kind": "let",
"description": "Set to `true` to disable a filterable tag",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "skeleton",
"kind": "let",
"description": "Set to `true` to display the skeleton state",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "title",
"kind": "let",
"description": "Set the title for the close button in a filterable tag",
"type": "string",
"value": "\"Clear filter\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the filterable tag",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [
{
"name": "__default__",
"default": true,
"slot_props": "{ props: { class: 'bx--tag__label' } }"
}
],
"events": [
{ "type": "forwarded", "name": "click", "element": "TagSkeleton" },
{ "type": "forwarded", "name": "mouseover", "element": "TagSkeleton" },
{ "type": "forwarded", "name": "mouseenter", "element": "TagSkeleton" },
{ "type": "forwarded", "name": "mouseleave", "element": "TagSkeleton" }
],
"typedefs": [],
"rest_props": { "type": "InlineComponent", "name": "TagSkeleton" }
},
{
"moduleName": "TextArea",
"filePath": "/src/TextArea/TextArea.svelte",
"props": [
{
"name": "value",
"kind": "let",
"description": "Specify the textarea value",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "placeholder",
"kind": "let",
"description": "Specify the placeholder text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "cols",
"kind": "let",
"description": "Specify the number of cols",
"type": "number",
"value": "50",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "rows",
"kind": "let",
"description": "Specify the number of rows",
"type": "number",
"value": "4",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "light",
"kind": "let",
"description": "Set to `true` to enable the light variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "disabled",
"kind": "let",
"description": "Set to `true` to disable the input",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "helperText",
"kind": "let",
"description": "Specify the helper text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "labelText",
"kind": "let",
"description": "Specify the label text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "hideLabel",
"kind": "let",
"description": "Set to `true` to visually hide the label text",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "invalid",
"kind": "let",
"description": "Set to `true` to indicate an invalid state",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "invalidText",
"kind": "let",
"description": "Specify the text for the invalid state",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the textarea element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "name",
"kind": "let",
"description": "Specify a name attribute for the input",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the textarea HTML element",
"type": "null | HTMLTextAreaElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" },
{ "type": "forwarded", "name": "change", "element": "textarea" },
{ "type": "forwarded", "name": "input", "element": "textarea" },
{ "type": "forwarded", "name": "focus", "element": "textarea" },
{ "type": "forwarded", "name": "blur", "element": "textarea" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "textarea" }
},
{
"moduleName": "TextAreaSkeleton",
"filePath": "/src/TextArea/TextAreaSkeleton.svelte",
"props": [
{
"name": "hideLabel",
"kind": "let",
"description": "Set to `true` to visually hide the label text",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "TextInput",
"filePath": "/src/TextInput/TextInput.svelte",
"props": [
{
"name": "size",
"kind": "let",
"description": "Set the size of the input",
"type": "\"sm\" | \"xl\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "value",
"kind": "let",
"description": "Specify the input value",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "type",
"kind": "let",
"description": "Specify the input type",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "placeholder",
"kind": "let",
"description": "Specify the placeholder text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "light",
"kind": "let",
"description": "Set to `true` to enable the light variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "disabled",
"kind": "let",
"description": "Set to `true` to disable the input",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "helperText",
"kind": "let",
"description": "Specify the helper text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the input element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "name",
"kind": "let",
"description": "Specify a name attribute for the input",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "labelText",
"kind": "let",
"description": "Specify the label text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "hideLabel",
"kind": "let",
"description": "Set to `true` to visually hide the label text",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "invalid",
"kind": "let",
"description": "Set to `true` to indicate an invalid state",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "invalidText",
"kind": "let",
"description": "Specify the invalid state text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "warn",
"kind": "let",
"description": "Set to `true` to indicate an warning state",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "warnText",
"kind": "let",
"description": "Specify the warning state text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the input HTML element",
"type": "null | HTMLInputElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "required",
"kind": "let",
"description": "Set to `true` to mark the field as required",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "inline",
"kind": "let",
"description": "Set to `true` to use inline version",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" },
{ "type": "forwarded", "name": "change", "element": "input" },
{ "type": "forwarded", "name": "input", "element": "input" },
{ "type": "forwarded", "name": "keydown", "element": "input" },
{ "type": "forwarded", "name": "focus", "element": "input" },
{ "type": "forwarded", "name": "blur", "element": "input" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "TextInputSkeleton",
"filePath": "/src/TextInput/TextInputSkeleton.svelte",
"props": [
{
"name": "hideLabel",
"kind": "let",
"description": "Set to `true` to hide the label text",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "PasswordInput",
"filePath": "/src/TextInput/PasswordInput.svelte",
"props": [
{
"name": "size",
"kind": "let",
"description": "Set the size of the input",
"type": "\"sm\" | \"xl\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "value",
"kind": "let",
"description": "Specify the input value",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "type",
"kind": "let",
"description": "Specify the input type",
"type": "string",
"value": "\"password\"",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "placeholder",
"kind": "let",
"description": "Specify the placeholder text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "hidePasswordLabel",
"kind": "let",
"description": "Specify the hide password label text",
"type": "string",
"value": "\"Hide password\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "showPasswordLabel",
"kind": "let",
"description": "Specify the show password label text",
"type": "string",
"value": "\"Show password\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "tooltipAlignment",
"kind": "let",
"description": "Set the alignment of the tooltip relative to the icon",
"type": "\"start\" | \"center\" | \"end\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "tooltipPosition",
"kind": "let",
"description": "Set the position of the tooltip relative to the icon",
"type": "\"top\" | \"right\" | \"bottom\" | \"left\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "light",
"kind": "let",
"description": "Set to `true` to enable the light variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "disabled",
"kind": "let",
"description": "Set to `true` to disable the input",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "helperText",
"kind": "let",
"description": "Specify the helper text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "labelText",
"kind": "let",
"description": "Specify the label text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "hideLabel",
"kind": "let",
"description": "Set to `true` to visually hide the label text",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "invalid",
"kind": "let",
"description": "Set to `true` to indicate an invalid state",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "invalidText",
"kind": "let",
"description": "Specify the text for the invalid state",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the input element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "name",
"kind": "let",
"description": "Specify a name attribute for the input",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the input HTML element",
"type": "null | HTMLInputElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" },
{ "type": "forwarded", "name": "change", "element": "input" },
{ "type": "forwarded", "name": "input", "element": "input" },
{ "type": "forwarded", "name": "keydown", "element": "input" },
{ "type": "forwarded", "name": "focus", "element": "input" },
{ "type": "forwarded", "name": "blur", "element": "input" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "Tile",
"filePath": "/src/Tile/Tile.svelte",
"props": [
{
"name": "light",
"kind": "let",
"description": "Set to `true` to enable the light variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "ClickableTile",
"filePath": "/src/Tile/ClickableTile.svelte",
"props": [
{
"name": "clicked",
"kind": "let",
"description": "Set to `true` to click the tile",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "light",
"kind": "let",
"description": "Set to `true` to enable the light variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "href",
"kind": "let",
"description": "Set the `href`",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{ "type": "forwarded", "name": "click", "element": "a" },
{ "type": "forwarded", "name": "keydown", "element": "a" },
{ "type": "forwarded", "name": "mouseover", "element": "a" },
{ "type": "forwarded", "name": "mouseenter", "element": "a" },
{ "type": "forwarded", "name": "mouseleave", "element": "a" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "a" }
},
{
"moduleName": "ExpandableTile",
"filePath": "/src/Tile/ExpandableTile.svelte",
"props": [
{
"name": "expanded",
"kind": "let",
"description": "Set to `true` to expand the tile",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "light",
"kind": "let",
"description": "Set to `true` to enable the light variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "tileMaxHeight",
"kind": "let",
"description": "Specify the max height of the tile (number of pixels)",
"type": "number",
"value": "0",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "tilePadding",
"kind": "let",
"description": "Specify the padding of the tile (number of pixels)",
"type": "number",
"value": "0",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "tileCollapsedIconText",
"kind": "let",
"description": "Specify the icon text of the collapsed tile",
"type": "string",
"value": "\"Interact to expand Tile\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "tileExpandedIconText",
"kind": "let",
"description": "Specify the icon text of the expanded tile",
"type": "string",
"value": "\"Interact to collapse Tile\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "tabindex",
"kind": "let",
"description": "Specify the tabindex",
"type": "string",
"value": "\"0\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the top-level div element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the top-level element",
"type": "null | HTMLDivElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [
{ "name": "above", "default": false, "slot_props": "{}" },
{ "name": "below", "default": false, "slot_props": "{}" }
],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "keypress", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "SelectableTile",
"filePath": "/src/Tile/SelectableTile.svelte",
"props": [
{
"name": "selected",
"kind": "let",
"description": "Set to `true` to select the tile",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "light",
"kind": "let",
"description": "Set to `true` to enable the light variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "title",
"kind": "let",
"description": "Specify the title of the selectable tile",
"type": "string",
"value": "\"title\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "value",
"kind": "let",
"description": "Specify the value of the selectable tile",
"type": "string",
"value": "\"value\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "tabindex",
"kind": "let",
"description": "Specify the tabindex",
"type": "string",
"value": "\"0\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "iconDescription",
"kind": "let",
"description": "Specify the ARIA label for the selectable tile checkmark icon",
"type": "string",
"value": "\"Tile checkmark\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the input element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "name",
"kind": "let",
"description": "Specify a name attribute for the input",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the input HTML element",
"type": "null | HTMLInputElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{ "type": "forwarded", "name": "click", "element": "label" },
{ "type": "forwarded", "name": "mouseover", "element": "label" },
{ "type": "forwarded", "name": "mouseenter", "element": "label" },
{ "type": "forwarded", "name": "mouseleave", "element": "label" },
{ "type": "forwarded", "name": "keydown", "element": "label" },
{ "type": "dispatched" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "label" }
},
{
"moduleName": "RadioTile",
"filePath": "/src/Tile/RadioTile.svelte",
"props": [
{
"name": "checked",
"kind": "let",
"description": "Set to `true` to check the tile",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "light",
"kind": "let",
"description": "Set to `true` to enable the light variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "value",
"kind": "let",
"description": "Specify the value of the radio input",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "tabindex",
"kind": "let",
"description": "Specify the tabindex",
"type": "string",
"value": "\"0\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "iconDescription",
"kind": "let",
"description": "Specify the ARIA label for the radio tile checkmark icon",
"type": "string",
"value": "\"Tile checkmark\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the input element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "name",
"kind": "let",
"description": "Specify a name attribute for the input",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{ "type": "forwarded", "name": "change", "element": "input" },
{ "type": "forwarded", "name": "keydown", "element": "input" },
{ "type": "forwarded", "name": "click", "element": "label" },
{ "type": "forwarded", "name": "mouseover", "element": "label" },
{ "type": "forwarded", "name": "mouseenter", "element": "label" },
{ "type": "forwarded", "name": "mouseleave", "element": "label" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "label" }
},
{
"moduleName": "TileGroup",
"filePath": "/src/Tile/TileGroup.svelte",
"props": [
{
"name": "selected",
"kind": "let",
"description": "Specify the selected tile value",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "disabled",
"kind": "let",
"description": "Set to `true` to disable the tile group",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "legend",
"kind": "let",
"description": "Specify the legend text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [{ "type": "dispatched", "name": "select" }],
"typedefs": [],
"rest_props": { "type": "Element", "name": "fieldset" }
},
{
"moduleName": "TimePicker",
"filePath": "/src/TimePicker/TimePicker.svelte",
"props": [
{
"name": "size",
"kind": "let",
"description": "Specify the size of the input",
"type": "\"sm\" | \"xl\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "value",
"kind": "let",
"description": "Specify the input value",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "type",
"kind": "let",
"description": "Specify the input type",
"type": "string",
"value": "\"text\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "placeholder",
"kind": "let",
"description": "Specify the input placeholder text",
"type": "string",
"value": "\"hh=mm\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "pattern",
"kind": "let",
"description": "Specify the `pattern` attribute for the input element",
"type": "string",
"value": "\"(1[012]|[1-9]):[0-5][0-9](\\\\s)?\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "maxlength",
"kind": "let",
"description": "Specify the `maxlength` input attribute",
"type": "number",
"value": "5",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "light",
"kind": "let",
"description": "Set to `true` to enable the light variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "disabled",
"kind": "let",
"description": "Set to `true` to disable the input",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "labelText",
"kind": "let",
"description": "Specify the label text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "hideLabel",
"kind": "let",
"description": "Set to `true` to visually hide the label text",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "invalid",
"kind": "let",
"description": "Set to `true` to indicate an invalid state",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "invalidText",
"kind": "let",
"description": "Specify the invalid state text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the input element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "name",
"kind": "let",
"description": "Specify a name attribute for the input",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the input HTML element",
"type": "null | HTMLInputElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" },
{ "type": "forwarded", "name": "change", "element": "input" },
{ "type": "forwarded", "name": "input", "element": "input" },
{ "type": "forwarded", "name": "focus", "element": "input" },
{ "type": "forwarded", "name": "blur", "element": "input" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "TimePickerSelect",
"filePath": "/src/TimePicker/TimePickerSelect.svelte",
"props": [
{
"name": "value",
"kind": "let",
"description": "Specify the select value",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "disabled",
"kind": "let",
"description": "Set to `true` to disable the select",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "iconDescription",
"kind": "let",
"description": "Specify the ARIA label for the chevron icon",
"type": "string",
"value": "\"Open list of options\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "labelText",
"kind": "let",
"description": "Specify the label text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "hideLabel",
"kind": "let",
"type": "boolean",
"value": "true",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the select element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "name",
"kind": "let",
"description": "Specify a name attribute for the select element",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the select HTML element",
"type": "null | HTMLSelectElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "Toggle",
"filePath": "/src/Toggle/Toggle.svelte",
"props": [
{
"name": "toggled",
"kind": "let",
"description": "Set to `true` to toggle the checkbox input",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "disabled",
"kind": "let",
"description": "Set to `true` to disable checkbox input",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "labelA",
"kind": "let",
"description": "Specify the label for the untoggled state",
"type": "string",
"value": "\"Off\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "labelB",
"kind": "let",
"description": "Specify the label for the toggled state",
"type": "string",
"value": "\"On\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "labelText",
"kind": "let",
"description": "Specify the label text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the input element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "name",
"kind": "let",
"description": "Specify a name attribute for the checkbox input",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" },
{ "type": "forwarded", "name": "change", "element": "input" },
{ "type": "forwarded", "name": "keyup", "element": "input" },
{ "type": "forwarded", "name": "focus", "element": "input" },
{ "type": "forwarded", "name": "blur", "element": "input" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "ToggleSkeleton",
"filePath": "/src/Toggle/ToggleSkeleton.svelte",
"props": [
{
"name": "labelText",
"kind": "let",
"description": "Specify the label text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the input element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "ToggleSmall",
"filePath": "/src/ToggleSmall/ToggleSmall.svelte",
"props": [
{
"name": "toggled",
"kind": "let",
"description": "Set to `true` to toggle the checkbox input",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "disabled",
"kind": "let",
"description": "Set to `true` to disable checkbox input",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "labelA",
"kind": "let",
"description": "Specify the label for the untoggled state",
"type": "string",
"value": "\"Off\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "labelB",
"kind": "let",
"description": "Specify the label for the toggled state",
"type": "string",
"value": "\"On\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "labelText",
"kind": "let",
"description": "Specify the label text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the input element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "name",
"kind": "let",
"description": "Specify a name attribute for the checkbox input",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" },
{ "type": "forwarded", "name": "change", "element": "input" },
{ "type": "forwarded", "name": "keyup", "element": "input" },
{ "type": "forwarded", "name": "focus", "element": "input" },
{ "type": "forwarded", "name": "blur", "element": "input" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "ToggleSmallSkeleton",
"filePath": "/src/ToggleSmall/ToggleSmallSkeleton.svelte",
"props": [
{
"name": "labelText",
"kind": "let",
"description": "Specify the label text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the input element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "Tooltip",
"filePath": "/src/Tooltip/Tooltip.svelte",
"props": [
{
"name": "direction",
"kind": "let",
"description": "Set the direction of the tooltip relative to the button",
"type": "\"top\" | \"right\" | \"bottom\" | \"left\"",
"value": "\"bottom\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "open",
"kind": "let",
"description": "Set to `true` to open the tooltip",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "hideIcon",
"kind": "let",
"description": "Set to `true` to hide the tooltip icon",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "icon",
"kind": "let",
"description": "Specify the icon from `carbon-icons-svelte` to render for the tooltip button\nIcon size must be 16px (e.g. `Add16`, `Task16`)",
"type": "import(\"carbon-icons-svelte\").CarbonIcon",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "iconDescription",
"kind": "let",
"description": "Specify the ARIA label for the tooltip button",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "iconName",
"kind": "let",
"description": "Specify the icon name attribute",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "tabindex",
"kind": "let",
"description": "Set the button tabindex",
"type": "string",
"value": "\"0\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "tooltipId",
"kind": "let",
"description": "Set an id for the tooltip",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "triggerId",
"kind": "let",
"description": "Set an id for the tooltip button",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "triggerText",
"kind": "let",
"description": "Set the tooltip button text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the trigger text HTML element",
"type": "null | HTMLDivElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "refTooltip",
"kind": "let",
"description": "Obtain a reference to the tooltip HTML element",
"type": "null | HTMLDivElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "refIcon",
"kind": "let",
"description": "Obtain a reference to the icon HTML element",
"type": "null | HTMLDivElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [
{ "name": "__default__", "default": true, "slot_props": "{}" },
{
"name": "icon",
"default": false,
"fallback": "<svelte:component this=\"{icon}\" name=\"{iconName}\" />",
"slot_props": "{}"
},
{
"name": "triggerText",
"default": false,
"fallback": "{triggerText}",
"slot_props": "{}"
}
],
"events": [{ "type": "dispatched" }],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "TooltipDefinition",
"filePath": "/src/TooltipDefinition/TooltipDefinition.svelte",
"props": [
{
"name": "tooltipText",
"kind": "let",
"description": "Specify the tooltip text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "align",
"kind": "let",
"description": "Set the alignment of the tooltip relative to the icon",
"type": "\"start\" | \"center\" | \"end\"",
"value": "\"center\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "direction",
"kind": "let",
"description": "Set the direction of the tooltip relative to the icon",
"type": "\"top\" | \"bottom\"",
"value": "\"bottom\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the tooltip div element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the button HTML element",
"type": "null | HTMLButtonElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [
{ "name": "__default__", "default": true, "slot_props": "{}" },
{
"name": "tooltip",
"default": false,
"fallback": "{tooltipText}",
"slot_props": "{}"
}
],
"events": [
{ "type": "forwarded", "name": "click", "element": "button" },
{ "type": "forwarded", "name": "mouseover", "element": "button" },
{ "type": "forwarded", "name": "mouseenter", "element": "button" },
{ "type": "forwarded", "name": "mouseleave", "element": "button" },
{ "type": "forwarded", "name": "focus", "element": "button" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "TooltipIcon",
"filePath": "/src/TooltipIcon/TooltipIcon.svelte",
"props": [
{
"name": "tooltipText",
"kind": "let",
"description": "Specify the tooltip text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "align",
"kind": "let",
"description": "Set the alignment of the tooltip relative to the icon",
"type": "\"start\" | \"center\" | \"end\"",
"value": "\"center\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "direction",
"kind": "let",
"description": "Set the direction of the tooltip relative to the icon",
"type": "\"top\" | \"right\" | \"bottom\" | \"left\"",
"value": "\"bottom\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the span element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the button HTML element",
"type": "null | HTMLButtonElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{ "type": "forwarded", "name": "click", "element": "button" },
{ "type": "forwarded", "name": "mouseover", "element": "button" },
{ "type": "forwarded", "name": "mouseenter", "element": "button" },
{ "type": "forwarded", "name": "mouseleave", "element": "button" },
{ "type": "forwarded", "name": "focus", "element": "button" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "button" }
},
{
"moduleName": "Header",
"filePath": "/src/UIShell/GlobalHeader/Header.svelte",
"props": [
{
"name": "expandedByDefault",
"kind": "let",
"description": "Set to `false` to hide the side nav by default",
"type": "boolean",
"value": "true",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "isSideNavOpen",
"kind": "let",
"description": "Set to `true` to open the side nav",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "uiShellAriaLabel",
"kind": "let",
"description": "Specify the ARIA label for the header",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "href",
"kind": "let",
"description": "Specify the `href` attribute",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "company",
"kind": "let",
"description": "Specify the company name",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "platformName",
"kind": "let",
"description": "Specify the platform name\nAlternatively, use the named slot \"platform\" (e.g. <span slot=\"platform\">...</span>)",
"type": "string",
"value": "\"\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the HTML anchor element",
"type": "null | HTMLAnchorElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [
{ "name": "__default__", "default": true, "slot_props": "{}" },
{
"name": "platform",
"default": false,
"fallback": "{platformName}",
"slot_props": "{}"
},
{ "name": "skip-to-content", "default": false, "slot_props": "{}" }
],
"events": [{ "type": "forwarded", "name": "click", "element": "a" }],
"typedefs": [],
"rest_props": { "type": "Element", "name": "a" }
},
{
"moduleName": "HeaderAction",
"filePath": "/src/UIShell/GlobalHeader/HeaderAction.svelte",
"props": [
{
"name": "isOpen",
"kind": "let",
"description": "Set to `true` to open the panel",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "icon",
"kind": "let",
"description": "Specify the icon props",
"type": "{ render: import(\"carbon-icons-svelte\").CarbonIcon; skeleton: boolean; }",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "text",
"kind": "let",
"description": "Specify the text\nAlternatively, use the named slot \"text\" (e.g. <div slot=\"text\">...</div>)",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the button HTML element",
"type": "null | HTMLButtonElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [
{ "name": "__default__", "default": true, "slot_props": "{}" },
{
"name": "text",
"default": false,
"fallback": "{#if text}<span>{text}</span>{/if}",
"slot_props": "{}"
}
],
"events": [
{ "type": "forwarded", "name": "click", "element": "button" },
{ "type": "dispatched", "name": "close" },
{ "type": "dispatched" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "button" }
},
{
"moduleName": "HeaderActionLink",
"filePath": "/src/UIShell/GlobalHeader/HeaderActionLink.svelte",
"props": [
{
"name": "linkIsActive",
"kind": "let",
"description": "Set to `true` to use the active state",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "href",
"kind": "let",
"description": "Specify the `href` attribute",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "icon",
"kind": "let",
"description": "Specify the icon props",
"type": "{ render: import(\"carbon-icons-svelte\").CarbonIcon; skeleton: boolean; }",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the HTML anchor element",
"type": "null | HTMLAnchorElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [],
"events": [],
"typedefs": [],
"rest_props": { "type": "Element", "name": "a" }
},
{
"moduleName": "HeaderActionSearch",
"filePath": "/src/UIShell/GlobalHeader/HeaderActionSearch.svelte",
"props": [
{
"name": "searchIsActive",
"kind": "let",
"description": "Set to `true` to focus the search",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [],
"events": [
{
"type": "dispatched",
"name": "inputSearch",
"detail": "{ action: \"search\"; textInput: string; }"
},
{ "type": "dispatched", "name": "focusInputSearch" },
{ "type": "dispatched", "name": "focusOutInputSearch" }
],
"typedefs": []
},
{
"moduleName": "HeaderNav",
"filePath": "/src/UIShell/GlobalHeader/HeaderNav.svelte",
"props": [
{
"name": "ariaLabel",
"kind": "let",
"description": "Specify the ARIA label for the nav",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [],
"typedefs": [],
"rest_props": { "type": "Element", "name": "nav" }
},
{
"moduleName": "HeaderNavItem",
"filePath": "/src/UIShell/GlobalHeader/HeaderNavItem.svelte",
"props": [
{
"name": "href",
"kind": "let",
"description": "Specify the `href` attribute",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "text",
"kind": "let",
"description": "Specify the text",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the HTML anchor element",
"type": "null | HTMLAnchorElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "a" },
{ "type": "forwarded", "name": "mouseover", "element": "a" },
{ "type": "forwarded", "name": "mouseenter", "element": "a" },
{ "type": "forwarded", "name": "mouseleave", "element": "a" },
{ "type": "forwarded", "name": "keyup", "element": "a" },
{ "type": "forwarded", "name": "keydown", "element": "a" },
{ "type": "forwarded", "name": "focus", "element": "a" },
{ "type": "forwarded", "name": "blur", "element": "a" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "a" }
},
{
"moduleName": "HeaderNavMenu",
"filePath": "/src/UIShell/GlobalHeader/HeaderNavMenu.svelte",
"props": [
{
"name": "expanded",
"kind": "let",
"description": "Set to `true` to toggle the expanded state",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "href",
"kind": "let",
"description": "Specify the `href` attribute",
"type": "string",
"value": "\"/\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "text",
"kind": "let",
"description": "Specify the text",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the HTML anchor element",
"type": "null | HTMLAnchorElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "iconDescription",
"kind": "let",
"description": "Specify the ARIA label for the chevron icon",
"type": "string",
"value": "\"Expand/Collapse\"",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{ "type": "forwarded", "name": "keydown", "element": "a" },
{ "type": "forwarded", "name": "click", "element": "a" },
{ "type": "forwarded", "name": "mouseover", "element": "a" },
{ "type": "forwarded", "name": "mouseenter", "element": "a" },
{ "type": "forwarded", "name": "mouseleave", "element": "a" },
{ "type": "forwarded", "name": "keyup", "element": "a" },
{ "type": "forwarded", "name": "focus", "element": "a" },
{ "type": "forwarded", "name": "blur", "element": "a" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "a" }
},
{
"moduleName": "HeaderPanelDivider",
"filePath": "/src/UIShell/GlobalHeader/HeaderPanelDivider.svelte",
"props": [],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [],
"typedefs": []
},
{
"moduleName": "HeaderPanelLink",
"filePath": "/src/UIShell/GlobalHeader/HeaderPanelLink.svelte",
"props": [
{
"name": "href",
"kind": "let",
"description": "Specify the `href` attribute",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the HTML anchor element",
"type": "null | HTMLAnchorElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [{ "type": "forwarded", "name": "click", "element": "a" }],
"typedefs": [],
"rest_props": { "type": "Element", "name": "a" }
},
{
"moduleName": "HeaderPanelLinks",
"filePath": "/src/UIShell/GlobalHeader/HeaderPanelLinks.svelte",
"props": [],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [],
"typedefs": []
},
{
"moduleName": "HeaderUtilities",
"filePath": "/src/UIShell/GlobalHeader/HeaderUtilities.svelte",
"props": [],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [],
"typedefs": []
},
{
"moduleName": "SideNav",
"filePath": "/src/UIShell/SideNav/SideNav.svelte",
"props": [
{
"name": "fixed",
"kind": "let",
"description": "Set to `true` to use the fixed variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ariaLabel",
"kind": "let",
"description": "Specify the ARIA label for the nav",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "isOpen",
"kind": "let",
"description": "Set to `true` to toggle the expanded state",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [],
"typedefs": [],
"rest_props": { "type": "Element", "name": "nav" }
},
{
"moduleName": "SideNavItems",
"filePath": "/src/UIShell/SideNav/SideNavItems.svelte",
"props": [],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [],
"typedefs": []
},
{
"moduleName": "SideNavLink",
"filePath": "/src/UIShell/SideNav/SideNavLink.svelte",
"props": [
{
"name": "isSelected",
"kind": "let",
"description": "Set to `true` to select the current link",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "href",
"kind": "let",
"description": "Specify the `href` attribute",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "text",
"kind": "let",
"description": "Specify the text",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "icon",
"kind": "let",
"description": "Specify the icon props",
"type": "{ render: import(\"carbon-icons-svelte\").CarbonIcon; skeleton: boolean; }",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the HTML anchor element",
"type": "null | HTMLAnchorElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [],
"events": [{ "type": "forwarded", "name": "click", "element": "a" }],
"typedefs": [],
"rest_props": { "type": "Element", "name": "a" }
},
{
"moduleName": "SideNavMenu",
"filePath": "/src/UIShell/SideNav/SideNavMenu.svelte",
"props": [
{
"name": "expanded",
"kind": "let",
"description": "Set to `true` to toggle the expanded state",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": true
},
{
"name": "text",
"kind": "let",
"description": "Specify the text",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "icon",
"kind": "let",
"description": "Specify the icon props",
"type": "{ render: import(\"carbon-icons-svelte\").CarbonIcon; skeleton: boolean; }",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the HTML button element",
"type": "null | HTMLButtonElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [{ "type": "forwarded", "name": "click", "element": "button" }],
"typedefs": [],
"rest_props": { "type": "Element", "name": "button" }
},
{
"moduleName": "SideNavMenuItem",
"filePath": "/src/UIShell/SideNav/SideNavMenuItem.svelte",
"props": [
{
"name": "isSelected",
"kind": "let",
"description": "Set to `true` to select the item",
"type": "boolean",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "href",
"kind": "let",
"description": "Specify the `href` attribute",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "text",
"kind": "let",
"description": "Specify the item text",
"type": "string",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the HTML anchor element",
"type": "null | HTMLAnchorElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [],
"events": [{ "type": "forwarded", "name": "click", "element": "a" }],
"typedefs": [],
"rest_props": { "type": "Element", "name": "a" }
},
{
"moduleName": "Content",
"filePath": "/src/UIShell/Content.svelte",
"props": [
{
"name": "id",
"kind": "let",
"description": "Specify the id for the main element",
"type": "string",
"value": "\"main-content\"",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [],
"typedefs": [],
"rest_props": { "type": "Element", "name": "main" }
},
{
"moduleName": "SkipToContent",
"filePath": "/src/UIShell/SkipToContent.svelte",
"props": [
{
"name": "href",
"kind": "let",
"description": "Specify the `href` attribute",
"type": "string",
"value": "\"#main-content\"",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "tabindex",
"kind": "let",
"description": "Specify the tabindex",
"type": "string",
"value": "\"0\"",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [
{
"name": "__default__",
"default": true,
"fallback": "Skip to main content",
"slot_props": "{}"
}
],
"events": [{ "type": "forwarded", "name": "click", "element": "a" }],
"typedefs": [],
"rest_props": { "type": "Element", "name": "a" }
},
{
"moduleName": "HeaderGlobalAction",
"filePath": "/src/UIShell/HeaderGlobalAction.svelte",
"props": [
{
"name": "isActive",
"kind": "let",
"description": "Set to `true` to use the active variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "icon",
"kind": "let",
"description": "Specify the icon to render",
"type": "import(\"carbon-icons-svelte\").CarbonIcon",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",
"description": "Obtain a reference to the HTML button element",
"type": "null | HTMLButtonElement",
"value": "null",
"isFunction": false,
"constant": false,
"reactive": true
}
],
"slots": [
{
"name": "__default__",
"default": true,
"fallback": "<svelte:component this=\"{icon}\" />",
"slot_props": "{}"
}
],
"events": [{ "type": "forwarded", "name": "click", "element": "button" }],
"typedefs": [],
"rest_props": { "type": "Element", "name": "button" }
},
{
"moduleName": "UnorderedList",
"filePath": "/src/UnorderedList/UnorderedList.svelte",
"props": [
{
"name": "nested",
"kind": "let",
"description": "Set to `true` to use the nested variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
}
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{ "type": "forwarded", "name": "click", "element": "ul" },
{ "type": "forwarded", "name": "mouseover", "element": "ul" },
{ "type": "forwarded", "name": "mouseenter", "element": "ul" },
{ "type": "forwarded", "name": "mouseleave", "element": "ul" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "ul" }
}
]
}
Reference in a new issue View git blame Copy permalink