@nasa-terra/components 0.0.46 → 0.0.47

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

@@ -1,23 +1,42 @@
 import type { DefineComponent } from "vue";
 
-import type { TerraButton } from "../../components/button/button.component.js";
 import type { TerraBrowseVariables } from "../../components/browse-variables/browse-variables.component.js";
+import type { TerraChip } from "../../components/chip/chip.component.js";
+import type { TerraButton } from "../../components/button/button.component.js";
 import type { TerraCombobox } from "../../components/combobox/combobox.component.js";
 import type { TerraDataRods } from "../../components/data-rods/data-rods.component.js";
+import type { TerraDatePicker } from "../../components/date-picker/date-picker.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 { TerraDialog } from "../../components/dialog/dialog.component.js";
-import type { TerraDatePicker } from "../../components/date-picker/date-picker.component.js";
 import type { TerraIcon } from "../../components/icon/icon.component.js";
 import type { TerraLoader } from "../../components/loader/loader.component.js";
 import type { TerraLogin } from "../../components/login/login.component.js";
-import type { TerraMap } from "../../components/map/map.component.js";
 import type { TerraPlot } from "../../components/plot/plot.component.js";
+import type { TerraMap } from "../../components/map/map.component.js";
 import type { TerraSkeleton } from "../../components/skeleton/skeleton.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 { TerraVariableKeywordSearch } from "../../components/variable-keyword-search/variable-keyword-search.component.js";
 import type { TerraVariableCombobox } from "../../components/variable-combobox/variable-combobox.component.js";
+import type { TerraVariableKeywordSearch } from "../../components/variable-keyword-search/variable-keyword-search.component.js";
+
+type TerraBrowseVariablesProps = {
+  /** Allows the user to switch the catalog between different providers
+TODO: add support for CMR catalog and make it the default */
+  catalog?: TerraBrowseVariables["catalog"];
+  /**  */
+  searchQuery?: TerraBrowseVariables["searchQuery"];
+  /**  */
+  selectedFacets?: TerraBrowseVariables["selectedFacets"];
+  /**  */
+  selectedVariables?: TerraBrowseVariables["selectedVariables"];
+  /**  */
+  showVariablesBrowse?: TerraBrowseVariables["showVariablesBrowse"];
+};
+
+type TerraChipProps = {
+  /**  */
+  size?: TerraChip["size"];
+};
 
 type TerraButtonProps = {
   /**  */
@@ -86,20 +105,6 @@ value of this attribute must be an id of a form in the same document or shadow r
   validationMessage?: TerraButton["validationMessage"];
 };
 
-type TerraBrowseVariablesProps = {
-  /** Allows the user to switch the catalog between different providers
-TODO: add support for CMR catalog and make it the default */
-  catalog?: TerraBrowseVariables["catalog"];
-  /**  */
-  searchQuery?: TerraBrowseVariables["searchQuery"];
-  /**  */
-  selectedFacets?: TerraBrowseVariables["selectedFacets"];
-  /**  */
-  selectedVariables?: TerraBrowseVariables["selectedVariables"];
-  /**  */
-  showVariablesBrowse?: TerraBrowseVariables["showVariablesBrowse"];
-};
-
 type TerraComboboxProps = {
   /** Label the combobox with this. */
   label?: TerraCombobox["label"];
@@ -149,47 +154,6 @@ The property's value will be inserted after "Bearer" (the authentication scheme)
   catalogVariable?: TerraDataRods["catalogVariable"];
 };
 
-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 TerraDialogProps = {
-  /** the ID to be used for accessibility associations */
-  id?: TerraDialog["id"];
-  /** the width of the dialog */
-  width?: TerraDialog["width"];
-  /** allow closing the dialog when clicking outside of it */
-  "click-outside-to-close"?: TerraDialog["clickOutsideToClose"];
-  /** Show a backdrop behind the dialog */
-  "show-backdrop"?: TerraDialog["showBackdrop"];
-  /**  */
-  dialogEl?: TerraDialog["dialogEl"];
-  /** Emitted when the dialog opens. */
-  onTerraDialogShow?: (e: CustomEvent<never>) => void;
-  /** Emitted when the dialog closes. */
-  onTerraDialogHide?: (e: CustomEvent<never>) => void;
-};
-
 type TerraDatePickerProps = {
   /**  */
   id?: TerraDatePicker["id"];
@@ -233,6 +197,42 @@ type TerraDatePickerProps = {
   selectedDates?: TerraDatePicker["selectedDates"];
 };
 
+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 TerraDialogProps = {
+  /** the ID to be used for accessibility associations */
+  id?: TerraDialog["id"];
+  /** the width of the dialog */
+  width?: TerraDialog["width"];
+  /** allow closing the dialog when clicking outside of it */
+  "click-outside-to-close"?: TerraDialog["clickOutsideToClose"];
+  /** Show a backdrop behind the dialog */
+  "show-backdrop"?: TerraDialog["showBackdrop"];
+  /**  */
+  dialogEl?: TerraDialog["dialogEl"];
+  /** Emitted when the dialog opens. */
+  onTerraDialogShow?: (e: CustomEvent<never>) => void;
+  /** Emitted when the dialog closes. */
+  onTerraDialogHide?: (e: CustomEvent<never>) => void;
+};
+
 type TerraIconProps = {
   /** The name of the icon to draw. Available names depend on the icon library being used. */
   name?: TerraIcon["name"];
@@ -272,6 +272,19 @@ type TerraLoginProps = {
   onTerraLogin?: (e: CustomEvent<never>) => void;
 };
 
+type TerraPlotProps = {
+  /**  */
+  plotTitle?: TerraPlot["plotTitle"];
+  /**  */
+  layout?: TerraPlot["layout"];
+  /**  */
+  config?: TerraPlot["config"];
+  /**  */
+  data?: TerraPlot["data"];
+  /**  */
+  base?: TerraPlot["base"];
+};
+
 type TerraMapProps = {
   /** Minimum zoom level of the map. */
   "min-zoom"?: TerraMap["minZoom"];
@@ -297,19 +310,6 @@ type TerraMapProps = {
   _mapController?: TerraMap["_mapController"];
 };
 
-type TerraPlotProps = {
-  /**  */
-  plotTitle?: TerraPlot["plotTitle"];
-  /**  */
-  layout?: TerraPlot["layout"];
-  /**  */
-  config?: TerraPlot["config"];
-  /**  */
-  data?: TerraPlot["data"];
-  /**  */
-  base?: TerraPlot["base"];
-};
-
 type TerraSkeletonProps = {
   /**  */
   rows?: TerraSkeleton["rows"];
@@ -389,31 +389,6 @@ The property's value will be inserted after "Bearer" (the authentication scheme)
   onTerraTimeSeriesDataChange?: (e: CustomEvent<never>) => void;
 };
 
-type TerraVariableKeywordSearchProps = {
-  /** Label the combobox with this. */
-  label?: TerraVariableKeywordSearch["label"];
-  /** Set a placeholder for the combobox with this.
-Defaults to the label's value. */
-  placeholder?: TerraVariableKeywordSearch["placeholder"];
-  /** Hide the combobox's label text.
-When hidden, still presents to screen readers. */
-  "hide-label"?: TerraVariableKeywordSearch["hideLabel"];
-  /** type can be `Boolean`, `String`, `Number`, `Object`, or `Array` */
-  searchConfig?: TerraVariableKeywordSearch["searchConfig"];
-  /**  */
-  value?: TerraVariableKeywordSearch["value"];
-  /**  */
-  isExpanded?: TerraVariableKeywordSearch["isExpanded"];
-  /**  */
-  query?: TerraVariableKeywordSearch["query"];
-  /**  */
-  searchResults?: TerraVariableKeywordSearch["searchResults"];
-  /** Emitted when an option is selected. */
-  onTerraVariableKeywordSearchChange?: (e: CustomEvent<never>) => void;
-  /** Emitted when the component is triggering a search (like a form triggering submit). */
-  onTerraSearch?: (e: CustomEvent<never>) => void;
-};
-
 type TerraVariableComboboxProps = {
   /** Label the combobox with this. */
   label?: TerraVariableCombobox["label"];
@@ -449,7 +424,49 @@ The property's value will be inserted after "Bearer" (the authentication scheme)
   onTerraComboboxChange?: (e: CustomEvent<never>) => void;
 };
 
+type TerraVariableKeywordSearchProps = {
+  /** Label the combobox with this. */
+  label?: TerraVariableKeywordSearch["label"];
+  /** Set a placeholder for the combobox with this.
+Defaults to the label's value. */
+  placeholder?: TerraVariableKeywordSearch["placeholder"];
+  /** Hide the combobox's label text.
+When hidden, still presents to screen readers. */
+  "hide-label"?: TerraVariableKeywordSearch["hideLabel"];
+  /** type can be `Boolean`, `String`, `Number`, `Object`, or `Array` */
+  searchConfig?: TerraVariableKeywordSearch["searchConfig"];
+  /**  */
+  value?: TerraVariableKeywordSearch["value"];
+  /**  */
+  isExpanded?: TerraVariableKeywordSearch["isExpanded"];
+  /**  */
+  query?: TerraVariableKeywordSearch["query"];
+  /**  */
+  searchResults?: TerraVariableKeywordSearch["searchResults"];
+  /** Emitted when an option is selected. */
+  onTerraVariableKeywordSearchChange?: (e: CustomEvent<never>) => void;
+  /** Emitted when the component is triggering a search (like a form triggering submit). */
+  onTerraSearch?: (e: CustomEvent<never>) => void;
+};
+
 export type CustomElements = {
+  /**
+   * Browse through the NASA CMR or Giovanni catalogs.
+   * ---
+   *
+   */
+  "terra-browse-variables": DefineComponent<TerraBrowseVariablesProps>;
+
+  /**
+   * Used for contacts and tags
+   * ---
+   *
+   *
+   * ### **Slots:**
+   *  - _default_ - The chip's label.
+   */
+  "terra-chip": DefineComponent<TerraChipProps>;
+
   /**
    * Buttons represent actions that are available to the user.
    * ---
@@ -479,13 +496,6 @@ export type CustomElements = {
    */
   "terra-button": DefineComponent<TerraButtonProps>;
 
-  /**
-   * Browse through the NASA CMR or Giovanni catalogs.
-   * ---
-   *
-   */
-  "terra-browse-variables": DefineComponent<TerraBrowseVariablesProps>;
-
   /**
    * Fuzzy-search for combobox with list autocomplete.
    * ---
@@ -512,31 +522,35 @@ export type CustomElements = {
   "terra-data-rods": DefineComponent<TerraDataRodsProps>;
 
   /**
-   * Short summary of the component's intended use.
+   * A date picker component that supports single date selection or date range selection.
    * ---
    *
    *
    * ### **Slots:**
    *  - _default_ - The default slot.
-   * - **example** - An example slot.
-   *
-   * ### **CSS Properties:**
-   *  - **--example** - An example CSS custom property. _(default: undefined)_
    *
    * ### **CSS Parts:**
    *  - **base** - The component's base wrapper.
+   * - **input** - The date input element.
    */
-  "terra-date-range-slider": DefineComponent<TerraDateRangeSliderProps>;
+  "terra-date-picker": DefineComponent<TerraDatePickerProps>;
 
   /**
-   * Used for contacts and tags
+   * Short summary of the component's intended use.
    * ---
    *
    *
    * ### **Slots:**
-   *  - _default_ - The chip's label.
+   *  - _default_ - The default slot.
+   * - **example** - An example slot.
+   *
+   * ### **CSS Properties:**
+   *  - **--example** - An example CSS custom property. _(default: undefined)_
+   *
+   * ### **CSS Parts:**
+   *  - **base** - The component's base wrapper.
    */
-  "terra-chip": DefineComponent<TerraChipProps>;
+  "terra-date-range-slider": DefineComponent<TerraDateRangeSliderProps>;
 
   /**
    * Used to create both modal and non-modal dialog boxes.
@@ -552,20 +566,6 @@ export type CustomElements = {
    */
   "terra-dialog": DefineComponent<TerraDialogProps>;
 
-  /**
-   * A date picker component that supports single date selection or date range selection.
-   * ---
-   *
-   *
-   * ### **Slots:**
-   *  - _default_ - The default slot.
-   *
-   * ### **CSS Parts:**
-   *  - **base** - The component's base wrapper.
-   * - **input** - The date input element.
-   */
-  "terra-date-picker": DefineComponent<TerraDatePickerProps>;
-
   /**
    * Icons are symbols that can be used to represent various options within an application.
    * ---
@@ -603,13 +603,6 @@ export type CustomElements = {
    */
   "terra-login": DefineComponent<TerraLoginProps>;
 
-  /**
-   * A map component for visualizing and selecting coordinates.
-   * ---
-   *
-   */
-  "terra-map": DefineComponent<TerraMapProps>;
-
   /**
    * A web component for interactive graphs using Plotly.js.
    * ---
@@ -620,6 +613,13 @@ export type CustomElements = {
    */
   "terra-plot": DefineComponent<TerraPlotProps>;
 
+  /**
+   * A map component for visualizing and selecting coordinates.
+   * ---
+   *
+   */
+  "terra-map": DefineComponent<TerraMapProps>;
+
   /**
    * Skeletons are loading indicators to represent where content will eventually be drawn.
    * ---
@@ -645,16 +645,20 @@ export type CustomElements = {
   "terra-time-series": DefineComponent<TerraTimeSeriesProps>;
 
   /**
-   * Fuzzy-search for dataset keywords in combobox with list autocomplete.
+   * Fuzzy-search for dataset variables in combobox with list autocomplete.
    * ---
    *
    *
    * ### **Events:**
-   *  - **terra-variable-keyword-search-change** - Emitted when an option is selected.
-   * - **terra-search** - Emitted when the component is triggering a search (like a form triggering submit).
+   *  - **terra-combobox-change** - Emitted when an option is selected.
+   *
+   * ### **Methods:**
+   *  - **valueChanged(oldValue: _string_, newValue: _string_)** - This component's value is read by other components.
+   * Internally, the variable metdata has slight differences that require adapting.
    *
    * ### **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:**
@@ -663,23 +667,19 @@ export type CustomElements = {
    * - **button** - A `button` used for toggling the listbox's visibility.
    * - **listbox** - A `ul` that holds the clickable options.
    */
-  "terra-variable-keyword-search": DefineComponent<TerraVariableKeywordSearchProps>;
+  "terra-variable-combobox": DefineComponent<TerraVariableComboboxProps>;
 
   /**
-   * Fuzzy-search for dataset variables in combobox with list autocomplete.
+   * Fuzzy-search for dataset keywords in combobox with list autocomplete.
    * ---
    *
    *
    * ### **Events:**
-   *  - **terra-combobox-change** - Emitted when an option is selected.
-   *
-   * ### **Methods:**
-   *  - **valueChanged(oldValue: _string_, newValue: _string_)** - This component's value is read by other components.
-   * Internally, the variable metdata has slight differences that require adapting.
+   *  - **terra-variable-keyword-search-change** - Emitted when an option is selected.
+   * - **terra-search** - Emitted when the component is triggering a search (like a form triggering submit).
    *
    * ### **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:**
@@ -688,7 +688,7 @@ export type CustomElements = {
    * - **button** - A `button` used for toggling the listbox's visibility.
    * - **listbox** - A `ul` that holds the clickable options.
    */
-  "terra-variable-combobox": DefineComponent<TerraVariableComboboxProps>;
+  "terra-variable-keyword-search": DefineComponent<TerraVariableKeywordSearchProps>;
 };
 
 declare module "vue" {