@nysds/components 1.16.0 → 1.17.0

package/custom-elements.json

@@ -1479,6 +1479,377 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "packages/nys-breadcrumbs/src/index.ts",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "module": "packages/nys-breadcrumbs/src/nys-breadcrumbs"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "packages/nys-breadcrumbs/src/nys-breadcrumbs.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "A breadcrumb navigation trail composed of `nys-breadcrumbitem` elements.\nCollapses when the trail exceeds 5 items on desktop or 3 items on mobile,\nshowing the first, last, and item before the current page, with an ellipsis to expand.\nA single item renders as a back-to-parent link instead of a trail.",
+          "name": "NysBreadcrumbs",
+          "slots": [
+            {
+              "description": "One or more `nys-breadcrumbitem` elements defining the trail.",
+              "name": ""
+            }
+          ],
+          "members": [
+            {
+              "kind": "field",
+              "name": "id",
+              "type": {
+                "text": "string"
+              },
+              "default": "\"\"",
+              "description": "Unique identifier. Auto-generated if not provided.",
+              "attribute": "id",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "ariaLabel",
+              "type": {
+                "text": "string"
+              },
+              "default": "\"\"",
+              "description": "Accessible label for the `<nav>` landmark. Defaults to \"path to this page\" if not set.\nOverride when multiple crumbs exist on the same page.",
+              "attribute": "ariaLabel"
+            },
+            {
+              "kind": "field",
+              "name": "size",
+              "type": {
+                "text": "\"sm\" | \"md\" | \"\""
+              },
+              "default": "\"md\"",
+              "description": "Controls the visual size of the breadcrumb text and spacing: `sm` for dense layouts, `md` (default) for standard use.",
+              "attribute": "size",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "backToParent",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "On mobile, renders the trail as a single back-to-parent link pointing to the item before the current page.\nHas no effect on desktop or when only one item is present (which always renders as a back link).",
+              "attribute": "backToParent"
+            },
+            {
+              "kind": "field",
+              "name": "collapsed",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Forces the trail into its collapsed state.\nIt shows only the first item, an ellipsis, and the last two items.\nThe user can still expand the trail by clicking the ellipsis.",
+              "attribute": "collapsed"
+            },
+            {
+              "kind": "field",
+              "name": "backgroundBar",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Renders a filled light theme background bar behind the breadcrumb trail.",
+              "attribute": "backgroundBar"
+            },
+            {
+              "kind": "field",
+              "name": "disabled",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Prevents interaction.",
+              "attribute": "disabled",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "_collapseThreshold",
+              "type": {
+                "text": "number"
+              },
+              "privacy": "private",
+              "default": "5"
+            },
+            {
+              "kind": "field",
+              "name": "_manuallyExpanded",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "private",
+              "default": "false"
+            },
+            {
+              "kind": "field",
+              "name": "_mediaQuery",
+              "type": {
+                "text": "MediaQueryList | null"
+              },
+              "privacy": "private",
+              "default": "null"
+            },
+            {
+              "kind": "field",
+              "name": "_updateCollapseThreshold",
+              "privacy": "private",
+              "description": "Functions\n--------------------------------------------------------------------------"
+            },
+            {
+              "kind": "method",
+              "name": "_getSlottedOl",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "HTMLOListElement | null"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "_getSlottedItems",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "HTMLLIElement[]"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "_getAnchor",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "HTMLAnchorElement | null"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "li",
+                  "type": {
+                    "text": "HTMLLIElement"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "_isCurrentPage",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "boolean"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "li",
+                  "type": {
+                    "text": "HTMLLIElement"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "_createBackToParentElement",
+              "privacy": "private",
+              "parameters": [
+                {
+                  "name": "li",
+                  "type": {
+                    "text": "HTMLLIElement"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "_createCrumbElement",
+              "privacy": "private",
+              "parameters": [
+                {
+                  "name": "li",
+                  "type": {
+                    "text": "HTMLLIElement"
+                  }
+                },
+                {
+                  "name": "isCurrentPage",
+                  "type": {
+                    "text": "boolean"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "_handleSlotChange",
+              "privacy": "private",
+              "description": "Main logic for cloning and handling user slots.\nNew <ol>, <li>, and <a> tags are created and rendered out as crumbs for the breadcrumbs trail."
+            },
+            {
+              "kind": "method",
+              "name": "_moveFocusToFirstExpandCrumb",
+              "privacy": "private"
+            },
+            {
+              "kind": "method",
+              "name": "_dispatchExpandEvent",
+              "privacy": "private",
+              "description": "Event Handlers\n--------------------------------------------------------------------------"
+            }
+          ],
+          "events": [
+            {
+              "name": "nys-expand",
+              "type": {
+                "text": "CustomEvent"
+              }
+            },
+            {
+              "description": "Fired when the user clicks the ellipsis to expand the trail.",
+              "name": "nys-breadcrumbs-expand"
+            }
+          ],
+          "attributes": [
+            {
+              "name": "id",
+              "type": {
+                "text": "string"
+              },
+              "default": "\"\"",
+              "description": "Unique identifier. Auto-generated if not provided.",
+              "fieldName": "id",
+              "propName": "id"
+            },
+            {
+              "name": "ariaLabel",
+              "type": {
+                "text": "string"
+              },
+              "default": "\"\"",
+              "description": "Accessible label for the `<nav>` landmark. Defaults to \"path to this page\" if not set.\nOverride when multiple crumbs exist on the same page.",
+              "fieldName": "ariaLabel",
+              "propName": "arialabel"
+            },
+            {
+              "name": "size",
+              "type": {
+                "text": "\"sm\" | \"md\" | \"\""
+              },
+              "default": "\"md\"",
+              "description": "Controls the visual size of the breadcrumb text and spacing: `sm` for dense layouts, `md` (default) for standard use.",
+              "fieldName": "size",
+              "propName": "size"
+            },
+            {
+              "name": "backToParent",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "On mobile, renders the trail as a single back-to-parent link pointing to the item before the current page.\nHas no effect on desktop or when only one item is present (which always renders as a back link).",
+              "fieldName": "backToParent",
+              "propName": "backtoparent"
+            },
+            {
+              "name": "collapsed",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Forces the trail into its collapsed state.\nIt shows only the first item, an ellipsis, and the last two items.\nThe user can still expand the trail by clicking the ellipsis.",
+              "fieldName": "collapsed",
+              "propName": "collapsed"
+            },
+            {
+              "name": "backgroundBar",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Renders a filled light theme background bar behind the breadcrumb trail.",
+              "fieldName": "backgroundBar",
+              "propName": "backgroundbar"
+            },
+            {
+              "name": "disabled",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Prevents interaction.",
+              "fieldName": "disabled",
+              "propName": "disabled"
+            }
+          ],
+          "superclass": {
+            "name": "LitElement",
+            "package": "lit"
+          },
+          "tagName": "nys-breadcrumbs",
+          "customElement": true,
+          "summary": "Breadcrumb navigation trail with responsive collapse support.",
+          "examples": [
+            {
+              "title": "Full trail with current page",
+              "code": "<nys-breadcrumbs>\n<ol>\n<li><a href=\"/\">Home</a></li>\n<li><a href=\"/services\">Services</a></li>\n<li>Current Page</li>\n</ol>\n</nys-breadcrumbs>",
+              "lang": "html"
+            },
+            {
+              "title": "Trail without current page",
+              "code": "<nys-breadcrumbs>\n<ol>\n<li><a href=\"/\">Home</a></li>\n<li><a href=\"/services\">Services</a></li>\n</ol>\n</nys-breadcrumbs>",
+              "lang": "html"
+            },
+            {
+              "title": "Single item renders as back-to-parent",
+              "code": "<nys-breadcrumbs>\n<ol>\n<li><a href=\"/services\">Services</a></li>\n</ol>\n</nys-breadcrumbs>",
+              "lang": "html"
+            }
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "custom-element-definition",
+          "name": "nys-breadcrumbs",
+          "declaration": {
+            "name": "NysBreadcrumbs",
+            "module": "packages/nys-breadcrumbs/src/nys-breadcrumbs.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "NysBreadcrumbs",
+          "declaration": {
+            "name": "NysBreadcrumbs",
+            "module": "packages/nys-breadcrumbs/src/nys-breadcrumbs.ts"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "packages/nys-button/src/index.ts",
@@ -1667,7 +2038,7 @@
                 "text": "string"
               },
               "default": "\"\"",
-              "description": "Material Symbol icon before label. Not shown for `text` variant or `circle` mode.",
+              "description": "Material Symbol icon before label. Not shown for `circle` mode.",
               "attribute": "prefixIcon"
             },
             {
@@ -1677,7 +2048,7 @@
                 "text": "string"
               },
               "default": "\"\"",
-              "description": "Material Symbol icon after label. Use `chevron_down` for dropdowns, `open_in_new` for external links. Not shown for `text` variant or `circle` mode.",
+              "description": "Material Symbol icon after label. Use `chevron_down` for dropdowns, `open_in_new` for external links. Not shown for `circle` mode.",
               "attribute": "suffixIcon"
             },
             {
@@ -1991,7 +2362,7 @@
                 "text": "string"
               },
               "default": "\"\"",
-              "description": "Material Symbol icon before label. Not shown for `text` variant or `circle` mode.",
+              "description": "Material Symbol icon before label. Not shown for `circle` mode.",
               "fieldName": "prefixIcon",
               "propName": "prefixicon"
             },
@@ -2001,7 +2372,7 @@
                 "text": "string"
               },
               "default": "\"\"",
-              "description": "Material Symbol icon after label. Use `chevron_down` for dropdowns, `open_in_new` for external links. Not shown for `text` variant or `circle` mode.",
+              "description": "Material Symbol icon after label. Use `chevron_down` for dropdowns, `open_in_new` for external links. Not shown for `circle` mode.",
               "fieldName": "suffixIcon",
               "propName": "suffixicon"
             },
@@ -3391,6 +3762,15 @@
             }
           ],
           "members": [
+            {
+              "kind": "field",
+              "name": "shadowRootOptions",
+              "type": {
+                "text": "object"
+              },
+              "static": true,
+              "default": "{ ...LitElement.shadowRootOptions, delegatesFocus: true, }"
+            },
             {
               "kind": "field",
               "name": "id",
@@ -4275,6 +4655,26 @@
               "description": "Initial date when calendar opens (YYYY-MM-DD).",
               "attribute": "startDate"
             },
+            {
+              "kind": "field",
+              "name": "minDate",
+              "type": {
+                "text": "string"
+              },
+              "default": "\"\"",
+              "description": "The earliest selectable date (YYYY-MM-DD).",
+              "attribute": "minDate"
+            },
+            {
+              "kind": "field",
+              "name": "maxDate",
+              "type": {
+                "text": "string"
+              },
+              "default": "\"\"",
+              "description": "The latest selectable date (YYYY-MM-DD).",
+              "attribute": "maxDate"
+            },
             {
               "kind": "field",
               "name": "inverted",
@@ -4419,6 +4819,11 @@
               "kind": "method",
               "name": "_parseLocalDate",
               "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "Date"
+                }
+              },
               "parameters": [
                 {
                   "name": "dateString",
@@ -4444,6 +4849,24 @@
                 }
               ]
             },
+            {
+              "kind": "method",
+              "name": "_isOutOfRange",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "boolean"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "date",
+                  "type": {
+                    "text": "Date"
+                  }
+                }
+              ]
+            },
             {
               "kind": "method",
               "name": "_dispatchInputEvent",
@@ -4764,6 +5187,26 @@
               "fieldName": "startDate",
               "propName": "startdate"
             },
+            {
+              "name": "minDate",
+              "type": {
+                "text": "string"
+              },
+              "default": "\"\"",
+              "description": "The earliest selectable date (YYYY-MM-DD).",
+              "fieldName": "minDate",
+              "propName": "mindate"
+            },
+            {
+              "name": "maxDate",
+              "type": {
+                "text": "string"
+              },
+              "default": "\"\"",
+              "description": "The latest selectable date (YYYY-MM-DD).",
+              "fieldName": "maxDate",
+              "propName": "maxdate"
+            },
             {
               "name": "inverted",
               "type": {
@@ -5021,6 +5464,15 @@
               "privacy": "private",
               "default": "null"
             },
+            {
+              "kind": "field",
+              "name": "_lastFocusedIndex",
+              "type": {
+                "text": "number"
+              },
+              "privacy": "private",
+              "default": "0"
+            },
             {
               "kind": "field",
               "name": "GAP",
@@ -5069,8 +5521,17 @@
             },
             {
               "kind": "method",
-              "name": "_focusOnFirstItem",
-              "privacy": "private"
+              "name": "_focusOnItem",
+              "privacy": "private",
+              "parameters": [
+                {
+                  "name": "index",
+                  "default": "0",
+                  "type": {
+                    "text": "number"
+                  }
+                }
+              ]
             },
             {
               "kind": "method",
@@ -5235,11 +5696,16 @@
               ]
             },
             {
-              "kind": "field",
-              "name": "_handleTriggerKeydown",
+              "kind": "method",
+              "name": "_handleMenuClick",
               "privacy": "private",
               "description": "Event Handlers\n--------------------------------------------------------------------------"
             },
+            {
+              "kind": "field",
+              "name": "_handleTriggerKeydown",
+              "privacy": "private"
+            },
             {
               "kind": "field",
               "name": "_handleMenuKeydown",
@@ -5528,6 +5994,17 @@
           "description": "**Internal component.** Displays error messages for form validation with icon and ARIA alert role.\n\nUsed internally by form components. Not intended for direct use. Shows error icon and message\nwhen `showError` is true. Integrates with ElementInternals for native form validation messages.",
           "name": "NysErrorMessage",
           "members": [
+            {
+              "kind": "field",
+              "name": "id",
+              "type": {
+                "text": "string"
+              },
+              "default": "\"\"",
+              "description": "The \"id\" of the error message.",
+              "attribute": "id",
+              "reflects": true
+            },
             {
               "kind": "field",
               "name": "showError",
@@ -5558,27 +6035,19 @@
               "description": "Shows a divider line above the error message.",
               "attribute": "showDivider",
               "reflects": true
-            },
+            }
+          ],
+          "attributes": [
             {
-              "kind": "field",
-              "name": "_internals",
+              "name": "id",
               "type": {
-                "text": "ElementInternals"
+                "text": "string"
               },
-              "privacy": "private"
+              "default": "\"\"",
+              "description": "The \"id\" of the error message.",
+              "fieldName": "id",
+              "propName": "id"
             },
-            {
-              "kind": "field",
-              "name": "formAssociated",
-              "type": {
-                "text": "boolean"
-              },
-              "static": true,
-              "default": "true",
-              "description": "Lifecycle methods\n--------------------------------------------------------------------------"
-            }
-          ],
-          "attributes": [
             {
               "name": "showError",
               "type": {
@@ -7074,13 +7543,14 @@
           "members": [
             {
               "kind": "field",
-              "name": "for",
+              "name": "id",
               "type": {
                 "text": "string"
               },
               "default": "\"\"",
-              "description": "ID of the form element this label is associated with.",
-              "attribute": "for"
+              "description": "The ID of the label.",
+              "attribute": "id",
+              "reflects": true
             },
             {
               "kind": "field",
@@ -7126,43 +7596,38 @@
             {
               "kind": "field",
               "name": "tooltip",
-              "description": "Tooltip text shown on hover/focus of info icon next to label.",
-              "attribute": "tooltip"
-            },
-            {
-              "kind": "field",
-              "name": "_tooltip",
               "type": {
                 "text": "string"
               },
-              "privacy": "private",
-              "default": "\"\""
+              "default": "\"\"",
+              "description": "Tooltip text shown on hover/focus of info icon next to label.",
+              "attribute": "tooltip"
             },
             {
               "kind": "method",
-              "name": "_handleLabelClick",
+              "name": "_dispatchLabelClick",
               "privacy": "private",
-              "parameters": [
-                {
-                  "name": "event",
-                  "type": {
-                    "text": "Event"
-                  }
-                }
-              ],
-              "description": "Event Handlers\n--------------------------------------------------------------------------"
+              "description": "While most components don't need to listen for this event.\nSpecial components like \"nys-fileinput\" and \"nys-toggle\" need to listen for label to execute their specific functionalities."
+            }
+          ],
+          "events": [
+            {
+              "name": "nys-label-click",
+              "type": {
+                "text": "CustomEvent"
+              }
             }
           ],
           "attributes": [
             {
-              "name": "for",
+              "name": "id",
               "type": {
                 "text": "string"
               },
               "default": "\"\"",
-              "description": "ID of the form element this label is associated with.",
-              "fieldName": "for",
-              "propName": "for"
+              "description": "The ID of the label.",
+              "fieldName": "id",
+              "propName": "id"
             },
             {
               "name": "label",
@@ -7206,6 +7671,10 @@
             },
             {
               "name": "tooltip",
+              "type": {
+                "text": "string"
+              },
+              "default": "\"\"",
               "description": "Tooltip text shown on hover/focus of info icon next to label.",
               "fieldName": "tooltip",
               "propName": "tooltip"
@@ -11385,6 +11854,14 @@
               "description": "Error message text. Shown only when `showError` is true.",
               "attribute": "errorMessage"
             },
+            {
+              "kind": "field",
+              "name": "_inputEl",
+              "type": {
+                "text": "HTMLInputElement"
+              },
+              "privacy": "private"
+            },
             {
               "kind": "field",
               "name": "showPassword",
@@ -13094,7 +13571,7 @@
       "declarations": [
         {
           "kind": "class",
-          "description": "",
+          "description": "A YouTube video player with a thumbnail preview and play button.\nLoads the iframe only after the user clicks play, keeping initial page load light.\nSupports autoplay (muted), custom thumbnails, start time, lazy loading, and disabled state.\nAnnounces playback state and ad state to screen readers via a live region.\n\nFor use with YouTube URLs only. Component renders nothing if the URL is invalid.",
           "name": "NysVideo",
           "members": [
             {
@@ -13270,6 +13747,12 @@
               "privacy": "private"
             }
           ],
+          "events": [
+            {
+              "description": "Fired when the user clicks the thumbnail to load the player.",
+              "name": "nys-video-play"
+            }
+          ],
           "attributes": [
             {
               "name": "id",
@@ -13366,7 +13849,15 @@
             "package": "lit"
           },
           "tagName": "nys-video",
-          "customElement": true
+          "customElement": true,
+          "summary": "YouTube video player with thumbnail preview and accessibility announcements.",
+          "examples": [
+            {
+              "title": "Basic usage",
+              "code": "<nys-video\nvideourl=\"https://www.youtube.com/watch?v=dQw4w9WgXcQ\"\ntitleText=\"Video Title\"\n></nys-video>",
+              "lang": "html"
+            }
+          ]
         }
       ],
       "exports": [