@nasa-terra/components 0.0.6 → 0.0.9

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

@@ -3,153 +3,24 @@
   "version": 1.1,
   "tags": [
     {
-      "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.",
+      "name": "terra-browse-variables",
+      "description": "Browse through the Giovanni catalog.\n---\n\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
       "attributes": [
-        { "name": "title", "values": [] },
-        {
-          "name": "variant",
-          "description": "The button's theme variant.",
-          "values": [
-            { "name": "" },
-            { "name": "default" },
-            { "name": "primary" },
-            { "name": "success" },
-            { "name": "neutral" },
-            { "name": "warning" },
-            { "name": "danger" },
-            { "name": "text" }
-          ]
-        },
-        {
-          "name": "size",
-          "description": "The button's size.",
-          "values": [
-            { "name": "small" },
-            { "name": "medium" },
-            { "name": "large" }
-          ]
-        },
-        {
-          "name": "caret",
-          "description": "Draws the button with a caret. Used to indicate that the button triggers a dropdown menu or similar behavior.",
-          "values": []
-        },
-        {
-          "name": "disabled",
-          "description": "Disables the button.",
-          "values": []
-        },
-        {
-          "name": "loading",
-          "description": "Draws the button in a loading state.",
-          "values": []
-        },
-        {
-          "name": "outline",
-          "description": "Draws an outlined button.",
-          "values": []
-        },
-        {
-          "name": "pill",
-          "description": "Draws a pill-style button with rounded edges.",
-          "values": []
-        },
-        {
-          "name": "circle",
-          "description": "Draws a circular icon button. When this attribute is present, the button expects a single `<sl-icon>` in the\ndefault slot.",
-          "values": []
-        },
-        {
-          "name": "type",
-          "description": "The type of button. Note that the default value is `button` instead of `submit`, which is opposite of how native\n`<button>` elements behave. When the type is `submit`, the button will submit the surrounding form.",
-          "values": [
-            { "name": "button" },
-            { "name": "submit" },
-            { "name": "reset" }
-          ]
-        },
-        {
-          "name": "name",
-          "description": "The name of the button, submitted as a name/value pair with form data, but only when this button is the submitter.\nThis attribute is ignored when `href` is present.",
-          "values": []
-        },
-        {
-          "name": "value",
-          "description": "The value of the button, submitted as a pair with the button's name as part of the form data, but only when this\nbutton is the submitter. This attribute is ignored when `href` is present.",
-          "values": []
-        },
-        {
-          "name": "href",
-          "description": "When set, the underlying button will be rendered as an `<a>` with this `href` instead of a `<button>`.",
-          "values": []
-        },
         {
-          "name": "target",
-          "description": "Tells the browser where to open the link. Only used when `href` is present.",
-          "values": [
-            { "name": "_blank" },
-            { "name": "_parent" },
-            { "name": "_self" },
-            { "name": "_top" }
-          ]
-        },
-        {
-          "name": "rel",
-          "description": "When using `href`, this attribute will map to the underlying link's `rel` attribute. Unlike regular links, the\ndefault is `noreferrer noopener` to prevent security exploits. However, if you're using `target` to point to a\nspecific tab/window, this will prevent that from working correctly. You can remove or change the default value by\nsetting the attribute to an empty string or a value of your choice, respectively.",
+          "name": "searchQuery",
+          "description": "Filters the catalog categories and facets by the given searchQuery\nIf not provided, all categories and facets will be available to browse",
           "values": []
         },
         {
-          "name": "download",
-          "description": "Tells the browser to download the linked file as this filename. Only used when `href` is present.",
-          "values": []
-        },
-        {
-          "name": "form",
-          "description": "The \"form owner\" to associate the button with. If omitted, the closest containing form will be used instead. The\nvalue of this attribute must be an id of a form in the same document or shadow root as the button.",
-          "values": []
-        },
-        {
-          "name": "formaction",
-          "description": "Used to override the form owner's `action` attribute.",
-          "values": []
-        },
-        {
-          "name": "formenctype",
-          "description": "Used to override the form owner's `enctype` attribute.",
-          "values": [
-            { "name": "" },
-            { "name": "application/x-www-form-urlencoded" },
-            { "name": "multipart/form-data" },
-            { "name": "text/plain" }
-          ]
-        },
-        {
-          "name": "formmethod",
-          "description": "Used to override the form owner's `method` attribute.",
-          "values": [{ "name": "post" }, { "name": "get" }]
-        },
-        {
-          "name": "formnovalidate",
-          "description": "Used to override the form owner's `novalidate` attribute.",
-          "values": []
-        },
-        {
-          "name": "formtarget",
-          "description": "Used to override the form owner's `target` attribute.",
-          "values": [
-            { "name": "" },
-            { "name": "_self" },
-            { "name": "_blank" },
-            { "name": "_parent" },
-            { "name": "_top" }
-          ]
+          "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" }]
         }
       ],
       "references": [
         {
           "name": "Documentation",
-          "url": "https://disc.gsfc.nasa.gov/components/button"
+          "url": "https://disc.gsfc.nasa.gov/components/browse-variables"
         }
       ]
     },
@@ -249,44 +120,35 @@
       ]
     },
     {
-      "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.",
+      "name": "terra-giovanni-search",
+      "description": "Fuzzy-search for dataset keywords in combobox with list autocomplete.\n---\n\n\n### **Events:**\n - **terra-giovanni-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": "size",
-          "description": "The loader's size",
-          "values": [{ "name": "small" }, { "name": "large" }]
-        },
-        {
-          "name": "theme",
-          "description": "The loader's theme, light or dark mode",
-          "values": [{ "name": "light" }, { "name": "dark" }]
-        },
-        {
-          "name": "percent",
-          "description": "The percent complete for the loader to display",
+          "name": "label",
+          "description": "Label the combobox with this.",
           "values": []
         },
         {
-          "name": "indeterminate",
-          "description": "an indeterminate loader has an unknown progress and will show a spinner",
+          "name": "placeholder",
+          "description": "Set a placeholder for the combobox with this.\nDefaults to the label's value.",
           "values": []
         },
         {
-          "name": "label",
-          "description": "A label used by a screen reader which describes the loader element (e.g., \"Loading video of Tropical Storm Nepartak\")",
+          "name": "hide-label",
+          "description": "Hide the combobox's label text.\nWhen hidden, still presents to screen readers.",
           "values": []
         },
         {
-          "name": "message",
-          "description": "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\")",
-          "values": []
-        }
+          "name": "searchConfig",
+          "description": "type can be `Boolean`, `String`, `Number`, `Object`, or `Array`",
+          "values": [{ "name": "object" }]
+        },
+        { "name": "value", "values": [] }
       ],
       "references": [
         {
           "name": "Documentation",
-          "url": "https://disc.gsfc.nasa.gov/components/loader"
+          "url": "https://disc.gsfc.nasa.gov/components/giovanni-search"
         }
       ]
     },
@@ -332,6 +194,192 @@
         }
       ]
     },
+    {
+      "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-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.",
+      "attributes": [
+        { "name": "title", "values": [] },
+        {
+          "name": "variant",
+          "description": "The button's theme variant.",
+          "values": [
+            { "name": "" },
+            { "name": "default" },
+            { "name": "primary" },
+            { "name": "success" },
+            { "name": "warning" },
+            { "name": "danger" },
+            { "name": "text" },
+            { "name": "pagelink" }
+          ]
+        },
+        {
+          "name": "size",
+          "description": "The button's size.",
+          "values": [
+            { "name": "small" },
+            { "name": "medium" },
+            { "name": "large" }
+          ]
+        },
+        {
+          "name": "caret",
+          "description": "Draws the button with a caret. Used to indicate that the button triggers a dropdown menu or similar behavior.",
+          "values": []
+        },
+        {
+          "name": "shape",
+          "description": "The button's shape. Used to control the radius edge shape when button is not in a terra-button-group.",
+          "values": [
+            { "name": "square" },
+            { "name": "square-left" },
+            { "name": "square-right" }
+          ]
+        },
+        {
+          "name": "disabled",
+          "description": "Disables the button.",
+          "values": []
+        },
+        {
+          "name": "loading",
+          "description": "Draws the button in a loading state.",
+          "values": []
+        },
+        {
+          "name": "outline",
+          "description": "Draws an outlined button.",
+          "values": []
+        },
+        {
+          "name": "circle",
+          "description": "Draws a circular icon button. When this attribute is present, the button expects a single `<terra-icon>` in the\ndefault slot.",
+          "values": []
+        },
+        {
+          "name": "type",
+          "description": "The type of button. Note that the default value is `button` instead of `submit`, which is opposite of how native\n`<button>` elements behave. When the type is `submit`, the button will submit the surrounding form.",
+          "values": [
+            { "name": "button" },
+            { "name": "submit" },
+            { "name": "reset" }
+          ]
+        },
+        {
+          "name": "name",
+          "description": "The name of the button, submitted as a name/value pair with form data, but only when this button is the submitter.\nThis attribute is ignored when `href` is present.",
+          "values": []
+        },
+        {
+          "name": "value",
+          "description": "The value of the button, submitted as a pair with the button's name as part of the form data, but only when this\nbutton is the submitter. This attribute is ignored when `href` is present.",
+          "values": []
+        },
+        {
+          "name": "href",
+          "description": "When set, the underlying button will be rendered as an `<a>` with this `href` instead of a `<button>`.",
+          "values": []
+        },
+        {
+          "name": "target",
+          "description": "Tells the browser where to open the link. Only used when `href` is present.",
+          "values": [
+            { "name": "_blank" },
+            { "name": "_parent" },
+            { "name": "_self" },
+            { "name": "_top" }
+          ]
+        },
+        {
+          "name": "rel",
+          "description": "When using `href`, this attribute will map to the underlying link's `rel` attribute. Unlike regular links, the\ndefault is `noreferrer noopener` to prevent security exploits. However, if you're using `target` to point to a\nspecific tab/window, this will prevent that from working correctly. You can remove or change the default value by\nsetting the attribute to an empty string or a value of your choice, respectively.",
+          "values": []
+        },
+        {
+          "name": "download",
+          "description": "Tells the browser to download the linked file as this filename. Only used when `href` is present.",
+          "values": []
+        },
+        {
+          "name": "form",
+          "description": "The \"form owner\" to associate the button with. If omitted, the closest containing form will be used instead. The\nvalue of this attribute must be an id of a form in the same document or shadow root as the button.",
+          "values": []
+        },
+        {
+          "name": "formaction",
+          "description": "Used to override the form owner's `action` attribute.",
+          "values": []
+        },
+        {
+          "name": "formenctype",
+          "description": "Used to override the form owner's `enctype` attribute.",
+          "values": [
+            { "name": "" },
+            { "name": "application/x-www-form-urlencoded" },
+            { "name": "multipart/form-data" },
+            { "name": "text/plain" }
+          ]
+        },
+        {
+          "name": "formmethod",
+          "description": "Used to override the form owner's `method` attribute.",
+          "values": [{ "name": "post" }, { "name": "get" }]
+        },
+        {
+          "name": "formnovalidate",
+          "description": "Used to override the form owner's `novalidate` attribute.",
+          "values": []
+        },
+        {
+          "name": "formtarget",
+          "description": "Used to override the form owner's `target` attribute.",
+          "values": [
+            { "name": "" },
+            { "name": "_self" },
+            { "name": "_blank" },
+            { "name": "_parent" },
+            { "name": "_top" }
+          ]
+        }
+      ],
+      "references": [
+        {
+          "name": "Documentation",
+          "url": "https://disc.gsfc.nasa.gov/components/button"
+        }
+      ]
+    },
     {
       "name": "terra-map",
       "description": "A map component for visualizing and selecting coordinates.\n---\n",
@@ -445,73 +493,88 @@
       ]
     },
     {
-      "name": "terra-time-series",
-      "description": "A component for visualizing time series data using the GES DISC Giovanni API.\n---\n",
+      "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### **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": "collection",
-          "description": "a collection entry id (ex: GPM_3IMERGHH_06)",
-          "values": []
-        },
-        {
-          "name": "variable",
-          "description": "a variable short name to plot (ex: precipitationCal)",
+          "name": "label",
+          "description": "Label the combobox with this.",
           "values": []
         },
         {
-          "name": "start-date",
-          "description": "The start date for the time series plot. (ex: 2021-01-01)",
+          "name": "placeholder",
+          "description": "Set a placeholder for the combobox with this.\nDefaults to the label's value.",
           "values": []
         },
         {
-          "name": "end-date",
-          "description": "The end date for the time series plot. (ex: 2021-01-01)",
+          "name": "hide-help",
+          "description": "Hide the combobox's help text.\nWhen hidden, not rendered at all.",
           "values": []
         },
         {
-          "name": "location",
-          "description": "The point location in \"lat,lon\" format.",
+          "name": "hide-label",
+          "description": "Hide the combobox's label text.\nWhen hidden, still presents to screen readers.",
           "values": []
         },
-        { "name": "units", "description": "Units", "values": [] }
+        { "name": "value", "values": [] }
       ],
       "references": [
         {
           "name": "Documentation",
-          "url": "https://disc.gsfc.nasa.gov/components/time-series"
+          "url": "https://disc.gsfc.nasa.gov/components/variable-combobox"
         }
       ]
     },
     {
-      "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### **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-time-series",
+      "description": "A component for visualizing time series data using the GES DISC Giovanni API.\n---\n",
       "attributes": [
         {
-          "name": "label",
-          "description": "Label the combobox with this.",
+          "name": "collection",
+          "description": "a collection entry id (ex: GPM_3IMERGHH_06)",
           "values": []
         },
         {
-          "name": "placeholder",
-          "description": "Set a placeholder for the combobox with this.\nDefaults to the label's value.",
+          "name": "datasetLandingPage",
+          "description": "the dataset landing page for the collection",
           "values": []
         },
         {
-          "name": "hide-help",
-          "description": "Hide the combobox's help text.\nWhen hidden, not rendered at all.",
+          "name": "variable",
+          "description": "a variable short name to plot (ex: precipitationCal)",
           "values": []
         },
         {
-          "name": "hide-label",
-          "description": "Hide the combobox's label text.\nWhen hidden, still presents to screen readers.",
+          "name": "variableLandingPage",
+          "description": "the variable landing page",
           "values": []
         },
-        { "name": "value", "values": [] }
+        {
+          "name": "variableLongName",
+          "description": "a variable long name to plot (e.g., \"Longwave radiation flux downwards (surface)\")",
+          "values": []
+        },
+        {
+          "name": "start-date",
+          "description": "The start date for the time series plot. (ex: 2021-01-01)",
+          "values": []
+        },
+        {
+          "name": "end-date",
+          "description": "The end date for the time series plot. (ex: 2021-01-01)",
+          "values": []
+        },
+        {
+          "name": "location",
+          "description": "The point location in \"lat,lon\" format.",
+          "values": []
+        },
+        { "name": "units", "description": "Units", "values": [] }
       ],
       "references": [
         {
           "name": "Documentation",
-          "url": "https://disc.gsfc.nasa.gov/components/variable-combobox"
+          "url": "https://disc.gsfc.nasa.gov/components/time-series"
         }
       ]
     }