@nasa-terra/components 0.0.6 → 0.0.7

package/dist/types/vue/index.d.ts

@@ -1,17 +1,67 @@
 import type { DefineComponent } from "vue";
 
-import type { TerraButton } from "../../components/button/button.component.js";
-import type { TerraChip } from "../../components/chip/chip.component.js";
-import type { TerraDateRangeSlider } from "../../components/date-range-slider/date-range-slider.component.js";
 import type { TerraCombobox } from "../../components/combobox/combobox.component.js";
-import type { TerraLoader } from "../../components/loader/loader.component.js";
+import type { TerraDateRangeSlider } from "../../components/date-range-slider/date-range-slider.component.js";
+import type { TerraChip } from "../../components/chip/chip.component.js";
+import type { TerraButton } from "../../components/button/button.component.js";
 import type { TerraIcon } from "../../components/icon/icon.component.js";
+import type { TerraLoader } from "../../components/loader/loader.component.js";
 import type { TerraMap } from "../../components/map/map.component.js";
 import type { TerraPlot } from "../../components/plot/plot.component.js";
 import type { TerraSpatialPicker } from "../../components/spatial-picker/spatial-picker.component.js";
 import type { TerraTimeSeries } from "../../components/time-series/time-series.component.js";
 import type { TerraVariableCombobox } from "../../components/variable-combobox/variable-combobox.component.js";
 
+type TerraComboboxProps = {
+  /** Label the combobox with this. */
+  label?: TerraCombobox["label"];
+  /** name the combobox with this. */
+  name?: TerraCombobox["name"];
+  /** Set a placeholder for the combobox with this.
+Defaults to the label's value. */
+  placeholder?: TerraCombobox["placeholder"];
+  /** Hide the combobox's help text.
+When hidden, not rendered at all. */
+  "hide-help"?: TerraCombobox["hideHelp"];
+  /** Hide the combobox's label text.
+When hidden, still presents to screen readers. */
+  "hide-label"?: TerraCombobox["hideLabel"];
+  /** status of the content */
+  status?: TerraCombobox["status"];
+  /** content or data of the combobox. This could be of type string | GroupedListItem[] | ListItem[] | undefined */
+  content?: TerraCombobox["content"];
+  /**  */
+  isExpanded?: TerraCombobox["isExpanded"];
+  /**  */
+  query?: TerraCombobox["query"];
+  /**  */
+  searchResults?: TerraCombobox["searchResults"];
+};
+
+type TerraDateRangeSliderProps = {
+  /**  */
+  "time-scale"?: TerraDateRangeSlider["timeScale"];
+  /**  */
+  "min-date"?: TerraDateRangeSlider["minDate"];
+  /**  */
+  "max-date"?: TerraDateRangeSlider["maxDate"];
+  /** The start date for the time series plot. */
+  "start-date"?: TerraDateRangeSlider["startDate"];
+  /**  */
+  "end-date"?: TerraDateRangeSlider["endDate"];
+  /**  */
+  disabled?: TerraDateRangeSlider["disabled"];
+  /**  */
+  "has-pips"?: TerraDateRangeSlider["hasPips"];
+  /**  */
+  slider?: TerraDateRangeSlider["slider"];
+};
+
+type TerraChipProps = {
+  /**  */
+  size?: TerraChip["size"];
+};
+
 type TerraButtonProps = {
   /**  */
   title?: TerraButton["title"];
@@ -75,71 +125,6 @@ value of this attribute must be an id of a form in the same document or shadow r
   validationMessage?: TerraButton["validationMessage"];
 };
 
-type TerraChipProps = {
-  /**  */
-  size?: TerraChip["size"];
-};
-
-type TerraDateRangeSliderProps = {
-  /**  */
-  "time-scale"?: TerraDateRangeSlider["timeScale"];
-  /**  */
-  "min-date"?: TerraDateRangeSlider["minDate"];
-  /**  */
-  "max-date"?: TerraDateRangeSlider["maxDate"];
-  /** The start date for the time series plot. */
-  "start-date"?: TerraDateRangeSlider["startDate"];
-  /**  */
-  "end-date"?: TerraDateRangeSlider["endDate"];
-  /**  */
-  disabled?: TerraDateRangeSlider["disabled"];
-  /**  */
-  "has-pips"?: TerraDateRangeSlider["hasPips"];
-  /**  */
-  slider?: TerraDateRangeSlider["slider"];
-};
-
-type TerraComboboxProps = {
-  /** Label the combobox with this. */
-  label?: TerraCombobox["label"];
-  /** name the combobox with this. */
-  name?: TerraCombobox["name"];
-  /** Set a placeholder for the combobox with this.
-Defaults to the label's value. */
-  placeholder?: TerraCombobox["placeholder"];
-  /** Hide the combobox's help text.
-When hidden, not rendered at all. */
-  "hide-help"?: TerraCombobox["hideHelp"];
-  /** Hide the combobox's label text.
-When hidden, still presents to screen readers. */
-  "hide-label"?: TerraCombobox["hideLabel"];
-  /** status of the content */
-  status?: TerraCombobox["status"];
-  /** content or data of the combobox. This could be of type string | GroupedListItem[] | ListItem[] | undefined */
-  content?: TerraCombobox["content"];
-  /**  */
-  isExpanded?: TerraCombobox["isExpanded"];
-  /**  */
-  query?: TerraCombobox["query"];
-  /**  */
-  searchResults?: TerraCombobox["searchResults"];
-};
-
-type TerraLoaderProps = {
-  /** The loader's size */
-  size?: TerraLoader["size"];
-  /** The loader's theme, light or dark mode */
-  theme?: TerraLoader["theme"];
-  /** The percent complete for the loader to display */
-  percent?: TerraLoader["percent"];
-  /** an indeterminate loader has an unknown progress and will show a spinner */
-  indeterminate?: TerraLoader["indeterminate"];
-  /** A label used by a screen reader which describes the loader element (e.g., "Loading video of Tropical Storm Nepartak") */
-  label?: TerraLoader["label"];
-  /** A message used by a screen reader to describe current value of loader element in a more human-understandable way (e.g, "12% of 45MB") */
-  message?: TerraLoader["message"];
-};
-
 type TerraIconProps = {
   /** The name of the icon to draw. Available names depend on the icon library being used. */
   name?: TerraIcon["name"];
@@ -163,6 +148,21 @@ ignored by assistive devices. */
   onTerraError?: (e: CustomEvent<never>) => void;
 };
 
+type TerraLoaderProps = {
+  /** The loader's size */
+  size?: TerraLoader["size"];
+  /** The loader's theme, light or dark mode */
+  theme?: TerraLoader["theme"];
+  /** The percent complete for the loader to display */
+  percent?: TerraLoader["percent"];
+  /** an indeterminate loader has an unknown progress and will show a spinner */
+  indeterminate?: TerraLoader["indeterminate"];
+  /** A label used by a screen reader which describes the loader element (e.g., "Loading video of Tropical Storm Nepartak") */
+  label?: TerraLoader["label"];
+  /** A message used by a screen reader to describe current value of loader element in a more human-understandable way (e.g, "12% of 45MB") */
+  message?: TerraLoader["message"];
+};
+
 type TerraMapProps = {
   /** Minimum zoom level of the map. */
   "min-zoom"?: TerraMap["minZoom"];
@@ -284,43 +284,22 @@ When hidden, still presents to screen readers. */
 
 export type CustomElements = {
   /**
-   * Buttons represent actions that are available to the user.
+   * Fuzzy-search for combobox with list autocomplete.
    * ---
    *
    *
-   * ### **Methods:**
-   *  - **click()** - Simulates a click on the button.
-   * - **focus(options: _FocusOptions_)** - Sets focus on the button.
-   * - **blur()** - Removes focus from the button.
-   * - **checkValidity()** - Checks for validity but does not show a validation message. Returns `true` when valid and `false` when invalid.
-   * - **getForm(): _HTMLFormElement | null_** - Gets the associated form, if one exists.
-   * - **reportValidity()** - Checks for validity and shows the browser's validation message if the control is invalid.
-   * - **setCustomValidity(message: _string_)** - Sets a custom validation message. Pass an empty string to restore validity.
-   *
-   * ### **Slots:**
-   *  - _default_ - The button's label.
-   * - **prefix** - A presentational prefix icon or similar element.
-   * - **suffix** - A presentational suffix icon or similar element.
+   * ### **CSS Properties:**
+   *  - **--host-height** - The height of the host element. _(default: undefined)_
+   * - **--help-height** - The height of the search help element. _(default: undefined)_
+   * - **--label-height** - The height of the input's label element. _(default: undefined)_
    *
    * ### **CSS Parts:**
-   *  - **base** - The component's base wrapper.
-   * - **prefix** - The container that wraps the prefix.
-   * - **label** - The button's label.
-   * - **suffix** - The container that wraps the suffix.
-   * - **caret** - The button's caret icon, an `<sl-icon>` element.
-   * - **spinner** - The spinner that shows when the button is in the loading state.
-   */
-  "terra-button": DefineComponent<TerraButtonProps>;
-
-  /**
-   * Used for contacts and tags
-   * ---
-   *
-   *
-   * ### **Slots:**
-   *  - _default_ - The chip's label.
+   *  - **base** - A `search` element, the component's base.
+   * - **combobox** - An `input` element used for searching.
+   * - **button** - A `button` used for toggling the listbox's visibility.
+   * - **listbox** - A `ul` that holds the clickable options.
    */
-  "terra-chip": DefineComponent<TerraChipProps>;
+  "terra-combobox": DefineComponent<TerraComboboxProps>;
 
   /**
    * Short summary of the component's intended use.
@@ -340,35 +319,43 @@ export type CustomElements = {
   "terra-date-range-slider": DefineComponent<TerraDateRangeSliderProps>;
 
   /**
-   * Fuzzy-search for combobox with list autocomplete.
+   * Used for contacts and tags
    * ---
    *
    *
-   * ### **CSS Properties:**
-   *  - **--host-height** - The height of the host element. _(default: undefined)_
-   * - **--help-height** - The height of the search help element. _(default: undefined)_
-   * - **--label-height** - The height of the input's label element. _(default: undefined)_
-   *
-   * ### **CSS Parts:**
-   *  - **base** - A `search` element, the component's base.
-   * - **combobox** - An `input` element used for searching.
-   * - **button** - A `button` used for toggling the listbox's visibility.
-   * - **listbox** - A `ul` that holds the clickable options.
+   * ### **Slots:**
+   *  - _default_ - The chip's label.
    */
-  "terra-combobox": DefineComponent<TerraComboboxProps>;
+  "terra-chip": DefineComponent<TerraChipProps>;
 
   /**
-   * Loaders are used to indicate there is content that is loading.
+   * Buttons represent actions that are available to the user.
    * ---
    *
    *
-   * ### **CSS Properties:**
-   *  - **--example** - An example CSS custom property. _(default: undefined)_
+   * ### **Methods:**
+   *  - **click()** - Simulates a click on the button.
+   * - **focus(options: _FocusOptions_)** - Sets focus on the button.
+   * - **blur()** - Removes focus from the button.
+   * - **checkValidity()** - Checks for validity but does not show a validation message. Returns `true` when valid and `false` when invalid.
+   * - **getForm(): _HTMLFormElement | null_** - Gets the associated form, if one exists.
+   * - **reportValidity()** - Checks for validity and shows the browser's validation message if the control is invalid.
+   * - **setCustomValidity(message: _string_)** - Sets a custom validation message. Pass an empty string to restore validity.
+   *
+   * ### **Slots:**
+   *  - _default_ - The button's label.
+   * - **prefix** - A presentational prefix icon or similar element.
+   * - **suffix** - A presentational suffix icon or similar element.
    *
    * ### **CSS Parts:**
    *  - **base** - The component's base wrapper.
+   * - **prefix** - The container that wraps the prefix.
+   * - **label** - The button's label.
+   * - **suffix** - The container that wraps the suffix.
+   * - **caret** - The button's caret icon, an `<sl-icon>` element.
+   * - **spinner** - The spinner that shows when the button is in the loading state.
    */
-  "terra-loader": DefineComponent<TerraLoaderProps>;
+  "terra-button": DefineComponent<TerraButtonProps>;
 
   /**
    * Icons are symbols that can be used to represent various options within an application.
@@ -384,6 +371,19 @@ export type CustomElements = {
    */
   "terra-icon": DefineComponent<TerraIconProps>;
 
+  /**
+   * Loaders are used to indicate there is content that is loading.
+   * ---
+   *
+   *
+   * ### **CSS Properties:**
+   *  - **--example** - An example CSS custom property. _(default: undefined)_
+   *
+   * ### **CSS Parts:**
+   *  - **base** - The component's base wrapper.
+   */
+  "terra-loader": DefineComponent<TerraLoaderProps>;
+
   /**
    * A map component for visualizing and selecting coordinates.
    * ---

package/dist/vscode.html-custom-data.json

@@ -2,6 +2,101 @@
   "$schema": "https://raw.githubusercontent.com/microsoft/vscode-html-languageservice/main/docs/customData.schema.json",
   "version": 1.1,
   "tags": [
+    {
+      "name": "terra-combobox",
+      "description": "Fuzzy-search for combobox with list autocomplete.\n---\n\n\n### **CSS Properties:**\n - **--host-height** - The height of the host element. _(default: undefined)_\n- **--help-height** - The height of the search help element. _(default: undefined)_\n- **--label-height** - The height of the input's label element. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - A `search` element, the component's base.\n- **combobox** - An `input` element used for searching.\n- **button** - A `button` used for toggling the listbox's visibility.\n- **listbox** - A `ul` that holds the clickable options.",
+      "attributes": [
+        {
+          "name": "label",
+          "description": "Label the combobox with this.",
+          "values": []
+        },
+        {
+          "name": "name",
+          "description": "name the combobox with this.",
+          "values": []
+        },
+        {
+          "name": "placeholder",
+          "description": "Set a placeholder for the combobox with this.\nDefaults to the label's value.",
+          "values": []
+        },
+        {
+          "name": "hide-help",
+          "description": "Hide the combobox's help text.\nWhen hidden, not rendered at all.",
+          "values": []
+        },
+        {
+          "name": "hide-label",
+          "description": "Hide the combobox's label text.\nWhen hidden, still presents to screen readers.",
+          "values": []
+        },
+        {
+          "name": "status",
+          "description": "status of the content",
+          "values": [
+            { "name": "INITIAL" },
+            { "name": "PENDING" },
+            { "name": "COMPLETE" },
+            { "name": "ERROR" }
+          ]
+        },
+        {
+          "name": "content",
+          "description": "content or data of the combobox. This could be of type string | GroupedListItem[] | ListItem[] | undefined",
+          "values": [{ "name": "Content" }]
+        }
+      ],
+      "references": [
+        {
+          "name": "Documentation",
+          "url": "https://disc.gsfc.nasa.gov/components/combobox"
+        }
+      ]
+    },
+    {
+      "name": "terra-date-range-slider",
+      "description": "Short summary of the component's intended use.\n---\n\n\n### **Slots:**\n - _default_ - The default slot.\n- **example** - An example slot.\n\n### **CSS Properties:**\n - **--example** - An example CSS custom property. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
+      "attributes": [
+        { "name": "time-scale", "values": [{ "name": "TimeScale" }] },
+        { "name": "min-date", "values": [] },
+        { "name": "max-date", "values": [] },
+        {
+          "name": "start-date",
+          "description": "The start date for the time series plot.",
+          "values": []
+        },
+        { "name": "end-date", "values": [] },
+        { "name": "disabled", "values": [] },
+        { "name": "has-pips", "values": [] }
+      ],
+      "references": [
+        {
+          "name": "Documentation",
+          "url": "https://disc.gsfc.nasa.gov/components/date-range-slider"
+        }
+      ]
+    },
+    {
+      "name": "terra-chip",
+      "description": "Used for contacts and tags\n---\n\n\n### **Slots:**\n - _default_ - The chip's label.",
+      "attributes": [
+        {
+          "name": "size",
+          "values": [
+            { "name": "small" },
+            { "name": "medium" },
+            { "name": "large" }
+          ]
+        }
+      ],
+      "references": [
+        {
+          "name": "Documentation",
+          "url": "https://disc.gsfc.nasa.gov/components/chip"
+        }
+      ]
+    },
     {
       "name": "terra-button",
       "description": "Buttons represent actions that are available to the user.\n---\n\n\n### **Methods:**\n - **click()** - Simulates a click on the button.\n- **focus(options: _FocusOptions_)** - Sets focus on the button.\n- **blur()** - Removes focus from the button.\n- **checkValidity()** - Checks for validity but does not show a validation message. Returns `true` when valid and `false` when invalid.\n- **getForm(): _HTMLFormElement | null_** - Gets the associated form, if one exists.\n- **reportValidity()** - Checks for validity and shows the browser's validation message if the control is invalid.\n- **setCustomValidity(message: _string_)** - Sets a custom validation message. Pass an empty string to restore validity.\n\n### **Slots:**\n - _default_ - The button's label.\n- **prefix** - A presentational prefix icon or similar element.\n- **suffix** - A presentational suffix icon or similar element.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **prefix** - The container that wraps the prefix.\n- **label** - The button's label.\n- **suffix** - The container that wraps the suffix.\n- **caret** - The button's caret icon, an `<sl-icon>` element.\n- **spinner** - The spinner that shows when the button is in the loading state.",
@@ -154,97 +249,44 @@
       ]
     },
     {
-      "name": "terra-chip",
-      "description": "Used for contacts and tags\n---\n\n\n### **Slots:**\n - _default_ - The chip's label.",
-      "attributes": [
-        {
-          "name": "size",
-          "values": [
-            { "name": "small" },
-            { "name": "medium" },
-            { "name": "large" }
-          ]
-        }
-      ],
-      "references": [
-        {
-          "name": "Documentation",
-          "url": "https://disc.gsfc.nasa.gov/components/chip"
-        }
-      ]
-    },
-    {
-      "name": "terra-combobox",
-      "description": "Fuzzy-search for combobox with list autocomplete.\n---\n\n\n### **CSS Properties:**\n - **--host-height** - The height of the host element. _(default: undefined)_\n- **--help-height** - The height of the search help element. _(default: undefined)_\n- **--label-height** - The height of the input's label element. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - A `search` element, the component's base.\n- **combobox** - An `input` element used for searching.\n- **button** - A `button` used for toggling the listbox's visibility.\n- **listbox** - A `ul` that holds the clickable options.",
+      "name": "terra-icon",
+      "description": "Icons are symbols that can be used to represent various options within an application.\n---\n\n\n### **Events:**\n - **terra-load** - Emitted when the icon has loaded.\n- **terra-error** - Emitted when the icon fails to load due to an error.\n\n### **CSS Parts:**\n - **svg** - The internal SVG element.",
       "attributes": [
-        {
-          "name": "label",
-          "description": "Label the combobox with this.",
-          "values": []
-        },
         {
           "name": "name",
-          "description": "name the combobox with this.",
+          "description": "The name of the icon to draw. Available names depend on the icon library being used.",
           "values": []
         },
         {
-          "name": "placeholder",
-          "description": "Set a placeholder for the combobox with this.\nDefaults to the label's value.",
+          "name": "src",
+          "description": "An external URL of an SVG file. Be sure you trust the content you are including, as it will be executed as code and\ncan result in XSS attacks.",
           "values": []
         },
         {
-          "name": "hide-help",
-          "description": "Hide the combobox's help text.\nWhen hidden, not rendered at all.",
+          "name": "label",
+          "description": "An alternate description to use for assistive devices. If omitted, the icon will be considered presentational and\nignored by assistive devices.",
           "values": []
         },
         {
-          "name": "hide-label",
-          "description": "Hide the combobox's label text.\nWhen hidden, still presents to screen readers.",
-          "values": []
+          "name": "library",
+          "description": "The name of a registered custom icon library.",
+          "values": [{ "name": "default" }, { "name": "heroicons" }]
         },
         {
-          "name": "status",
-          "description": "status of the content",
-          "values": [
-            { "name": "INITIAL" },
-            { "name": "PENDING" },
-            { "name": "COMPLETE" },
-            { "name": "ERROR" }
-          ]
+          "name": "color",
+          "description": "The CSS color to assign to the SVG.",
+          "values": []
         },
         {
-          "name": "content",
-          "description": "content or data of the combobox. This could be of type string | GroupedListItem[] | ListItem[] | undefined",
-          "values": [{ "name": "Content" }]
-        }
-      ],
-      "references": [
-        {
-          "name": "Documentation",
-          "url": "https://disc.gsfc.nasa.gov/components/combobox"
-        }
-      ]
-    },
-    {
-      "name": "terra-date-range-slider",
-      "description": "Short summary of the component's intended use.\n---\n\n\n### **Slots:**\n - _default_ - The default slot.\n- **example** - An example slot.\n\n### **CSS Properties:**\n - **--example** - An example CSS custom property. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
-      "attributes": [
-        { "name": "time-scale", "values": [{ "name": "TimeScale" }] },
-        { "name": "min-date", "values": [] },
-        { "name": "max-date", "values": [] },
-        {
-          "name": "start-date",
-          "description": "The start date for the time series plot.",
+          "name": "font-size",
+          "description": "The CSS font-size to assign to the SVG.",
           "values": []
-        },
-        { "name": "end-date", "values": [] },
-        { "name": "disabled", "values": [] },
-        { "name": "has-pips", "values": [] }
+        }
       ],
       "references": [
         {
           "name": "Documentation",
-          "url": "https://disc.gsfc.nasa.gov/components/date-range-slider"
+          "url": "https://disc.gsfc.nasa.gov/components/icon"
         }
       ]
     },
@@ -290,48 +332,6 @@
         }
       ]
     },
-    {
-      "name": "terra-icon",
-      "description": "Icons are symbols that can be used to represent various options within an application.\n---\n\n\n### **Events:**\n - **terra-load** - Emitted when the icon has loaded.\n- **terra-error** - Emitted when the icon fails to load due to an error.\n\n### **CSS Parts:**\n - **svg** - The internal SVG element.",
-      "attributes": [
-        {
-          "name": "name",
-          "description": "The name of the icon to draw. Available names depend on the icon library being used.",
-          "values": []
-        },
-        {
-          "name": "src",
-          "description": "An external URL of an SVG file. Be sure you trust the content you are including, as it will be executed as code and\ncan result in XSS attacks.",
-          "values": []
-        },
-        {
-          "name": "label",
-          "description": "An alternate description to use for assistive devices. If omitted, the icon will be considered presentational and\nignored by assistive devices.",
-          "values": []
-        },
-        {
-          "name": "library",
-          "description": "The name of a registered custom icon library.",
-          "values": [{ "name": "default" }, { "name": "heroicons" }]
-        },
-        {
-          "name": "color",
-          "description": "The CSS color to assign to the SVG.",
-          "values": []
-        },
-        {
-          "name": "font-size",
-          "description": "The CSS font-size to assign to the SVG.",
-          "values": []
-        }
-      ],
-      "references": [
-        {
-          "name": "Documentation",
-          "url": "https://disc.gsfc.nasa.gov/components/icon"
-        }
-      ]
-    },
     {
       "name": "terra-map",
       "description": "A map component for visualizing and selecting coordinates.\n---\n",