From c3f924c25a273b7499dc38f6e2062d2e0939f102 Mon Sep 17 00:00:00 2001 From: Eric Liu Date: Sat, 25 Jul 2020 11:30:45 -0700 Subject: [PATCH] chore: add more type docs --- src/Checkbox/Checkbox.svelte | 2 +- src/ComboBox/ComboBox.svelte | 11 ++++ .../DataTableSkeleton.svelte | 25 ++++++++ src/DatePicker/DatePicker.Skeleton.svelte | 4 ++ src/DatePicker/DatePicker.svelte | 8 ++- src/DatePicker/DatePickerInput.svelte | 27 ++++++++- src/Dropdown/Dropdown.svelte | 14 ++++- src/FileUploader/Filename.svelte | 16 ++++- src/FormGroup/FormGroup.svelte | 7 ++- src/Icon/Icon.svelte | 5 ++ src/InlineLoading/InlineLoading.svelte | 15 +++++ src/ListBox/ListBox.svelte | 19 ++++++ src/ListBox/ListBoxField.svelte | 5 ++ src/ListBox/ListBoxMenu.svelte | 4 +- src/MultiSelect/MultiSelect.svelte | 17 ++++++ src/Notification/InlineNotification.svelte | 2 +- src/NumberInput/NumberInput.Skeleton.svelte | 4 ++ src/NumberInput/NumberInput.svelte | 19 +++++- src/OverflowMenu/OverflowMenu.svelte | 13 ++++- src/ProgressIndicator/ProgressStep.svelte | 5 ++ src/RadioButton/RadioButton.svelte | 9 +++ src/Search/Search.svelte | 12 +++- src/Select/Select.svelte | 20 +++++++ src/SkeletonText/SkeletonText.svelte | 19 ++++++ src/Slider/Slider.Skeleton.svelte | 4 ++ src/Slider/Slider.svelte | 10 ++++ src/TextArea/TextArea.Skeleton.svelte | 4 ++ src/TextArea/TextArea.svelte | 36 ++++++++++-- src/TextInput/PasswordInput.svelte | 10 ++++ src/TextInput/TextInput.Skeleton.svelte | 4 ++ src/TextInput/TextInput.svelte | 20 +++++++ src/Tile/ClickableTile.svelte | 4 ++ src/Tile/ExpandableTile.svelte | 4 ++ src/Tile/RadioTile.svelte | 4 ++ src/Tile/SelectableTile.svelte | 4 ++ src/TimePicker/TimePicker.svelte | 39 ++++++++----- src/TimePicker/TimePickerSelect.svelte | 15 ++--- src/Toggle/Toggle.Skeleton.svelte | 2 +- src/Toggle/Toggle.svelte | 29 ++++++++++ src/ToggleSmall/ToggleSmall.Skeleton.svelte | 2 +- src/ToggleSmall/ToggleSmall.svelte | 31 +++++++++- src/Tooltip/Tooltip.svelte | 58 +++++++++++++++++-- .../TooltipDefinition.svelte | 2 +- src/TooltipIcon/TooltipIcon.Story.svelte | 1 - src/TooltipIcon/TooltipIcon.svelte | 2 +- 45 files changed, 517 insertions(+), 50 deletions(-) diff --git a/src/Checkbox/Checkbox.svelte b/src/Checkbox/Checkbox.svelte index 1ba3f507..b96bd497 100644 --- a/src/Checkbox/Checkbox.svelte +++ b/src/Checkbox/Checkbox.svelte @@ -30,7 +30,7 @@ export let disabled = false; /** - * Define the label text + * Specify the label text * @type {string} [labelText=""] */ export let labelText = ""; diff --git a/src/ComboBox/ComboBox.svelte b/src/ComboBox/ComboBox.svelte index a0960454..d6747abd 100644 --- a/src/ComboBox/ComboBox.svelte +++ b/src/ComboBox/ComboBox.svelte @@ -7,8 +7,19 @@ * @type {string} [id] */ export let id = "ccs-" + Math.random().toString(36); + + /** + * Set to `true` to indicate an invalid state + * @type {boolean} [invalid=false] + */ export let invalid = false; + + /** + * Specify the invalid state text + * @type {string} [invalidText=""] + */ export let invalidText = ""; + export let items = []; export let itemToString = (item) => item.text || item.id; export let light = false; diff --git a/src/DataTableSkeleton/DataTableSkeleton.svelte b/src/DataTableSkeleton/DataTableSkeleton.svelte index 3ffe2cec..ec463ff0 100644 --- a/src/DataTableSkeleton/DataTableSkeleton.svelte +++ b/src/DataTableSkeleton/DataTableSkeleton.svelte @@ -1,8 +1,33 @@ diff --git a/src/ListBox/ListBoxField.svelte b/src/ListBox/ListBoxField.svelte index 069d27b1..a7887fb5 100644 --- a/src/ListBox/ListBoxField.svelte +++ b/src/ListBox/ListBoxField.svelte @@ -10,6 +10,11 @@ * @type {string} [id] */ export let id = "ccs-" + Math.random().toString(36); + + /** + * Obtain a reference to the top-level HTML element + * @type {null | HTMLElement} [ref=null] + */ export let ref = null; import { getContext } from "svelte"; diff --git a/src/ListBox/ListBoxMenu.svelte b/src/ListBox/ListBoxMenu.svelte index 9cf640ff..8c0e01fd 100644 --- a/src/ListBox/ListBoxMenu.svelte +++ b/src/ListBox/ListBoxMenu.svelte @@ -4,13 +4,11 @@ * @type {string} [id] */ export let id = "ccs-" + Math.random().toString(36); - - $: menuId = `menu-${id}`;
diff --git a/src/MultiSelect/MultiSelect.svelte b/src/MultiSelect/MultiSelect.svelte index d67065ea..fe3966dc 100644 --- a/src/MultiSelect/MultiSelect.svelte +++ b/src/MultiSelect/MultiSelect.svelte @@ -13,13 +13,30 @@ */ export let id = "ccs-" + Math.random().toString(36); export let name = undefined; + + /** + * Set to `true` to indicate an invalid state + * @type {boolean} [invalid=false] + */ export let invalid = false; + + /** + * Specify the invalid state text + * @type {string} [invalidText=""] + */ export let invalidText = ""; + export let helperText = ""; export let items = []; export let itemToString = (item) => item.text || item.id; export let label = ""; + + /** + * Set to `true` to enable the light variant + * @type {boolean} [light=false] + */ export let light = false; + export let locale = "en"; export let open = false; export let placeholder = ""; diff --git a/src/Notification/InlineNotification.svelte b/src/Notification/InlineNotification.svelte index 90177e28..b267c336 100644 --- a/src/Notification/InlineNotification.svelte +++ b/src/Notification/InlineNotification.svelte @@ -2,7 +2,7 @@ export let notificationType = "inline"; /** - * Set the kind of notification + * Specify the kind of notification * @type {"error" | "info" | "info-square" | "success" | "warning" | "warning-alt"} [kind="error"] */ export let kind = "error"; diff --git a/src/NumberInput/NumberInput.Skeleton.svelte b/src/NumberInput/NumberInput.Skeleton.svelte index e7d45b27..240291e0 100644 --- a/src/NumberInput/NumberInput.Skeleton.svelte +++ b/src/NumberInput/NumberInput.Skeleton.svelte @@ -1,4 +1,8 @@ diff --git a/src/NumberInput/NumberInput.svelte b/src/NumberInput/NumberInput.svelte index fa7a76a9..0332d6b0 100644 --- a/src/NumberInput/NumberInput.svelte +++ b/src/NumberInput/NumberInput.svelte @@ -4,7 +4,13 @@ export let step = 1; export let max = undefined; export let min = undefined; + + /** + * Set to `true` to enable the light variant + * @type {boolean} [light=false] + */ export let light = false; + export let readonly = false; export let mobile = false; export let allowEmpty = false; @@ -17,8 +23,19 @@ */ export let id = "ccs-" + Math.random().toString(36); export let name = undefined; + + /** + * Set to `true` to indicate an invalid state + * @type {boolean} [invalid=false] + */ export let invalid = false; - export let invalidText = "Provide invalidText"; + + /** + * Specify the invalid state text + * @type {string} [invalidText="Provide invalidText"] + */ + export let invalidText = ""; + export let helperText = ""; export let label = ""; export let hideLabel = false; diff --git a/src/OverflowMenu/OverflowMenu.svelte b/src/OverflowMenu/OverflowMenu.svelte index c9bd9487..079dd0ac 100644 --- a/src/OverflowMenu/OverflowMenu.svelte +++ b/src/OverflowMenu/OverflowMenu.svelte @@ -1,8 +1,19 @@ diff --git a/src/Slider/Slider.svelte b/src/Slider/Slider.svelte index 6ef55354..3fb96aa7 100644 --- a/src/Slider/Slider.svelte +++ b/src/Slider/Slider.svelte @@ -8,7 +8,17 @@ */ export let id = "ccs-" + Math.random().toString(36); export let inputType = "number"; + + /** + * Set to `true` to indicate an invalid state + * @type {boolean} [invalid=false] + */ export let invalid = false; + + /** + * Specify the label text + * @type {string} [labelText=""] + */ export let labelText = ""; /** diff --git a/src/TextArea/TextArea.Skeleton.svelte b/src/TextArea/TextArea.Skeleton.svelte index 9f4e44d3..7594ce9c 100644 --- a/src/TextArea/TextArea.Skeleton.svelte +++ b/src/TextArea/TextArea.Skeleton.svelte @@ -1,4 +1,8 @@ diff --git a/src/TextArea/TextArea.svelte b/src/TextArea/TextArea.svelte index db2fbc62..b0bf34ce 100644 --- a/src/TextArea/TextArea.svelte +++ b/src/TextArea/TextArea.svelte @@ -12,16 +12,42 @@ export let disabled = false; export let helperText = ""; + /** + * Specify the label text + * @type {string} [labelText=""] + */ + export let labelText = ""; + + /** + * Set to `true` to visually hide the label text + * @type {boolean} [hideLabel=false] + */ + export let hideLabel = false; + + export let name = undefined; + + /** + * Set to `true` to indicate an invalid state + * @type {boolean} [invalid=false] + */ + export let invalid = false; + + /** + * Specify the invalid state text + * @type {string} [invalidText=""] + */ + export let invalidText = ""; + /** * Set an id for the textarea element * @type {string} [id] */ export let id = "ccs-" + Math.random().toString(36); - export let name = undefined; - export let invalid = false; - export let invalidText = ""; - export let labelText = ""; - export let hideLabel = false; + + /** + * Obtain a reference to the textarea HTML element + * @type {null | HTMLElement} [ref=null] + */ export let ref = null; import WarningFilled16 from "carbon-icons-svelte/lib/WarningFilled16"; diff --git a/src/TextInput/PasswordInput.svelte b/src/TextInput/PasswordInput.svelte index 8a2649e8..ef71f04d 100644 --- a/src/TextInput/PasswordInput.svelte +++ b/src/TextInput/PasswordInput.svelte @@ -23,7 +23,17 @@ export let name = undefined; export let invalid = false; export let invalidText = ""; + + /** + * Specify the label text + * @type {string} [labelText=""] + */ export let labelText = ""; + + /** + * Set to `true` to visually hide the label text + * @type {boolean} [hideLabel=false] + */ export let hideLabel = false; export let tooltipAlignment = "center"; export let tooltipPosition = "bottom"; diff --git a/src/TextInput/TextInput.Skeleton.svelte b/src/TextInput/TextInput.Skeleton.svelte index 9f4e44d3..8e3be9f4 100644 --- a/src/TextInput/TextInput.Skeleton.svelte +++ b/src/TextInput/TextInput.Skeleton.svelte @@ -1,4 +1,8 @@ diff --git a/src/TextInput/TextInput.svelte b/src/TextInput/TextInput.svelte index 26af2e97..b60e2262 100644 --- a/src/TextInput/TextInput.svelte +++ b/src/TextInput/TextInput.svelte @@ -19,10 +19,30 @@ export let id = "ccs-" + Math.random().toString(36); export let name = undefined; export let helperText = ""; + /** + * Specify the label text + * @type {string} [labelText=""] + */ export let labelText = ""; + + /** + * Set to `true` to visually hide the label text + * @type {boolean} [hideLabel=false] + */ export let hideLabel = false; + + /** + * Set to `true` to indicate an invalid state + * @type {boolean} [invalid=false] + */ export let invalid = false; + + /** + * Specify the invalid state text + * @type {string} [invalidText=""] + */ export let invalidText = ""; + export let ref = null; import WarningFilled16 from "carbon-icons-svelte/lib/WarningFilled16"; diff --git a/src/Tile/ClickableTile.svelte b/src/Tile/ClickableTile.svelte index 9f69adb6..87d08327 100644 --- a/src/Tile/ClickableTile.svelte +++ b/src/Tile/ClickableTile.svelte @@ -1,4 +1,8 @@
+ on:mouseleave>
+ on:blur />
diff --git a/src/TimePicker/TimePickerSelect.svelte b/src/TimePicker/TimePickerSelect.svelte index 159e5796..34720670 100644 --- a/src/TimePicker/TimePickerSelect.svelte +++ b/src/TimePicker/TimePickerSelect.svelte @@ -4,13 +4,14 @@ export let disabled = false; export let iconDescription = "Open list of options"; + export let labelText = ""; + export let hideLabel = true; + /** * Set an id for the select element * @type {string} [id] */ export let id = "ccs-" + Math.random().toString(36); - export let labelText = ""; - export let hideLabel = true; import { setContext } from "svelte"; import { writable } from "svelte/store"; @@ -42,14 +43,14 @@ {/if} /** - * Define the label text + * Specify the label text * @type {string} [labelText=""] */ export let labelText = ""; diff --git a/src/Toggle/Toggle.svelte b/src/Toggle/Toggle.svelte index fff21e22..4fbb4655 100644 --- a/src/Toggle/Toggle.svelte +++ b/src/Toggle/Toggle.svelte @@ -1,8 +1,32 @@ diff --git a/src/ToggleSmall/ToggleSmall.Skeleton.svelte b/src/ToggleSmall/ToggleSmall.Skeleton.svelte index b395dede..fe66cc53 100644 --- a/src/ToggleSmall/ToggleSmall.Skeleton.svelte +++ b/src/ToggleSmall/ToggleSmall.Skeleton.svelte @@ -1,6 +1,6 @@ @@ -33,7 +62,7 @@ toggled = !toggled; }} on:keyup - on:keyup={e => { + on:keyup={(e) => { if (e.key === ' ' || e.key === 'Enter') { e.preventDefault(); toggled = !toggled; diff --git a/src/Tooltip/Tooltip.svelte b/src/Tooltip/Tooltip.svelte index 09a6bc93..670e262a 100644 --- a/src/Tooltip/Tooltip.svelte +++ b/src/Tooltip/Tooltip.svelte @@ -1,13 +1,63 @@ diff --git a/src/TooltipIcon/TooltipIcon.svelte b/src/TooltipIcon/TooltipIcon.svelte index d773c23e..d570bd4d 100644 --- a/src/TooltipIcon/TooltipIcon.svelte +++ b/src/TooltipIcon/TooltipIcon.svelte @@ -1,7 +1,7 @@