|
7 | 7 | */ |
8 | 8 |
|
9 | 9 | /** |
10 | | - * Specify the kind of button |
| 10 | + * Specify the kind of button. |
11 | 11 | * @type {"primary" | "secondary" | "tertiary" | "ghost" | "danger" | "danger-tertiary" | "danger-ghost"} |
12 | 12 | */ |
13 | 13 | export let kind = "primary"; |
14 | 14 |
|
15 | 15 | /** |
16 | | - * Specify the size of button |
| 16 | + * Specify the size of button. |
17 | 17 | * @type {"default" | "field" | "small" | "lg" | "xl"} |
18 | 18 | */ |
19 | 19 | export let size = "default"; |
|
22 | 22 | export let expressive = false; |
23 | 23 |
|
24 | 24 | /** |
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. |
26 | 26 | */ |
27 | 27 | export let isSelected = false; |
28 | 28 |
|
29 | 29 | /** |
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". |
32 | 32 | * |
33 | 33 | * @type {any} |
34 | 34 | * @example |
|
41 | 41 | export let icon = undefined; |
42 | 42 |
|
43 | 43 | /** |
44 | | - * Specify the ARIA label for the button icon |
| 44 | + * Specify the ARIA label for the button icon. |
45 | 45 | * @type {string} |
46 | 46 | */ |
47 | 47 | export let iconDescription = undefined; |
48 | 48 |
|
49 | 49 | /** |
50 | 50 | * Set the alignment of the tooltip relative to the icon. |
51 | | - * Only applies to icon-only buttons |
| 51 | + * Only applies to icon-only buttons. |
52 | 52 | * @type {"start" | "center" | "end"} |
53 | 53 | */ |
54 | 54 | export let tooltipAlignment = "center"; |
55 | 55 |
|
56 | 56 | /** |
57 | | - * Set the position of the tooltip relative to the icon |
| 57 | + * Set the position of the tooltip relative to the icon. |
58 | 58 | * @type {"top" | "right" | "bottom" | "left"} |
59 | 59 | */ |
60 | 60 | export let tooltipPosition = "bottom"; |
|
67 | 67 | export let hideTooltip = false; |
68 | 68 |
|
69 | 69 | /** |
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. |
72 | 72 | * @example |
73 | 73 | * ```svelte |
74 | 74 | * <Button let:props> |
|
85 | 85 | export let disabled = false; |
86 | 86 |
|
87 | 87 | /** |
88 | | - * Set the `href` to use an anchor link |
| 88 | + * Set the `href` to use an anchor link. |
89 | 89 | * @type {string} |
90 | 90 | */ |
91 | 91 | export let href = undefined; |
|
0 commit comments