@nasa-terra/components 0.0.97 → 0.0.98

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

@@ -25,6 +25,68 @@
         }
       ]
     },
+    {
+      "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",
+      "attributes": [
+        {
+          "name": "catalog",
+          "description": "Allows the user to switch the catalog between different providers\nTODO: add support for CMR catalog and make it the default",
+          "values": [{ "name": "giovanni" }]
+        },
+        { "name": "selected-variable-entry-ids", "values": [] }
+      ],
+      "references": [
+        {
+          "name": "Documentation",
+          "url": "https://disc.gsfc.nasa.gov/components/browse-variables"
+        }
+      ]
+    },
     {
       "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.",
@@ -186,46 +248,22 @@
       ]
     },
     {
-      "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.",
+      "name": "terra-chip",
+      "description": "Used for contacts and tags\n---\n\n\n### **Slots:**\n - _default_ - The chip's label.",
       "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.",
+          "name": "size",
           "values": [
-            { "name": "" },
-            { "name": "primary" },
-            { "name": "success" },
-            { "name": "neutral" },
-            { "name": "warning" },
-            { "name": "danger" }
+            { "name": "small" },
+            { "name": "medium" },
+            { "name": "large" }
           ]
-        },
-        {
-          "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"
+          "url": "https://disc.gsfc.nasa.gov/components/chip"
         }
       ]
     },
@@ -329,57 +367,38 @@
       ]
     },
     {
-      "name": "terra-chip",
-      "description": "Used for contacts and tags\n---\n\n\n### **Slots:**\n - _default_ - The chip's label.",
+      "name": "terra-data-subsetter",
+      "description": "Easily allow users to select, subset, and download NASA Earth science data collections with spatial, temporal, and variable filters.\n---\n\n\n### **Events:**\n - **terra-subset-job-complete** - called when a subset job enters a final state (e.g. successful, failed, completed_with_errors)",
       "attributes": [
-        {
-          "name": "size",
-          "values": [
-            { "name": "small" },
-            { "name": "medium" },
-            { "name": "large" }
-          ]
-        }
+        { "name": "collection-entry-id", "values": [] },
+        { "name": "show-collection-search", "values": [] },
+        { "name": "show-history-panel", "values": [] },
+        { "name": "job-id", "values": [] },
+        { "name": "bearer-token", "values": [] }
       ],
       "references": [
         {
           "name": "Documentation",
-          "url": "https://disc.gsfc.nasa.gov/components/chip"
+          "url": "https://disc.gsfc.nasa.gov/components/data-subsetter"
         }
       ]
     },
     {
-      "name": "terra-browse-variables",
-      "description": "Browse through the NASA CMR or Giovanni catalogs.\n---\n",
+      "name": "terra-data-subsetter-history",
+      "description": "Shows a floating panel with a user's recent data subset requests and their status, with quick access to results and re-submission.\n---\n",
       "attributes": [
+        { "name": "label", "values": [] },
+        { "name": "bearer-token", "values": [] },
         {
-          "name": "catalog",
-          "description": "Allows the user to switch the catalog between different providers\nTODO: add support for CMR catalog and make it the default",
-          "values": [{ "name": "giovanni" }]
-        },
-        { "name": "selected-variable-entry-ids", "values": [] }
-      ],
-      "references": [
-        {
-          "name": "Documentation",
-          "url": "https://disc.gsfc.nasa.gov/components/browse-variables"
+          "name": "always-show",
+          "description": "if a user has never done a subset request, by default they don't see the history panel at all\nthis prop allows you to override that behavior and always show the history panel",
+          "values": []
         }
-      ]
-    },
-    {
-      "name": "terra-data-subsetter",
-      "description": "Easily allow users to select, subset, and download NASA Earth science data collections with spatial, temporal, and variable filters.\n---\n\n\n### **Events:**\n - **terra-subset-job-complete** - called when a subset job enters a final state (e.g. successful, failed, completed_with_errors)",
-      "attributes": [
-        { "name": "collection-entry-id", "values": [] },
-        { "name": "show-collection-search", "values": [] },
-        { "name": "show-history-panel", "values": [] },
-        { "name": "job-id", "values": [] },
-        { "name": "bearer-token", "values": [] }
       ],
       "references": [
         {
           "name": "Documentation",
-          "url": "https://disc.gsfc.nasa.gov/components/data-subsetter"
+          "url": "https://disc.gsfc.nasa.gov/components/data-subsetter-history"
         }
       ]
     },
@@ -422,25 +441,6 @@
         }
       ]
     },
-    {
-      "name": "terra-data-subsetter-history",
-      "description": "Shows a floating panel with a user's recent data subset requests and their status, with quick access to results and re-submission.\n---\n",
-      "attributes": [
-        { "name": "label", "values": [] },
-        { "name": "bearer-token", "values": [] },
-        {
-          "name": "always-show",
-          "description": "if a user has never done a subset request, by default they don't see the history panel at all\nthis prop allows you to override that behavior and always show the history panel",
-          "values": []
-        }
-      ],
-      "references": [
-        {
-          "name": "Documentation",
-          "url": "https://disc.gsfc.nasa.gov/components/data-subsetter-history"
-        }
-      ]
-    },
     {
       "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.",
@@ -585,6 +585,52 @@
         }
       ]
     },
+    {
+      "name": "terra-map",
+      "description": "A map component for visualizing and selecting coordinates.\n---\n",
+      "attributes": [
+        {
+          "name": "min-zoom",
+          "description": "Minimum zoom level of the map.",
+          "values": []
+        },
+        {
+          "name": "max-zoom",
+          "description": "Maximum zoom level of the map.",
+          "values": []
+        },
+        {
+          "name": "zoom",
+          "description": "Initial map zoom level",
+          "values": []
+        },
+        {
+          "name": "has-navigation",
+          "description": "has map navigation toolbar",
+          "values": []
+        },
+        {
+          "name": "has-coord-tracker",
+          "description": "has coordinate tracker",
+          "values": []
+        },
+        {
+          "name": "has-shape-selector",
+          "description": "has shape selector",
+          "values": []
+        },
+        { "name": "hide-bounding-box-selection", "values": [] },
+        { "name": "hide-point-selection", "values": [] },
+        { "name": "staticMode", "values": [] },
+        { "name": "value", "values": [] }
+      ],
+      "references": [
+        {
+          "name": "Documentation",
+          "url": "https://disc.gsfc.nasa.gov/components/map"
+        }
+      ]
+    },
     {
       "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.",
@@ -701,52 +747,6 @@
         }
       ]
     },
-    {
-      "name": "terra-map",
-      "description": "A map component for visualizing and selecting coordinates.\n---\n",
-      "attributes": [
-        {
-          "name": "min-zoom",
-          "description": "Minimum zoom level of the map.",
-          "values": []
-        },
-        {
-          "name": "max-zoom",
-          "description": "Maximum zoom level of the map.",
-          "values": []
-        },
-        {
-          "name": "zoom",
-          "description": "Initial map zoom level",
-          "values": []
-        },
-        {
-          "name": "has-navigation",
-          "description": "has map navigation toolbar",
-          "values": []
-        },
-        {
-          "name": "has-coord-tracker",
-          "description": "has coordinate tracker",
-          "values": []
-        },
-        {
-          "name": "has-shape-selector",
-          "description": "has shape selector",
-          "values": []
-        },
-        { "name": "hide-bounding-box-selection", "values": [] },
-        { "name": "hide-point-selection", "values": [] },
-        { "name": "staticMode", "values": [] },
-        { "name": "value", "values": [] }
-      ],
-      "references": [
-        {
-          "name": "Documentation",
-          "url": "https://disc.gsfc.nasa.gov/components/map"
-        }
-      ]
-    },
     {
       "name": "terra-skeleton",
       "description": "Skeletons are loading indicators to represent where content will eventually be drawn.\n---\n",
@@ -769,53 +769,6 @@
         }
       ]
     },
-    {
-      "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",
-          "description": "Label 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": "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": "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-combobox"
-        }
-      ]
-    },
     {
       "name": "terra-time-average-map",
       "description": "\n---\n",
@@ -889,6 +842,53 @@
         }
       ]
     },
+    {
+      "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",
+          "description": "Label 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": "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": "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-combobox"
+        }
+      ]
+    },
     {
       "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.",