Skip to content

Commit 2fbf1c2

Browse files
committed
chore: format JSDoc prop descriptions
1 parent 2ffa625 commit 2fbf1c2

File tree

212 files changed

+1712
-1713
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

212 files changed

+1712
-1713
lines changed

COMPONENT_INDEX.md

Lines changed: 697 additions & 697 deletions
Large diffs are not rendered by default.

docs/src/COMPONENT_API.json

Lines changed: 318 additions & 318 deletions
Large diffs are not rendered by default.

src/Accordion/Accordion.svelte

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
/** @extends {"./AccordionSkeleton.svelte"} AccordionSkeletonProps */
33
44
/**
5-
* Specify alignment of accordion item chevron icon
5+
* Specify alignment of accordion item chevron icon.
66
* @type {"start" | "end"}
77
*/
88
export let align = "end";
99
1010
/**
11-
* Specify the size of the accordion
11+
* Specify the size of the accordion.
1212
* @type {"sm" | "xl"}
1313
*/
1414
export let size = undefined;

src/Accordion/AccordionItem.svelte

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<script>
22
/**
33
* Specify the title of the accordion item heading.
4-
* Alternatively, use the "title" slot
4+
* Alternatively, use the "title" slot.
55
* @example
66
* ```svelte
77
* <AccordionItem>

src/Accordion/AccordionSkeleton.svelte

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33
export let count = 4;
44
55
/**
6-
* Specify alignment of accordion item chevron icon
6+
* Specify alignment of accordion item chevron icon.
77
* @type {"start" | "end"}
88
*/
99
export let align = "end";
1010
1111
/**
12-
* Specify the size of the accordion
12+
* Specify the size of the accordion.
1313
* @type {"sm" | "xl"}
1414
*/
1515
export let size = undefined;

src/AspectRatio/AspectRatio.svelte

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<script>
22
/**
3-
* Specify the aspect ratio
3+
* Specify the aspect ratio.
44
* @type {"2x1" | "2x3" | "16x9" | "4x3" | "1x1" | "3x4" | "3x2" | "9x16" | "1x2"}
55
*/
66
export let ratio = "2x1";

src/Breadcrumb/BreadcrumbItem.svelte

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
*/
55
66
/**
7-
* Set the `href` to use an anchor link
7+
* Set the `href` to use an anchor link.
88
* @type {string}
99
*/
1010
export let href = undefined;

src/Breakpoint/Breakpoint.svelte

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@
1010
*/
1111
1212
/**
13-
* Determine the current Carbon grid breakpoint size
13+
* Determine the current Carbon grid breakpoint size.
1414
* @type {BreakpointSize}
1515
*/
1616
export let size = undefined;
1717
1818
/**
19-
* Carbon grid sizes as an object
19+
* Carbon grid sizes as an object.
2020
* @type {Record<BreakpointSize, boolean>}
2121
*/
2222
export let sizes = {

src/Button/Button.svelte

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@
77
*/
88
99
/**
10-
* Specify the kind of button
10+
* Specify the kind of button.
1111
* @type {"primary" | "secondary" | "tertiary" | "ghost" | "danger" | "danger-tertiary" | "danger-ghost"}
1212
*/
1313
export let kind = "primary";
1414
1515
/**
16-
* Specify the size of button
16+
* Specify the size of button.
1717
* @type {"default" | "field" | "small" | "lg" | "xl"}
1818
*/
1919
export let size = "default";
@@ -22,13 +22,13 @@
2222
export let expressive = false;
2323
2424
/**
25-
* Set to `true` to enable the selected state for an icon-only, ghost button
25+
* Set to `true` to enable the selected state for an icon-only, ghost button.
2626
*/
2727
export let isSelected = false;
2828
2929
/**
30-
* Specify the icon to render
31-
* Alternatively, use the named slot "icon"
30+
* Specify the icon to render.
31+
* Alternatively, use the named slot "icon".
3232
*
3333
* @type {any}
3434
* @example
@@ -41,20 +41,20 @@
4141
export let icon = undefined;
4242
4343
/**
44-
* Specify the ARIA label for the button icon
44+
* Specify the ARIA label for the button icon.
4545
* @type {string}
4646
*/
4747
export let iconDescription = undefined;
4848
4949
/**
5050
* Set the alignment of the tooltip relative to the icon.
51-
* Only applies to icon-only buttons
51+
* Only applies to icon-only buttons.
5252
* @type {"start" | "center" | "end"}
5353
*/
5454
export let tooltipAlignment = "center";
5555
5656
/**
57-
* Set the position of the tooltip relative to the icon
57+
* Set the position of the tooltip relative to the icon.
5858
* @type {"top" | "right" | "bottom" | "left"}
5959
*/
6060
export let tooltipPosition = "bottom";
@@ -67,8 +67,8 @@
6767
export let hideTooltip = false;
6868
6969
/**
70-
* Set to `true` to render a custom HTML element
71-
* Props are destructured as `props` in the default slot
70+
* Set to `true` to render a custom HTML element.
71+
* Props are destructured as `props` in the default slot.
7272
* @example
7373
* ```svelte
7474
* <Button let:props>
@@ -85,7 +85,7 @@
8585
export let disabled = false;
8686
8787
/**
88-
* Set the `href` to use an anchor link
88+
* Set the `href` to use an anchor link.
8989
* @type {string}
9090
*/
9191
export let href = undefined;

src/Button/ButtonSkeleton.svelte

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
<script>
22
/**
3-
* Set the `href` to use an anchor link
3+
* Set the `href` to use an anchor link.
44
* @type {string}
55
*/
66
export let href = undefined;
77
88
/**
9-
* Specify the size of button skeleton
9+
* Specify the size of button skeleton.
1010
* @type {"default" | "field" | "small" | "lg" | "xl"}
1111
*/
1212
export let size = "default";

0 commit comments

Comments
 (0)