@cordwainer/cw-elements 1.5.0-alpha.3 → 1.5.0-alpha.4

package/cdn/custom-elements.json

@@ -20315,6 +20315,434 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "components/stepper/stepper.js",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "",
+          "name": "CwStepper",
+          "cssParts": [
+            {
+              "description": "The component's base wrapper.",
+              "name": "base"
+            }
+          ],
+          "slots": [
+            {
+              "description": "One or more `<cw-stepper-item>` elements to display.",
+              "name": ""
+            }
+          ],
+          "members": [
+            {
+              "kind": "field",
+              "name": "defaultSlot",
+              "type": {
+                "text": "HTMLSlotElement"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "orientation",
+              "type": {
+                "text": "'horizontal' | 'vertical'"
+              },
+              "default": "'horizontal'",
+              "description": "The orientation the steps are laid out in.",
+              "attribute": "orientation",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "linear",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "In linear mode, a step can only be activated if every step before it is completed (or it's the very next step\nafter the last completed one) — this prevents jumping ahead in a required sequence. Off by default, so any step\ncan be activated at any time.",
+              "attribute": "linear",
+              "reflects": true
+            },
+            {
+              "kind": "method",
+              "name": "getItems",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "CwStepperItem[]"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "syncItems",
+              "privacy": "private"
+            },
+            {
+              "kind": "method",
+              "name": "handleOrientationChange"
+            },
+            {
+              "kind": "method",
+              "name": "canActivateInLinearMode",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "boolean"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "target",
+                  "type": {
+                    "text": "CwStepperItem"
+                  }
+                },
+                {
+                  "name": "items",
+                  "type": {
+                    "text": "CwStepperItem[]"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "handleItemShow",
+              "privacy": "private",
+              "parameters": [
+                {
+                  "name": "event",
+                  "type": {
+                    "text": "CwShowEvent"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "field",
+              "name": "handleKeyDown",
+              "privacy": "private"
+            }
+          ],
+          "attributes": [
+            {
+              "name": "orientation",
+              "type": {
+                "text": "'horizontal' | 'vertical'"
+              },
+              "default": "'horizontal'",
+              "description": "The orientation the steps are laid out in.",
+              "fieldName": "orientation"
+            },
+            {
+              "name": "linear",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "In linear mode, a step can only be activated if every step before it is completed (or it's the very next step\nafter the last completed one) — this prevents jumping ahead in a required sequence. Off by default, so any step\ncan be activated at any time.",
+              "fieldName": "linear"
+            }
+          ],
+          "superclass": {
+            "name": "CwElement",
+            "module": "/src/internal/cw-element.js"
+          },
+          "summary": "Steppers show progress through a sequence of steps — a step indicator for multi-step forms, checkouts,\nand onboarding flows.",
+          "tagNameWithoutPrefix": "stepper",
+          "tagName": "cw-stepper",
+          "customElement": true,
+          "jsDoc": "/**\n * @summary Steppers show progress through a sequence of steps — a step indicator for multi-step forms, checkouts,\n *  and onboarding flows.\n * @documentation https://cordwainer.dev/components/stepper\n * @status experimental\n * @since 1.5\n *\n * @slot - One or more `<cw-stepper-item>` elements to display.\n *\n * @csspart base - The component's base wrapper.\n */",
+          "documentation": "https://cordwainer.dev/components/stepper",
+          "status": "experimental",
+          "since": "1.5"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "default",
+          "declaration": {
+            "name": "CwStepper",
+            "module": "components/stepper/stepper.js"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "components/stepper-item/stepper-item.js",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "",
+          "name": "CwStepperItem",
+          "cssParts": [
+            {
+              "description": "The component's base wrapper.",
+              "name": "base"
+            },
+            {
+              "description": "The clickable header containing the indicator and label.",
+              "name": "header"
+            },
+            {
+              "description": "The circular indicator showing the step number, or a completed/error icon.",
+              "name": "indicator"
+            },
+            {
+              "description": "The container that wraps the step's label.",
+              "name": "label"
+            }
+          ],
+          "slots": [
+            {
+              "description": "The step's label.",
+              "name": ""
+            },
+            {
+              "description": "Optional icon to use instead of the default checkmark when the step is completed.",
+              "name": "completed-icon"
+            },
+            {
+              "description": "Optional icon to use instead of the default when the step has an error.",
+              "name": "error-icon"
+            }
+          ],
+          "members": [
+            {
+              "kind": "field",
+              "name": "dependencies",
+              "type": {
+                "text": "object"
+              },
+              "static": true,
+              "default": "{ 'cw-icon': CwIcon }"
+            },
+            {
+              "kind": "field",
+              "name": "header",
+              "type": {
+                "text": "HTMLElement"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "active",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Indicates whether or not this is the current step. Only one step in a `<cw-stepper>` should be active at a time\n— the stepper manages this for you as steps are activated, but you can also set it directly.",
+              "attribute": "active",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "completed",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Indicates that this step has been completed. Steppers in `linear` mode use this to gate which steps can be reached.",
+              "attribute": "completed",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "disabled",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Disables the step so it can't be activated.",
+              "attribute": "disabled",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "error",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Indicates that this step has an error, shown as a distinct visual state on the indicator.",
+              "attribute": "error",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "index",
+              "type": {
+                "text": "number"
+              },
+              "default": "1",
+              "description": "The step's position within its `<cw-stepper>`, 1-based. Set automatically by the parent stepper — you shouldn't\nneed to set this yourself.",
+              "attribute": "index"
+            },
+            {
+              "kind": "field",
+              "name": "orientation",
+              "type": {
+                "text": "'horizontal' | 'vertical'"
+              },
+              "default": "'horizontal'",
+              "description": "The orientation of the stepper this item belongs to, used to draw the connecting line to the next step. Set\nautomatically by the parent stepper — you shouldn't need to set this yourself.",
+              "attribute": "orientation",
+              "reflects": true
+            },
+            {
+              "kind": "method",
+              "name": "focus",
+              "parameters": [
+                {
+                  "name": "options",
+                  "optional": true,
+                  "type": {
+                    "text": "FocusOptions"
+                  }
+                }
+              ],
+              "description": "Moves focus to the step's header."
+            },
+            {
+              "kind": "method",
+              "name": "blur",
+              "description": "Removes focus from the step's header."
+            },
+            {
+              "kind": "method",
+              "name": "handleHeaderClick",
+              "privacy": "private"
+            },
+            {
+              "kind": "method",
+              "name": "handleActiveChange"
+            },
+            {
+              "kind": "method",
+              "name": "show",
+              "description": "Activates the step, making it the current one."
+            },
+            {
+              "kind": "method",
+              "name": "hide",
+              "description": "Deactivates the step. Only the parent `<cw-stepper>` normally needs to call this."
+            }
+          ],
+          "events": [
+            {
+              "description": "Emitted when the step becomes active.",
+              "name": "cw-show",
+              "reactName": "onCwShow",
+              "eventName": "CwShowEvent"
+            },
+            {
+              "description": "Emitted after the step becomes active.",
+              "name": "cw-after-show",
+              "reactName": "onCwAfterShow",
+              "eventName": "CwAfterShowEvent"
+            },
+            {
+              "description": "Emitted when the step is no longer active.",
+              "name": "cw-hide",
+              "reactName": "onCwHide",
+              "eventName": "CwHideEvent"
+            },
+            {
+              "description": "Emitted after the step is no longer active.",
+              "name": "cw-after-hide",
+              "reactName": "onCwAfterHide",
+              "eventName": "CwAfterHideEvent"
+            }
+          ],
+          "attributes": [
+            {
+              "name": "active",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Indicates whether or not this is the current step. Only one step in a `<cw-stepper>` should be active at a time\n— the stepper manages this for you as steps are activated, but you can also set it directly.",
+              "fieldName": "active"
+            },
+            {
+              "name": "completed",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Indicates that this step has been completed. Steppers in `linear` mode use this to gate which steps can be reached.",
+              "fieldName": "completed"
+            },
+            {
+              "name": "disabled",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Disables the step so it can't be activated.",
+              "fieldName": "disabled"
+            },
+            {
+              "name": "error",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Indicates that this step has an error, shown as a distinct visual state on the indicator.",
+              "fieldName": "error"
+            },
+            {
+              "name": "index",
+              "type": {
+                "text": "number"
+              },
+              "default": "1",
+              "description": "The step's position within its `<cw-stepper>`, 1-based. Set automatically by the parent stepper — you shouldn't\nneed to set this yourself.",
+              "fieldName": "index"
+            },
+            {
+              "name": "orientation",
+              "type": {
+                "text": "'horizontal' | 'vertical'"
+              },
+              "default": "'horizontal'",
+              "description": "The orientation of the stepper this item belongs to, used to draw the connecting line to the next step. Set\nautomatically by the parent stepper — you shouldn't need to set this yourself.",
+              "fieldName": "orientation"
+            }
+          ],
+          "superclass": {
+            "name": "CwElement",
+            "module": "/src/internal/cw-element.js"
+          },
+          "summary": "Stepper items are individual steps used inside a [stepper](/components/stepper) — a step indicator for\nmulti-step forms, checkouts, and onboarding flows.",
+          "tagNameWithoutPrefix": "stepper-item",
+          "tagName": "cw-stepper-item",
+          "customElement": true,
+          "jsDoc": "/**\n * @summary Stepper items are individual steps used inside a [stepper](/components/stepper) — a step indicator for\n *  multi-step forms, checkouts, and onboarding flows.\n * @documentation https://cordwainer.dev/components/stepper-item\n * @status experimental\n * @since 1.5\n *\n * @dependency cw-icon\n *\n * @slot - The step's label.\n * @slot completed-icon - Optional icon to use instead of the default checkmark when the step is completed.\n * @slot error-icon - Optional icon to use instead of the default when the step has an error.\n *\n * @event cw-show - Emitted when the step becomes active.\n * @event cw-after-show - Emitted after the step becomes active.\n * @event cw-hide - Emitted when the step is no longer active.\n * @event cw-after-hide - Emitted after the step is no longer active.\n *\n * @csspart base - The component's base wrapper.\n * @csspart header - The clickable header containing the indicator and label.\n * @csspart indicator - The circular indicator showing the step number, or a completed/error icon.\n * @csspart label - The container that wraps the step's label.\n */",
+          "documentation": "https://cordwainer.dev/components/stepper-item",
+          "status": "experimental",
+          "since": "1.5",
+          "dependencies": [
+            "cw-icon"
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "default",
+          "declaration": {
+            "name": "CwStepperItem",
+            "module": "components/stepper-item/stepper-item.js"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "components/switch/switch.js",
@@ -24687,7 +25115,7 @@
   "package": {
     "name": "@cordwainer/cw-elements",
     "description": "Cordwainer Elements — Web Component Library, a hard fork of Shoelace (@shoelace-style/shoelace).",
-    "version": "1.5.0-alpha.3",
+    "version": "1.5.0-alpha.4",
     "author": "Matt Hand",
     "homepage": "https://cordwainer.dev",
     "license": "MIT"

package/cdn/cw-elements.d.ts

@@ -74,6 +74,8 @@ export { default as CwFooter } from './components/footer/footer.js';
 export { default as CwPopover } from './components/popover/popover.js';
 export { default as CwAccordion } from './components/accordion/accordion.js';
 export { default as CwAccordionItem } from './components/accordion-item/accordion-item.js';
+export { default as CwStepper } from './components/stepper/stepper.js';
+export { default as CwStepperItem } from './components/stepper-item/stepper-item.js';
 export * from './utilities/animation.js';
 export * from './utilities/base-path.js';
 export * from './utilities/icon-library.js';