@nasa-terra/components 0.0.60 → 0.0.63

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

@@ -25,50 +25,6 @@
         }
       ]
     },
-    {
-      "name": "terra-alert",
-      "description": "Alerts are used to display important messages inline or as toast notifications.\n---\n\n\n### **Events:**\n - **terra-show** - Emitted when the alert opens.\n- **terra-after-show** - Emitted after the alert opens and all animations are complete.\n- **terra-hide** - Emitted when the alert closes.\n- **terra-after-hide** - Emitted after the alert closes and all animations are complete.\n\n### **Methods:**\n - **show()** - Shows the alert.\n- **hide()** - Hides the alert\n- **toast()** - Displays the alert as a toast notification. This will move the alert out of its position in the DOM and, when\ndismissed, it will be removed from the DOM completely. By storing a reference to the alert, you can reuse it by\ncalling this method again. The returned promise will resolve after the alert is hidden.\n\n### **Slots:**\n - _default_ - The alert's main content.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **icon** - The container that wraps the optional icon.\n- **message** - The container that wraps the alert's main content.",
-      "attributes": [
-        {
-          "name": "open",
-          "description": "Indicates whether or not the alert is open. You can toggle this attribute to show and hide the alert, or you can\nuse the `show()` and `hide()` methods and this attribute will reflect the alert's open state.",
-          "values": []
-        },
-        {
-          "name": "closable",
-          "description": "Enables a close button that allows the user to dismiss the alert.",
-          "values": []
-        },
-        {
-          "name": "variant",
-          "description": "The alert's theme variant.",
-          "values": [
-            { "name": "" },
-            { "name": "primary" },
-            { "name": "success" },
-            { "name": "neutral" },
-            { "name": "warning" },
-            { "name": "danger" }
-          ]
-        },
-        {
-          "name": "duration",
-          "description": "The length of time, in milliseconds, the alert will show before closing itself. If the user interacts with\nthe alert before it closes (e.g. moves the mouse over it), the timer will restart. Defaults to `Infinity`, meaning\nthe alert will not close on its own.",
-          "values": []
-        },
-        {
-          "name": "countdown",
-          "description": "Enables a countdown that indicates the remaining time the alert will be displayed.\nTypically used to indicate the remaining time before a whole app refresh.",
-          "values": [{ "name": "rtl" }, { "name": "ltr" }]
-        }
-      ],
-      "references": [
-        {
-          "name": "Documentation",
-          "url": "https://disc.gsfc.nasa.gov/components/alert"
-        }
-      ]
-    },
     {
       "name": "terra-browse-variables",
       "description": "Browse through the NASA CMR or Giovanni catalogs.\n---\n",
@@ -462,6 +418,50 @@
         }
       ]
     },
+    {
+      "name": "terra-alert",
+      "description": "Alerts are used to display important messages inline or as toast notifications.\n---\n\n\n### **Events:**\n - **terra-show** - Emitted when the alert opens.\n- **terra-after-show** - Emitted after the alert opens and all animations are complete.\n- **terra-hide** - Emitted when the alert closes.\n- **terra-after-hide** - Emitted after the alert closes and all animations are complete.\n\n### **Methods:**\n - **show()** - Shows the alert.\n- **hide()** - Hides the alert\n- **toast()** - Displays the alert as a toast notification. This will move the alert out of its position in the DOM and, when\ndismissed, it will be removed from the DOM completely. By storing a reference to the alert, you can reuse it by\ncalling this method again. The returned promise will resolve after the alert is hidden.\n\n### **Slots:**\n - _default_ - The alert's main content.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **icon** - The container that wraps the optional icon.\n- **message** - The container that wraps the alert's main content.",
+      "attributes": [
+        {
+          "name": "open",
+          "description": "Indicates whether or not the alert is open. You can toggle this attribute to show and hide the alert, or you can\nuse the `show()` and `hide()` methods and this attribute will reflect the alert's open state.",
+          "values": []
+        },
+        {
+          "name": "closable",
+          "description": "Enables a close button that allows the user to dismiss the alert.",
+          "values": []
+        },
+        {
+          "name": "variant",
+          "description": "The alert's theme variant.",
+          "values": [
+            { "name": "" },
+            { "name": "primary" },
+            { "name": "success" },
+            { "name": "neutral" },
+            { "name": "warning" },
+            { "name": "danger" }
+          ]
+        },
+        {
+          "name": "duration",
+          "description": "The length of time, in milliseconds, the alert will show before closing itself. If the user interacts with\nthe alert before it closes (e.g. moves the mouse over it), the timer will restart. Defaults to `Infinity`, meaning\nthe alert will not close on its own.",
+          "values": []
+        },
+        {
+          "name": "countdown",
+          "description": "Enables a countdown that indicates the remaining time the alert will be displayed.\nTypically used to indicate the remaining time before a whole app refresh.",
+          "values": [{ "name": "rtl" }, { "name": "ltr" }]
+        }
+      ],
+      "references": [
+        {
+          "name": "Documentation",
+          "url": "https://disc.gsfc.nasa.gov/components/alert"
+        }
+      ]
+    },
     {
       "name": "terra-dialog",
       "description": "Used to create both modal and non-modal dialog boxes.\n---\n\n\n### **Events:**\n - **terra-dialog-show** - Emitted when the dialog opens.\n- **terra-dialog-hide** - Emitted when the dialog closes.\n\n### **Slots:**\n - _default_ - The dialog's main content",
@@ -494,6 +494,37 @@
         }
       ]
     },
+    {
+      "name": "terra-loader",
+      "description": "Loaders are used to indicate there is content that is loading.\n---\n\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": "variant",
+          "description": "The loader's variant",
+          "values": [
+            { "name": "small" },
+            { "name": "large" },
+            { "name": "orbit" }
+          ]
+        },
+        {
+          "name": "percent",
+          "description": "The percent complete for the loader to display",
+          "values": []
+        },
+        {
+          "name": "indeterminate",
+          "description": "an indeterminate loader has an unknown progress and will show a spinner",
+          "values": []
+        }
+      ],
+      "references": [
+        {
+          "name": "Documentation",
+          "url": "https://disc.gsfc.nasa.gov/components/loader"
+        }
+      ]
+    },
     {
       "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.",
@@ -536,37 +567,6 @@
         }
       ]
     },
-    {
-      "name": "terra-loader",
-      "description": "Loaders are used to indicate there is content that is loading.\n---\n\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": "variant",
-          "description": "The loader's variant",
-          "values": [
-            { "name": "small" },
-            { "name": "large" },
-            { "name": "orbit" }
-          ]
-        },
-        {
-          "name": "percent",
-          "description": "The percent complete for the loader to display",
-          "values": []
-        },
-        {
-          "name": "indeterminate",
-          "description": "an indeterminate loader has an unknown progress and will show a spinner",
-          "values": []
-        }
-      ],
-      "references": [
-        {
-          "name": "Documentation",
-          "url": "https://disc.gsfc.nasa.gov/components/loader"
-        }
-      ]
-    },
     {
       "name": "terra-login",
       "description": "A form that logs in to Earthdata Login (EDL) and returns a bearer token.\n---\n\n\n### **Events:**\n - **terra-login** - Emitted when a bearer token has been received from EDL.",
@@ -624,18 +624,26 @@
       ]
     },
     {
-      "name": "terra-plot",
-      "description": "A web component for interactive graphs using Plotly.js.\n---\n\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
+      "name": "terra-plot-toolbar",
+      "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": "plotTitle", "values": [] },
-        { "name": "layout", "values": [{ "name": "Partial<Layout>" }] },
-        { "name": "config", "values": [{ "name": "Partial<Config>" }] },
-        { "name": "data", "values": [{ "name": "Array<Partial<Data>>" }] }
+        { "name": "catalogVariable", "values": [{ "name": "Variable" }] },
+        { "name": "variableEntryId", "values": [] },
+        { "name": "plot", "values": [{ "name": "TerraPlot" }] },
+        {
+          "name": "timeSeriesData",
+          "values": [{ "name": "Partial<Data>[]" }, { "name": "Blob" }]
+        },
+        { "name": "location", "values": [] },
+        { "name": "startDate", "values": [] },
+        { "name": "endDate", "values": [] },
+        { "name": "cacheKey", "values": [] },
+        { "name": "dataType", "values": [{ "name": "DataType" }] }
       ],
       "references": [
         {
           "name": "Documentation",
-          "url": "https://disc.gsfc.nasa.gov/components/plot"
+          "url": "https://disc.gsfc.nasa.gov/components/plot-toolbar"
         }
       ]
     },
@@ -714,6 +722,59 @@
         }
       ]
     },
+    {
+      "name": "terra-skeleton",
+      "description": "Skeletons are loading indicators to represent where content will eventually be drawn.\n---\n",
+      "attributes": [
+        { "name": "rows", "values": [] },
+        {
+          "name": "effect",
+          "values": [
+            { "name": "pulse" },
+            { "name": "sheen" },
+            { "name": "none" }
+          ]
+        },
+        { "name": "variableWidths", "values": [] }
+      ],
+      "references": [
+        {
+          "name": "Documentation",
+          "url": "https://disc.gsfc.nasa.gov/components/skeleton"
+        }
+      ]
+    },
+    {
+      "name": "terra-time-average-map",
+      "description": "\n---\n",
+      "attributes": [
+        {
+          "name": "collection",
+          "description": "a collection entry id (ex: GPM_3IMERGHH_06)",
+          "values": []
+        },
+        { "name": "variable", "values": [] },
+        { "name": "start-date", "values": [] },
+        { "name": "end-date", "values": [] },
+        {
+          "name": "location",
+          "description": "The point location in \"lat,lon\" format.\nOr the bounding box in \"west,south,east,north\" format.",
+          "values": []
+        },
+        {
+          "name": "bearer-token",
+          "description": "The token to be used for authentication with remote servers.\nThe component provides the header \"Authorization: Bearer\" (the request header and authentication scheme).\nThe property's value will be inserted after \"Bearer\" (the authentication scheme).",
+          "values": []
+        },
+        { "name": "long_name", "values": [] }
+      ],
+      "references": [
+        {
+          "name": "Documentation",
+          "url": "https://disc.gsfc.nasa.gov/components/time-average-map"
+        }
+      ]
+    },
     {
       "name": "terra-time-series",
       "description": "A component for visualizing time series data using the GES DISC Giovanni API.\n---\n\n\n### **Events:**\n - **terra-date-range-change** - Emitted whenever the date range is modified\n- **terra-time-series-data-change** - Emitted whenever time series data has been fetched from Giovanni",
@@ -762,8 +823,8 @@
       ]
     },
     {
-      "name": "terra-variable-combobox",
-      "description": "Fuzzy-search for dataset variables in combobox with list autocomplete.\n---\n\n\n### **Events:**\n - **terra-combobox-change** - Emitted when an option is selected.\n\n### **Methods:**\n - **valueChanged(oldValue: _string_, newValue: _string_)** - This component's value is read by other components.\nInternally, the variable metdata has slight differences that require adapting.\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-variable-keyword-search",
+      "description": "Fuzzy-search for dataset keywords in combobox with list autocomplete.\n---\n\n\n### **Events:**\n - **terra-variable-keyword-search-change** - Emitted when an option is selected.\n- **terra-search** - Emitted when the component is triggering a search (like a form triggering submit).\n\n### **CSS Properties:**\n - **--host-height** - The height of the host 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",
@@ -775,64 +836,44 @@
           "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": "use-tags",
-          "description": "Determines if the variable combobox uses tags or plain text to display the query.",
-          "values": []
-        },
-        {
-          "name": "value",
-          "description": "Represents the EntryID (<collection-name>_<variable-name>) of the selected variable.\nOther components (like the time-series graphing component) will use this.",
-          "values": []
+          "name": "searchConfig",
+          "description": "type can be `Boolean`, `String`, `Number`, `Object`, or `Array`",
+          "values": [{ "name": "object" }]
         },
-        {
-          "name": "bearer-token",
-          "description": "The token to be used for authentication with remote servers.\nThe component provides the header \"Authorization: Bearer\" (the request header and authentication scheme).\nThe property's value will be inserted after \"Bearer\" (the authentication scheme).",
-          "values": []
-        }
+        { "name": "value", "values": [] }
       ],
       "references": [
         {
           "name": "Documentation",
-          "url": "https://disc.gsfc.nasa.gov/components/variable-combobox"
+          "url": "https://disc.gsfc.nasa.gov/components/variable-keyword-search"
         }
       ]
     },
     {
-      "name": "terra-skeleton",
-      "description": "Skeletons are loading indicators to represent where content will eventually be drawn.\n---\n",
+      "name": "terra-plot",
+      "description": "A web component for interactive graphs using Plotly.js.\n---\n\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
       "attributes": [
-        { "name": "rows", "values": [] },
-        {
-          "name": "effect",
-          "values": [
-            { "name": "pulse" },
-            { "name": "sheen" },
-            { "name": "none" }
-          ]
-        },
-        { "name": "variableWidths", "values": [] }
+        { "name": "plotTitle", "values": [] },
+        { "name": "layout", "values": [{ "name": "Partial<Layout>" }] },
+        { "name": "config", "values": [{ "name": "Partial<Config>" }] },
+        { "name": "data", "values": [{ "name": "Array<Partial<Data>>" }] }
       ],
       "references": [
         {
           "name": "Documentation",
-          "url": "https://disc.gsfc.nasa.gov/components/skeleton"
+          "url": "https://disc.gsfc.nasa.gov/components/plot"
         }
       ]
     },
     {
-      "name": "terra-variable-keyword-search",
-      "description": "Fuzzy-search for dataset keywords in combobox with list autocomplete.\n---\n\n\n### **Events:**\n - **terra-variable-keyword-search-change** - Emitted when an option is selected.\n- **terra-search** - Emitted when the component is triggering a search (like a form triggering submit).\n\n### **CSS Properties:**\n - **--host-height** - The height of the host 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-variable-combobox",
+      "description": "Fuzzy-search for dataset variables in combobox with list autocomplete.\n---\n\n\n### **Events:**\n - **terra-combobox-change** - Emitted when an option is selected.\n\n### **Methods:**\n - **valueChanged(oldValue: _string_, newValue: _string_)** - This component's value is read by other components.\nInternally, the variable metdata has slight differences that require adapting.\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",
@@ -844,22 +885,36 @@
           "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": "searchConfig",
-          "description": "type can be `Boolean`, `String`, `Number`, `Object`, or `Array`",
-          "values": [{ "name": "object" }]
+          "name": "use-tags",
+          "description": "Determines if the variable combobox uses tags or plain text to display the query.",
+          "values": []
         },
-        { "name": "value", "values": [] }
+        {
+          "name": "value",
+          "description": "Represents the EntryID (<collection-name>_<variable-name>) of the selected variable.\nOther components (like the time-series graphing component) will use this.",
+          "values": []
+        },
+        {
+          "name": "bearer-token",
+          "description": "The token to be used for authentication with remote servers.\nThe component provides the header \"Authorization: Bearer\" (the request header and authentication scheme).\nThe property's value will be inserted after \"Bearer\" (the authentication scheme).",
+          "values": []
+        }
       ],
       "references": [
         {
           "name": "Documentation",
-          "url": "https://disc.gsfc.nasa.gov/components/variable-keyword-search"
+          "url": "https://disc.gsfc.nasa.gov/components/variable-combobox"
         }
       ]
     }