@esri/calcite-components 2.2.0-next.10 → 2.2.0-next.12

package/dist/types/components.d.ts

@@ -196,7 +196,7 @@ export namespace Components {
          */
         "scale": Scale;
         /**
-          * Specifies the selection mode - `"multiple"` (allow any number of open items), `"single"` (allow one open item), or `"single-persist"` (allow and require one open item).
+          * Specifies the selection mode of the component, where:  `"multiple"` allows any number of selections,  `"single"` allows only one selection, and  `"single-persist"` allows one selection and prevents de-selection.
          */
         "selectionMode": Extract<
     "single" | "single-persist" | "multiple",
@@ -639,7 +639,7 @@ export namespace Components {
          */
         "text": string;
         /**
-          * Specifies the component's toggle display -  `"button"` (selectable header), or  `"switch"` (toggle switch).
+          * Specifies how the component's toggle is displayed -  `"button"` (selectable header), or  `"switch"` (toggle switch).
          */
         "toggleDisplay": BlockSectionToggleDisplay;
     }
@@ -680,7 +680,7 @@ export namespace Components {
          */
         "iconStart": string;
         /**
-          * Specifies the kind of the component (will apply to border and background if applicable).
+          * Specifies the kind of the component, which will apply to the border and background if applicable.
          */
         "kind": Extract<"brand" | "danger" | "inverse" | "neutral", Kind>;
         /**
@@ -730,7 +730,7 @@ export namespace Components {
          */
         "target": string;
         /**
-          * Specifies the default behavior of the button.
+          * Specifies the default behavior of the component.
           * @mdn [type](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#attr-type)
          */
         "type": string;
@@ -796,7 +796,7 @@ export namespace Components {
          */
         "label": string;
         /**
-          * Specifies the name of the component on form submission.
+          * Specifies the name of the component.  Required to pass the component's `value` on form submission.
          */
         "name": string;
         /**
@@ -905,7 +905,7 @@ export namespace Components {
          */
         "selectedItems": HTMLCalciteChipElement[];
         /**
-          * Specifies the selection mode of the component.
+          * Specifies the selection mode of the component, where:  `"multiple"` allows any number of selections,  `"single"` allows only one selection,  `"single-persist"` allows one selection and prevents de-selection, and  `"none"` does not allow any selections.
          */
         "selectionMode": Extract<
     "multiple" | "single" | "single-persist" | "none",
@@ -918,15 +918,15 @@ export namespace Components {
     }
     interface CalciteColorPicker {
         /**
-          * When `true`, an empty color (`null`) will be allowed as a `value`. When `false`, a color value is enforced, and clearing the input or blurring will restore the last valid `value`.
+          * When `true`, an empty color (`null`) will be allowed as a `value`.  When `false`, a color value is enforced, and clearing the input or blurring will restore the last valid `value`.
          */
         "allowEmpty": boolean;
         /**
-          * When true, the component will allow updates to the color's alpha value.
+          * When `true`, the component will allow updates to the color's alpha value.
          */
         "alphaChannel": boolean;
         /**
-          * When true, hides the RGB/HSV channel inputs
+          * When `true`, hides the RGB/HSV channel inputs.
          */
         "channelsDisabled": boolean;
         /**
@@ -943,7 +943,7 @@ export namespace Components {
          */
         "format": Format;
         /**
-          * When true, hides the hex input
+          * When `true`, hides the hex input.
          */
         "hexDisabled": boolean;
         /**
@@ -974,7 +974,7 @@ export namespace Components {
          */
         "numberingSystem": NumberingSystem;
         /**
-          * When true, hides the saved colors section
+          * When `true`, hides the saved colors section.
          */
         "savedDisabled": boolean;
         /**
@@ -999,11 +999,11 @@ export namespace Components {
     }
     interface CalciteColorPickerHexInput {
         /**
-          * When `false`, an empty color (`null`) will be allowed as a `value`. Otherwise, a color value is enforced on the component.  When `true`, a color value is enforced, and clearing the input or blurring will restore the last valid `value`. When `false`, an empty color (`null`) will be allowed as a `value`.
+          * When `true`, an empty color (`null`) will be allowed as a `value`.  When `false`, a color value is enforced, and clearing the input or blurring will restore the last valid `value`.
          */
         "allowEmpty": boolean;
         /**
-          * When true, the component will allow updates to the color's alpha value.
+          * When `true`, the component will allow updates to the color's alpha value.
          */
         "alphaChannel": boolean;
         /**
@@ -1137,7 +1137,7 @@ export namespace Components {
          */
         "selectionDisplay": SelectionDisplay;
         /**
-          * Specifies the selection mode: - "multiple" allows any number of selected items (default), - "single" allows only one selection, - "single-persist" allow and require one open item, - "ancestors" is like multiple, but shows ancestors of selected items as selected, with only deepest children shown in chips.
+          * Specifies the selection mode of the component, where:  `"multiple"` allows any number of selections,  `"single"` allows only one selection,  `"single-persist"` allows one selection and prevents de-selection, and  `"ancestors"` allows multiple selections, but shows ancestors of selected items as selected, with only deepest children shown in chips.
          */
         "selectionMode": Extract<
     "single" | "single-persist" | "ancestors" | "multiple",
@@ -1202,7 +1202,7 @@ export namespace Components {
          */
         "selected": boolean;
         /**
-          * Specifies the selection mode: - "multiple" allows any number of selected items (default), - "single" allows only one selection, - "single-persist" allow and require one open item, - "ancestors" is like multiple, but shows ancestors of selected items as selected, with only deepest children shown in chips.
+          * Specifies the selection mode of the component, where:  `"multiple"` allows any number of selections,  `"single"` allows only one selection,  `"single-persist"` allows one selection and prevents de-selection, and  `"ancestors"` allows multiple selections, but shows ancestors of selected items as selected, with only deepest children shown in chips.
          */
         "selectionMode": Extract<
     "single" | "single-persist" | "ancestors" | "multiple",
@@ -1327,11 +1327,11 @@ export namespace Components {
          */
         "disabled": boolean;
         /**
-          * Date is the end of date range
+          * Date is the end of date range.
          */
         "endOfRange": boolean;
         /**
-          * Date is currently highlighted as part of the range
+          * Date is currently highlighted as part of the range,
          */
         "highlighted": boolean;
         /**
@@ -1343,7 +1343,7 @@ export namespace Components {
          */
         "rangeEdge": "start" | "end" | undefined;
         /**
-          * Date is being hovered and within the set range
+          * Date is being hovered and within the set range.
          */
         "rangeHover": boolean;
         /**
@@ -1355,7 +1355,7 @@ export namespace Components {
          */
         "selected": boolean;
         /**
-          * Date is the start of date range
+          * Date is the start of date range.
          */
         "startOfRange": boolean;
         /**
@@ -1365,7 +1365,7 @@ export namespace Components {
     }
     interface CalciteDatePickerMonth {
         /**
-          * Date currently active.
+          * The currently active Date.
          */
         "activeDate": Date;
         /**
@@ -1373,15 +1373,15 @@ export namespace Components {
          */
         "dateTimeFormat": Intl.DateTimeFormat;
         /**
-          * End date currently active
+          * End date currently active.
          */
         "endDate"?: Date;
         /**
-          * The range of dates currently being hovered
+          * The range of dates currently being hovered.
          */
         "hoverRange": HoverRange;
         /**
-          * CLDR locale data for current locale
+          * CLDR locale data for current locale.
          */
         "localeData": DateLocaleData;
         /**
@@ -1407,7 +1407,7 @@ export namespace Components {
     }
     interface CalciteDatePickerMonthHeader {
         /**
-          * Focused date with indicator (will become selected date if user proceeds)
+          * The focused date is indicated and will become the selected date if the user proceeds.
          */
         "activeDate": Date;
         /**
@@ -1415,7 +1415,7 @@ export namespace Components {
          */
         "headingLevel": HeadingLevel;
         /**
-          * CLDR locale data for translated calendar info
+          * CLDR locale data for translated calendar info.
          */
         "localeData": DateLocaleData;
         /**
@@ -1507,7 +1507,7 @@ export namespace Components {
          */
         "scale": Scale;
         /**
-          * Specifies the selection mode for `calcite-dropdown-item` children, defaults to `single`: - `multiple` allows any number of selected items, - `single` allows only one selection (default), - `none` doesn't allow for any selection.
+          * Specifies the selection mode of the component, where:  `"multiple"` allows any number of selections,  `"single"` allows only one selection, and  `"none"` does not allow any selections.
          */
         "selectionMode": Extract<"none" | "single" | "multiple", SelectionMode>;
     }
@@ -1743,27 +1743,27 @@ export namespace Components {
     }
     interface CalciteGraph {
         /**
-          * Array of values describing a single color stop ([offset, color, opacity]) These color stops should be sorted by offset value
+          * Array of values describing a single color stop ([offset, color, opacity]) These color stops should be sorted by offset value.
          */
         "colorStops": ColorStop[];
         /**
-          * Array of tuples describing a single data point ([x, y]) These data points should be sorted by x-axis value
+          * Array of tuples describing a single data point ([x, y]) These data points should be sorted by x-axis value.
          */
         "data": DataSeries;
         /**
-          * End of highlight color if highlighting range
+          * End of highlight color if highlighting range.
          */
         "highlightMax": number;
         /**
-          * Start of highlight color if highlighting range
+          * Start of highlight color if highlighting range.
          */
         "highlightMin": number;
         /**
-          * Highest point of the range
+          * Highest point of the range.
          */
         "max": number;
         /**
-          * Lowest point of the range
+          * Lowest point of the range.
          */
         "min": number;
     }
@@ -1777,7 +1777,7 @@ export namespace Components {
          */
         "disabled": boolean;
         /**
-          * Value for the button title attribute
+          * Value for the button title attribute.
          */
         "dragHandle": string;
         "label": string;
@@ -1786,7 +1786,7 @@ export namespace Components {
          */
         "messageOverrides": Partial<HandleMessages>;
         /**
-          * Made into a prop for testing purposes only
+          * Made into a prop for testing purposes only.
          */
         "messages": HandleMessages;
         /**
@@ -2174,7 +2174,7 @@ export namespace Components {
          */
         "validationMessage": string;
         /**
-          * Selected date as a string in ISO format (YYYY-MM-DD)
+          * Selected date as a string in ISO format (`"yyyy-mm-dd"`).
          */
         "value": string | string[];
         /**
@@ -2616,7 +2616,7 @@ export namespace Components {
          */
         "messages": InputTimeZoneMessages;
         /**
-          * This specifies the type of `value` and the associated options presented to the user:  Using `"offset"` will provide options related
+          * This specifies the type of `value` and the associated options presented to the user:  Using `"offset"` will provide options that show timezone offsets.  Using `"name"` will provide options that show the IANA time zone names.
           * @default "offset"
          */
         "mode": TimeZoneMode;
@@ -2800,7 +2800,7 @@ export namespace Components {
          */
         "selectionAppearance": SelectionAppearance;
         /**
-          * Specifies the selection mode - `"multiple"` (allow any number of selected items), `"single"` (allow one selected item), `"single-persist"` (allow one selected item and prevent de-selection), or `"none"` (no selected items).
+          * Specifies the selection mode of the component, where:  `"multiple"` allows any number of selections,  `"single"` allows only one selection,  `"single-persist"` allows one selection and prevents de-selection, and  `"none"` does not allow any selections.
          */
         "selectionMode": Extract<
     "none" | "multiple" | "single" | "single-persist",
@@ -2845,6 +2845,10 @@ export namespace Components {
           * When `true`, the component's drag handle is selected.
          */
         "dragSelected": boolean;
+        /**
+          * Hides the component when filtered.
+         */
+        "filterHidden": boolean;
         /**
           * The label text of the component. Displays above the description text.
          */
@@ -2902,6 +2906,10 @@ export namespace Components {
           * When `true`, interaction is prevented and the component is displayed with lower opacity.
          */
         "disabled": boolean;
+        /**
+          * Hides the component when filtered.
+         */
+        "filterHidden": boolean;
         /**
           * The header text for all nested `calcite-list-item` rows.
          */
@@ -3068,7 +3076,7 @@ export namespace Components {
          */
         "numberingSystem": NumberingSystem;
         /**
-          * When either `rangeLabels` is `true`, specifies the format of displayed labels.
+          * When `rangeLabels` is `true`, specifies the format of displayed labels.
          */
         "rangeLabelType": MeterLabelType;
         /**
@@ -3080,7 +3088,7 @@ export namespace Components {
          */
         "scale": Scale;
         /**
-          * When `labelType` is `"units"` and either `valueLabel` or `rangeLabels` are `true`, displays beside the `value` and/or  `min` values.
+          * When `rangeLabelType` is `"units"` and either `valueLabel` or `rangeLabels` are `true`, displays beside the `value` and/or  `min` values.
          */
         "unitLabel": string;
         /**
@@ -3092,7 +3100,7 @@ export namespace Components {
          */
         "valueLabel": boolean;
         /**
-          * When either `valueLabel` is `true`, specifies the format of displayed label.
+          * When `valueLabel` is `true`, specifies the format of displayed label.
          */
         "valueLabelType": MeterLabelType;
     }
@@ -3118,11 +3126,11 @@ export namespace Components {
          */
         "focusTrapDisabled": boolean;
         /**
-          * Sets the component to always be fullscreen (overrides `widthScale` and `--calcite-modal-width` / `--calcite-modal-height`).
+          * Sets the component to always be fullscreen. Overrides `widthScale` and `--calcite-modal-width` / `--calcite-modal-height`.
          */
         "fullscreen": boolean;
         /**
-          * Specifies the kind of the component (will apply to top border).
+          * Specifies the kind of the component, which will apply to top border.
          */
         "kind": Extract<"brand" | "danger" | "info" | "success" | "warning", Kind>;
         /**
@@ -3182,13 +3190,13 @@ export namespace Components {
          */
         "navigationAction": boolean;
         /**
-          * When `navigation-action` is `true`, sets focus on the component's action element.
+          * When `navigationAction` is `true`, sets focus on the component's action element.
          */
         "setFocus": () => Promise<void>;
     }
     interface CalciteNavigationLogo {
         /**
-          * When true, the component is highlighted.
+          * When `true`, the component is highlighted.
          */
         "active": boolean;
         /**
@@ -3236,7 +3244,7 @@ export namespace Components {
     }
     interface CalciteNavigationUser {
         /**
-          * When true, the component is highlighted.
+          * When `true`, the component is highlighted.
          */
         "active": boolean;
         /**
@@ -3282,7 +3290,7 @@ export namespace Components {
          */
         "iconFlipRtl": boolean;
         /**
-          * Specifies the kind of the component (will apply to top border and icon).
+          * Specifies the kind of the component, which will apply to top border and icon.
          */
         "kind": Extract<
     "brand" | "danger" | "info" | "success" | "warning",
@@ -3473,12 +3481,12 @@ export namespace Components {
          */
         "filterText": string;
         /**
-          * The currently filtered data.
+          * The component's filtered data.
           * @readonly
          */
         "filteredData": ItemData1;
         /**
-          * The currently filtered items.
+          * The component's filtered items.
           * @readonly
          */
         "filteredItems": HTMLCalcitePickListItemElement[];
@@ -3591,7 +3599,7 @@ export namespace Components {
          */
         "autoClose": boolean;
         /**
-          * When `true`, display a close button within the component.
+          * When `true`, displays a close button within the component.
          */
         "closable": boolean;
         /**
@@ -4036,7 +4044,7 @@ export namespace Components {
          */
         "position": LogicalFlowPosition;
         /**
-          * Sets focus on the component's "close" button (the first focusable item).
+          * Sets focus on the component's "close" button - the first focusable item.
          */
         "setFocus": () => Promise<void>;
         /**
@@ -4079,12 +4087,12 @@ export namespace Components {
         "collapsed": boolean;
         /**
           * When `true`, the content area displays like a floating panel.
-          * @deprecated use `displayMode` instead.
+          * @deprecated Use `displayMode` instead.
          */
         "detached": boolean;
         /**
           * When `displayMode` is `float`, specifies the maximum height of the component.
-          * @deprecated use `heightScale` instead.
+          * @deprecated Use `heightScale` instead.
          */
         "detachedHeightScale": Scale;
         /**
@@ -4286,7 +4294,7 @@ export namespace Components {
          */
         "dropdownLabel": string;
         /**
-          * Specifies the kind of the component (will apply to border and background if applicable).
+          * Specifies the kind of the component, which will apply to border and background, if applicable.
          */
         "kind": Extract<"brand" | "danger" | "inverse" | "neutral", Kind>;
         /**
@@ -4526,7 +4534,7 @@ export namespace Components {
          */
         "scale": Scale;
         /**
-          * Specifies the component's selected tab-title.
+          * Specifies the component's selected `calcite-tab-title`.
           * @readonly
          */
         "selectedTitle": HTMLCalciteTabTitleElement;
@@ -4635,7 +4643,7 @@ export namespace Components {
          */
         "numberingSystem"?: NumberingSystem;
         /**
-          * Specifies the page size of the component. When `true`, renders `calcite-pagination`
+          * Specifies the page size of the component. When `true`, renders `calcite-pagination`.
          */
         "pageSize": number;
         /**
@@ -4648,7 +4656,7 @@ export namespace Components {
          */
         "selectedItems": HTMLCalciteTableRowElement[];
         /**
-          * Specifies the selection mode of the component.
+          * Specifies the selection mode of the component, where:  `"multiple"` allows any number of selections,  `"single"` allows only one selection, and  `"none"` does not allow any selections.
          */
         "selectionMode": Extract<"none" | "multiple" | "single", SelectionMode>;
         /**
@@ -4779,11 +4787,11 @@ export namespace Components {
          */
         "layout": TabLayout;
         /**
-          * Specifies the position of `calcite-tab-nav` and `calcite-tab-title` components in relation to the `calcite-tabs`, defaults to `top`.
+          * Specifies the position of `calcite-tab-nav` and `calcite-tab-title` components in relation to the `calcite-tabs`.
          */
         "position": TabPosition;
         /**
-          * Specifies the size of the component, defaults to `m`.
+          * Specifies the size of the component.
          */
         "scale": Scale;
     }
@@ -4984,7 +4992,7 @@ export namespace Components {
          */
         "setFocus": () => Promise<void>;
         /**
-          * The selection mode of the component.  Use radio for single selection, and checkbox for multiple selections.
+          * The selection mode of the component.  Use `"radio"` for single selection, and `"checkbox"` for multiple selections.
          */
         "type": TileSelectType;
         /**
@@ -5142,7 +5150,7 @@ export namespace Components {
     interface CalciteTree {
         "child": boolean;
         /**
-          * Displays indentation guide lines.
+          * When `true`, displays indentation guide lines.
          */
         "lines": boolean;
         /**
@@ -5197,7 +5205,7 @@ export namespace Components {
      */
     interface CalciteValueList {
         /**
-          * When provided, the method will be called to determine whether the element can  move from the list.
+          * When provided, the method will be called to determine whether the element can move from the list.
          */
         "canPull": (detail: DragDetail) => boolean;
         /**
@@ -5235,7 +5243,7 @@ export namespace Components {
          */
         "filteredItems": HTMLCalciteValueListItemElement[];
         /**
-          * Returns the currently selected items
+          * Returns the component's selected items.
          */
         "getSelectedItems": () => Promise<Map<string, HTMLCalciteValueListItemElement>>;
         /**
@@ -7410,7 +7418,7 @@ declare namespace LocalJSX {
          */
         "scale"?: Scale;
         /**
-          * Specifies the selection mode - `"multiple"` (allow any number of open items), `"single"` (allow one open item), or `"single-persist"` (allow and require one open item).
+          * Specifies the selection mode of the component, where:  `"multiple"` allows any number of selections,  `"single"` allows only one selection, and  `"single-persist"` allows one selection and prevents de-selection.
          */
         "selectionMode"?: Extract<
     "single" | "single-persist" | "multiple",
@@ -7523,7 +7531,7 @@ declare namespace LocalJSX {
          */
         "messageOverrides"?: Partial<ActionBarMessages>;
         /**
-          * Emits when the `expanded` property is toggled.
+          * Fires when the `expanded` property is toggled.
          */
         "onCalciteActionBarToggle"?: (event: CalciteActionBarCustomEvent<void>) => void;
         /**
@@ -7592,7 +7600,7 @@ declare namespace LocalJSX {
          */
         "label": string;
         /**
-          * Emits when the `open` property is toggled.
+          * Fires when the `open` property is toggled.
          */
         "onCalciteActionMenuOpen"?: (event: CalciteActionMenuCustomEvent<void>) => void;
         /**
@@ -7634,7 +7642,7 @@ declare namespace LocalJSX {
          */
         "messageOverrides"?: Partial<ActionPadMessages>;
         /**
-          * Emits when the `expanded` property is toggled.
+          * Fires when the `expanded` property is toggled.
          */
         "onCalciteActionPadToggle"?: (event: CalciteActionPadCustomEvent<void>) => void;
         /**
@@ -7787,8 +7795,8 @@ declare namespace LocalJSX {
          */
         "onCalciteBlockOpen"?: (event: CalciteBlockCustomEvent<void>) => void;
         /**
-          * Emits when the component's header is clicked.
-          * @deprecated use `openClose` events: `calciteBlock[Before]Open` and `calciteBlock[Before]Close` instead.
+          * Fires when the component's header is clicked.
+          * @deprecated Use `openClose` events such as `calciteBlockOpen`, `calciteBlockClose`, `calciteBlockBeforeOpen`, and `calciteBlockBeforeClose` instead.
          */
         "onCalciteBlockToggle"?: (event: CalciteBlockCustomEvent<void>) => void;
         /**
@@ -7806,7 +7814,7 @@ declare namespace LocalJSX {
          */
         "messageOverrides"?: Partial<BlockSectionMessages>;
         /**
-          * Emits when the header has been clicked.
+          * Fires when the header has been clicked.
          */
         "onCalciteBlockSectionToggle"?: (event: CalciteBlockSectionCustomEvent<void>) => void;
         /**
@@ -7822,7 +7830,7 @@ declare namespace LocalJSX {
          */
         "text"?: string;
         /**
-          * Specifies the component's toggle display -  `"button"` (selectable header), or  `"switch"` (toggle switch).
+          * Specifies how the component's toggle is displayed -  `"button"` (selectable header), or  `"switch"` (toggle switch).
          */
         "toggleDisplay"?: BlockSectionToggleDisplay;
     }
@@ -7863,7 +7871,7 @@ declare namespace LocalJSX {
          */
         "iconStart"?: string;
         /**
-          * Specifies the kind of the component (will apply to border and background if applicable).
+          * Specifies the kind of the component, which will apply to the border and background if applicable.
          */
         "kind"?: Extract<"brand" | "danger" | "inverse" | "neutral", Kind>;
         /**
@@ -7905,7 +7913,7 @@ declare namespace LocalJSX {
          */
         "target"?: string;
         /**
-          * Specifies the default behavior of the button.
+          * Specifies the default behavior of the component.
           * @mdn [type](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#attr-type)
          */
         "type"?: string;
@@ -7967,11 +7975,11 @@ declare namespace LocalJSX {
          */
         "label"?: string;
         /**
-          * Specifies the name of the component on form submission.
+          * Specifies the name of the component.  Required to pass the component's `value` on form submission.
          */
         "name"?: string;
         /**
-          * Emits when the component's `checked` status changes.
+          * Fires when the component's `checked` status changes.
          */
         "onCalciteCheckboxChange"?: (event: CalciteCheckboxCustomEvent<void>) => void;
         /**
@@ -8055,7 +8063,7 @@ declare namespace LocalJSX {
          */
         "label": string;
         /**
-          * Emits when the component's selection changes.
+          * Fires when the component's selection changes.
          */
         "onCalciteChipGroupSelect"?: (event: CalciteChipGroupCustomEvent<void>) => void;
         /**
@@ -8068,7 +8076,7 @@ declare namespace LocalJSX {
          */
         "selectedItems"?: HTMLCalciteChipElement[];
         /**
-          * Specifies the selection mode of the component.
+          * Specifies the selection mode of the component, where:  `"multiple"` allows any number of selections,  `"single"` allows only one selection,  `"single-persist"` allows one selection and prevents de-selection, and  `"none"` does not allow any selections.
          */
         "selectionMode"?: Extract<
     "multiple" | "single" | "single-persist" | "none",
@@ -8077,15 +8085,15 @@ declare namespace LocalJSX {
     }
     interface CalciteColorPicker {
         /**
-          * When `true`, an empty color (`null`) will be allowed as a `value`. When `false`, a color value is enforced, and clearing the input or blurring will restore the last valid `value`.
+          * When `true`, an empty color (`null`) will be allowed as a `value`.  When `false`, a color value is enforced, and clearing the input or blurring will restore the last valid `value`.
          */
         "allowEmpty"?: boolean;
         /**
-          * When true, the component will allow updates to the color's alpha value.
+          * When `true`, the component will allow updates to the color's alpha value.
          */
         "alphaChannel"?: boolean;
         /**
-          * When true, hides the RGB/HSV channel inputs
+          * When `true`, hides the RGB/HSV channel inputs.
          */
         "channelsDisabled"?: boolean;
         /**
@@ -8098,7 +8106,7 @@ declare namespace LocalJSX {
          */
         "format"?: Format;
         /**
-          * When true, hides the hex input
+          * When `true`, hides the hex input.
          */
         "hexDisabled"?: boolean;
         /**
@@ -8133,7 +8141,7 @@ declare namespace LocalJSX {
          */
         "onCalciteColorPickerInput"?: (event: CalciteColorPickerCustomEvent<void>) => void;
         /**
-          * When true, hides the saved colors section
+          * When `true`, hides the saved colors section.
          */
         "savedDisabled"?: boolean;
         /**
@@ -8154,11 +8162,11 @@ declare namespace LocalJSX {
     }
     interface CalciteColorPickerHexInput {
         /**
-          * When `false`, an empty color (`null`) will be allowed as a `value`. Otherwise, a color value is enforced on the component.  When `true`, a color value is enforced, and clearing the input or blurring will restore the last valid `value`. When `false`, an empty color (`null`) will be allowed as a `value`.
+          * When `true`, an empty color (`null`) will be allowed as a `value`.  When `false`, a color value is enforced, and clearing the input or blurring will restore the last valid `value`.
          */
         "allowEmpty"?: boolean;
         /**
-          * When true, the component will allow updates to the color's alpha value.
+          * When `true`, the component will allow updates to the color's alpha value.
          */
         "alphaChannel"?: boolean;
         /**
@@ -8302,7 +8310,7 @@ declare namespace LocalJSX {
          */
         "selectionDisplay"?: SelectionDisplay;
         /**
-          * Specifies the selection mode: - "multiple" allows any number of selected items (default), - "single" allows only one selection, - "single-persist" allow and require one open item, - "ancestors" is like multiple, but shows ancestors of selected items as selected, with only deepest children shown in chips.
+          * Specifies the selection mode of the component, where:  `"multiple"` allows any number of selections,  `"single"` allows only one selection,  `"single-persist"` allows one selection and prevents de-selection, and  `"ancestors"` allows multiple selections, but shows ancestors of selected items as selected, with only deepest children shown in chips.
          */
         "selectionMode"?: Extract<
     "single" | "single-persist" | "ancestors" | "multiple",
@@ -8355,7 +8363,7 @@ declare namespace LocalJSX {
          */
         "iconFlipRtl"?: boolean;
         /**
-          * Emits whenever the component is selected or unselected.
+          * Fires whenever the component is selected or unselected.
          */
         "onCalciteComboboxItemChange"?: (event: CalciteComboboxItemCustomEvent<void>) => void;
         /**
@@ -8419,11 +8427,11 @@ declare namespace LocalJSX {
          */
         "numberingSystem"?: NumberingSystem;
         /**
-          * Emits when a user changes the component's date. For `range` events, use `calciteDatePickerRangeChange`.
+          * Fires when a user changes the component's date. For `range` events, use `calciteDatePickerRangeChange`.
          */
         "onCalciteDatePickerChange"?: (event: CalciteDatePickerCustomEvent<void>) => void;
         /**
-          * Emits when a user changes the component's date `range`. For components without `range` use `calciteDatePickerChange`.
+          * Fires when a user changes the component's date `range`. For components without `range` use `calciteDatePickerChange`.
          */
         "onCalciteDatePickerRangeChange"?: (event: CalciteDatePickerCustomEvent<void>) => void;
         /**
@@ -8465,15 +8473,15 @@ declare namespace LocalJSX {
          */
         "disabled"?: boolean;
         /**
-          * Date is the end of date range
+          * Date is the end of date range.
          */
         "endOfRange"?: boolean;
         /**
-          * Date is currently highlighted as part of the range
+          * Date is currently highlighted as part of the range,
          */
         "highlighted"?: boolean;
         /**
-          * Emitted when user selects day
+          * Fires when user selects day.
          */
         "onCalciteDaySelect"?: (event: CalciteDatePickerDayCustomEvent<void>) => void;
         /**
@@ -8481,7 +8489,7 @@ declare namespace LocalJSX {
          */
         "range"?: boolean;
         /**
-          * Date is being hovered and within the set range
+          * Date is being hovered and within the set range.
          */
         "rangeHover"?: boolean;
         /**
@@ -8493,7 +8501,7 @@ declare namespace LocalJSX {
          */
         "selected"?: boolean;
         /**
-          * Date is the start of date range
+          * Date is the start of date range.
          */
         "startOfRange"?: boolean;
         /**
@@ -8503,15 +8511,15 @@ declare namespace LocalJSX {
     }
     interface CalciteDatePickerMonth {
         /**
-          * Date currently active.
+          * The currently active Date.
          */
         "activeDate"?: Date;
         /**
-          * End date currently active
+          * End date currently active.
          */
         "endDate"?: Date;
         /**
-          * The range of dates currently being hovered
+          * The range of dates currently being hovered.
          */
         "hoverRange"?: HoverRange;
         /**
@@ -8537,7 +8545,7 @@ declare namespace LocalJSX {
     }
     interface CalciteDatePickerMonthHeader {
         /**
-          * Focused date with indicator (will become selected date if user proceeds)
+          * The focused date is indicated and will become the selected date if the user proceeds.
          */
         "activeDate"?: Date;
         /**
@@ -8545,7 +8553,7 @@ declare namespace LocalJSX {
          */
         "headingLevel"?: HeadingLevel;
         /**
-          * CLDR locale data for translated calendar info
+          * CLDR locale data for translated calendar info.
          */
         "localeData"?: DateLocaleData;
         /**
@@ -8639,7 +8647,7 @@ declare namespace LocalJSX {
          */
         "groupTitle"?: string;
         /**
-          * Specifies the selection mode for `calcite-dropdown-item` children, defaults to `single`: - `multiple` allows any number of selected items, - `single` allows only one selection (default), - `none` doesn't allow for any selection.
+          * Specifies the selection mode of the component, where:  `"multiple"` allows any number of selections,  `"single"` allows only one selection, and  `"none"` does not allow any selections.
          */
         "selectionMode"?: Extract<"none" | "single" | "multiple", SelectionMode>;
     }
@@ -8747,7 +8755,7 @@ declare namespace LocalJSX {
          */
         "messageOverrides"?: Partial<FilterMessages>;
         /**
-          * This event fires when the filter text changes.
+          * Fires when the filter text changes.
          */
         "onCalciteFilterChange"?: (event: CalciteFilterCustomEvent<void>) => void;
         /**
@@ -8833,27 +8841,27 @@ declare namespace LocalJSX {
     }
     interface CalciteGraph {
         /**
-          * Array of values describing a single color stop ([offset, color, opacity]) These color stops should be sorted by offset value
+          * Array of values describing a single color stop ([offset, color, opacity]) These color stops should be sorted by offset value.
          */
         "colorStops"?: ColorStop[];
         /**
-          * Array of tuples describing a single data point ([x, y]) These data points should be sorted by x-axis value
+          * Array of tuples describing a single data point ([x, y]) These data points should be sorted by x-axis value.
          */
         "data"?: DataSeries;
         /**
-          * End of highlight color if highlighting range
+          * End of highlight color if highlighting range.
          */
         "highlightMax"?: number;
         /**
-          * Start of highlight color if highlighting range
+          * Start of highlight color if highlighting range.
          */
         "highlightMin"?: number;
         /**
-          * Highest point of the range
+          * Highest point of the range.
          */
         "max": number;
         /**
-          * Lowest point of the range
+          * Lowest point of the range.
          */
         "min": number;
     }
@@ -8863,7 +8871,7 @@ declare namespace LocalJSX {
          */
         "disabled"?: boolean;
         /**
-          * Value for the button title attribute
+          * Value for the button title attribute.
          */
         "dragHandle"?: string;
         /**
@@ -8871,11 +8879,11 @@ declare namespace LocalJSX {
          */
         "messageOverrides"?: Partial<HandleMessages>;
         /**
-          * Emits whenever the component is selected or unselected.
+          * Fires whenever the component is selected or unselected.
          */
         "onCalciteHandleChange"?: (event: CalciteHandleCustomEvent<void>) => void;
         /**
-          * Emitted when the handle is selected and the up or down arrow key is pressed.
+          * Fires when the handle is selected and the up or down arrow key is pressed.
          */
         "onCalciteHandleNudge"?: (event: CalciteHandleCustomEvent<HandleNudge>) => void;
         /**
@@ -9251,7 +9259,7 @@ declare namespace LocalJSX {
          */
         "validationMessage"?: string;
         /**
-          * Selected date as a string in ISO format (YYYY-MM-DD)
+          * Selected date as a string in ISO format (`"yyyy-mm-dd"`).
          */
         "value"?: string | string[];
         /**
@@ -9678,7 +9686,7 @@ declare namespace LocalJSX {
          */
         "messageOverrides"?: Partial<InputTimeZoneMessages>;
         /**
-          * This specifies the type of `value` and the associated options presented to the user:  Using `"offset"` will provide options related
+          * This specifies the type of `value` and the associated options presented to the user:  Using `"offset"` will provide options that show timezone offsets.  Using `"name"` will provide options that show the IANA time zone names.
           * @default "offset"
          */
         "mode"?: TimeZoneMode;
@@ -9841,27 +9849,27 @@ declare namespace LocalJSX {
          */
         "numberingSystem"?: NumberingSystem;
         /**
-          * Emitted when the default slot has changes in order to notify parent lists.
+          * Fires when the default slot has changes in order to notify parent lists.
          */
         "onCalciteInternalListDefaultSlotChange"?: (event: CalciteListCustomEvent<void>) => void;
         /**
-          * Emits when any of the list item selections have changed.
+          * Fires when the component's selected items have changed.
          */
         "onCalciteListChange"?: (event: CalciteListCustomEvent<void>) => void;
         /**
-          * Emits when the component's dragging has ended.
+          * Fires when the component's dragging has ended.
          */
         "onCalciteListDragEnd"?: (event: CalciteListCustomEvent<ListDragDetail>) => void;
         /**
-          * Emits when the component's dragging has started.
+          * Fires when the component's dragging has started.
          */
         "onCalciteListDragStart"?: (event: CalciteListCustomEvent<ListDragDetail>) => void;
         /**
-          * Emits when the component's filter has changed.
+          * Fires when the component's filter has changed.
          */
         "onCalciteListFilter"?: (event: CalciteListCustomEvent<void>) => void;
         /**
-          * Emitted when the order of the list has changed.
+          * Fires when the component's item order changes.
          */
         "onCalciteListOrderChange"?: (event: CalciteListCustomEvent<ListDragDetail>) => void;
         /**
@@ -9874,7 +9882,7 @@ declare namespace LocalJSX {
          */
         "selectionAppearance"?: SelectionAppearance;
         /**
-          * Specifies the selection mode - `"multiple"` (allow any number of selected items), `"single"` (allow one selected item), `"single-persist"` (allow one selected item and prevent de-selection), or `"none"` (no selected items).
+          * Specifies the selection mode of the component, where:  `"multiple"` allows any number of selections,  `"single"` allows only one selection,  `"single-persist"` allows one selection and prevents de-selection, and  `"none"` does not allow any selections.
          */
         "selectionMode"?: Extract<
     "none" | "multiple" | "single" | "single-persist",
@@ -9927,7 +9935,7 @@ declare namespace LocalJSX {
          */
         "onCalciteListItemDragHandleChange"?: (event: CalciteListItemCustomEvent<void>) => void;
         /**
-          * Emits when the item's content is selected.
+          * Fires when the component is selected.
          */
         "onCalciteListItemSelect"?: (event: CalciteListItemCustomEvent<void>) => void;
         /**
@@ -9957,7 +9965,7 @@ declare namespace LocalJSX {
          */
         "heading"?: string;
         /**
-          * Emitted when the default slot has changes in order to notify parent lists.
+          * Fires when changes occur in the default slot, notifying parent lists of the changes.
          */
         "onCalciteInternalListItemGroupDefaultSlotChange"?: (event: CalciteListItemGroupCustomEvent<DragEvent>) => void;
     }
@@ -10107,7 +10115,7 @@ declare namespace LocalJSX {
          */
         "numberingSystem"?: NumberingSystem;
         /**
-          * When either `rangeLabels` is `true`, specifies the format of displayed labels.
+          * When `rangeLabels` is `true`, specifies the format of displayed labels.
          */
         "rangeLabelType"?: MeterLabelType;
         /**
@@ -10119,7 +10127,7 @@ declare namespace LocalJSX {
          */
         "scale"?: Scale;
         /**
-          * When `labelType` is `"units"` and either `valueLabel` or `rangeLabels` are `true`, displays beside the `value` and/or  `min` values.
+          * When `rangeLabelType` is `"units"` and either `valueLabel` or `rangeLabels` are `true`, displays beside the `value` and/or  `min` values.
          */
         "unitLabel"?: string;
         /**
@@ -10131,7 +10139,7 @@ declare namespace LocalJSX {
          */
         "valueLabel"?: boolean;
         /**
-          * When either `valueLabel` is `true`, specifies the format of displayed label.
+          * When `valueLabel` is `true`, specifies the format of displayed label.
          */
         "valueLabelType"?: MeterLabelType;
     }
@@ -10157,11 +10165,11 @@ declare namespace LocalJSX {
          */
         "focusTrapDisabled"?: boolean;
         /**
-          * Sets the component to always be fullscreen (overrides `widthScale` and `--calcite-modal-width` / `--calcite-modal-height`).
+          * Sets the component to always be fullscreen. Overrides `widthScale` and `--calcite-modal-width` / `--calcite-modal-height`.
          */
         "fullscreen"?: boolean;
         /**
-          * Specifies the kind of the component (will apply to top border).
+          * Specifies the kind of the component, which will apply to top border.
          */
         "kind"?: Extract<"brand" | "danger" | "info" | "success" | "warning", Kind>;
         /**
@@ -10211,13 +10219,13 @@ declare namespace LocalJSX {
          */
         "navigationAction"?: boolean;
         /**
-          * When `navigationAction` is true, emits when the displayed action selection changes.
+          * When `navigationAction` is `true`, emits when the displayed action selection changes.
          */
         "onCalciteNavigationActionSelect"?: (event: CalciteNavigationCustomEvent<void>) => void;
     }
     interface CalciteNavigationLogo {
         /**
-          * When true, the component is highlighted.
+          * When `true`, the component is highlighted.
          */
         "active"?: boolean;
         /**
@@ -10261,7 +10269,7 @@ declare namespace LocalJSX {
     }
     interface CalciteNavigationUser {
         /**
-          * When true, the component is highlighted.
+          * When `true`, the component is highlighted.
          */
         "active"?: boolean;
         /**
@@ -10303,7 +10311,7 @@ declare namespace LocalJSX {
          */
         "iconFlipRtl"?: boolean;
         /**
-          * Specifies the kind of the component (will apply to top border and icon).
+          * Specifies the kind of the component, which will apply to top border and icon.
          */
         "kind"?: Extract<
     "brand" | "danger" | "info" | "success" | "warning",
@@ -10483,12 +10491,12 @@ declare namespace LocalJSX {
          */
         "filterText"?: string;
         /**
-          * The currently filtered data.
+          * The component's filtered data.
           * @readonly
          */
         "filteredData"?: ItemData1;
         /**
-          * The currently filtered items.
+          * The component's filtered items.
           * @readonly
          */
         "filteredItems"?: HTMLCalcitePickListItemElement[];
@@ -10599,7 +10607,7 @@ declare namespace LocalJSX {
          */
         "autoClose"?: boolean;
         /**
-          * When `true`, display a close button within the component.
+          * When `true`, displays a close button within the component.
          */
         "closable"?: boolean;
         /**
@@ -11041,12 +11049,12 @@ declare namespace LocalJSX {
         "collapsed"?: boolean;
         /**
           * When `true`, the content area displays like a floating panel.
-          * @deprecated use `displayMode` instead.
+          * @deprecated Use `displayMode` instead.
          */
         "detached"?: boolean;
         /**
           * When `displayMode` is `float`, specifies the maximum height of the component.
-          * @deprecated use `heightScale` instead.
+          * @deprecated Use `heightScale` instead.
          */
         "detachedHeightScale"?: Scale;
         /**
@@ -11149,11 +11157,11 @@ declare namespace LocalJSX {
          */
         "numberingSystem"?: NumberingSystem;
         /**
-          * Fires when the thumb is released on the component.  **Note:** If you need to constantly listen to the drag event, use `calciteSliderInput` instead.
+          * Fires when the thumb is released on the component.  Note: To constantly listen to the drag event, use `calciteSliderInput` instead.
          */
         "onCalciteSliderChange"?: (event: CalciteSliderCustomEvent<void>) => void;
         /**
-          * Fires on all updates to the component.  **Note:** Will be fired frequently during drag. If you are performing any expensive operations consider using a debounce or throttle to avoid locking up the main thread.
+          * Fires on all updates to the component.  Note: Fires frequently during drag. To perform expensive operations consider using a debounce or throttle to avoid locking up the main thread.
          */
         "onCalciteSliderInput"?: (event: CalciteSliderCustomEvent<void>) => void;
         /**
@@ -11248,7 +11256,7 @@ declare namespace LocalJSX {
          */
         "dropdownLabel"?: string;
         /**
-          * Specifies the kind of the component (will apply to border and background if applicable).
+          * Specifies the kind of the component, which will apply to border and background, if applicable.
          */
         "kind"?: Extract<"brand" | "danger" | "inverse" | "neutral", Kind>;
         /**
@@ -11421,7 +11429,7 @@ declare namespace LocalJSX {
          */
         "onCalciteTabChange"?: (event: CalciteTabNavCustomEvent<void>) => void;
         /**
-          * Specifies the component's selected tab-title.
+          * Specifies the component's selected `calcite-tab-title`.
           * @readonly
          */
         "selectedTitle"?: HTMLCalciteTabTitleElement;
@@ -11518,7 +11526,7 @@ declare namespace LocalJSX {
          */
         "onCalciteTableSelect"?: (event: CalciteTableCustomEvent<void>) => void;
         /**
-          * Specifies the page size of the component. When `true`, renders `calcite-pagination`
+          * Specifies the page size of the component. When `true`, renders `calcite-pagination`.
          */
         "pageSize"?: number;
         /**
@@ -11531,7 +11539,7 @@ declare namespace LocalJSX {
          */
         "selectedItems"?: HTMLCalciteTableRowElement[];
         /**
-          * Specifies the selection mode of the component.
+          * Specifies the selection mode of the component, where:  `"multiple"` allows any number of selections,  `"single"` allows only one selection, and  `"none"` does not allow any selections.
          */
         "selectionMode"?: Extract<"none" | "multiple" | "single", SelectionMode>;
         /**
@@ -11612,11 +11620,11 @@ declare namespace LocalJSX {
          */
         "layout"?: TabLayout;
         /**
-          * Specifies the position of `calcite-tab-nav` and `calcite-tab-title` components in relation to the `calcite-tabs`, defaults to `top`.
+          * Specifies the position of `calcite-tab-nav` and `calcite-tab-title` components in relation to the `calcite-tabs`.
          */
         "position"?: TabPosition;
         /**
-          * Specifies the size of the component, defaults to `m`.
+          * Specifies the size of the component.
          */
         "scale"?: Scale;
     }
@@ -11809,7 +11817,7 @@ declare namespace LocalJSX {
          */
         "onCalciteTileSelectChange"?: (event: CalciteTileSelectCustomEvent<void>) => void;
         /**
-          * The selection mode of the component.  Use radio for single selection, and checkbox for multiple selections.
+          * The selection mode of the component.  Use `"radio"` for single selection, and `"checkbox"` for multiple selections.
          */
         "type"?: TileSelectType;
         /**
@@ -11961,7 +11969,7 @@ declare namespace LocalJSX {
     }
     interface CalciteTree {
         /**
-          * Displays indentation guide lines.
+          * When `true`, displays indentation guide lines.
          */
         "lines"?: boolean;
         /**
@@ -12010,7 +12018,7 @@ declare namespace LocalJSX {
      */
     interface CalciteValueList {
         /**
-          * When provided, the method will be called to determine whether the element can  move from the list.
+          * When provided, the method will be called to determine whether the element can move from the list.
          */
         "canPull"?: (detail: DragDetail) => boolean;
         /**