@m3e/stepper 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +22 -0
- package/README.md +263 -0
- package/dist/css-custom-data.json +172 -0
- package/dist/custom-elements.json +4143 -0
- package/dist/html-custom-data.json +99 -0
- package/dist/index.js +1152 -0
- package/dist/index.js.map +1 -0
- package/dist/index.min.js +334 -0
- package/dist/index.min.js.map +1 -0
- package/dist/src/StepElement.d.ts +161 -0
- package/dist/src/StepElement.d.ts.map +1 -0
- package/dist/src/StepHeaderPosition.d.ts +3 -0
- package/dist/src/StepHeaderPosition.d.ts.map +1 -0
- package/dist/src/StepLabelPosition.d.ts +3 -0
- package/dist/src/StepLabelPosition.d.ts.map +1 -0
- package/dist/src/StepPanelElement.d.ts +74 -0
- package/dist/src/StepPanelElement.d.ts.map +1 -0
- package/dist/src/StepperButtonElementBase.d.ts +17 -0
- package/dist/src/StepperButtonElementBase.d.ts.map +1 -0
- package/dist/src/StepperElement.d.ts +139 -0
- package/dist/src/StepperElement.d.ts.map +1 -0
- package/dist/src/StepperNextElement.d.ts +16 -0
- package/dist/src/StepperNextElement.d.ts.map +1 -0
- package/dist/src/StepperOrientation.d.ts +3 -0
- package/dist/src/StepperOrientation.d.ts.map +1 -0
- package/dist/src/StepperPreviousElement.d.ts +16 -0
- package/dist/src/StepperPreviousElement.d.ts.map +1 -0
- package/dist/src/StepperResetElement.d.ts +16 -0
- package/dist/src/StepperResetElement.d.ts.map +1 -0
- package/dist/src/index.d.ts +10 -0
- package/dist/src/index.d.ts.map +1 -0
- package/package.json +48 -0
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://raw.githubusercontent.com/microsoft/vscode-html-languageservice/main/docs/customData.schema.json",
|
|
3
|
+
"version": 1.1,
|
|
4
|
+
"tags": [
|
|
5
|
+
{
|
|
6
|
+
"name": "m3e-step",
|
|
7
|
+
"description": "A step in a wizard-like workflow.\n---\n\n\n### **Events:**\n - **input** - Emitted when the selected state changes.\n- **change** - Emitted when the selected state changes.\n- **click** - Emitted when the element is clicked.\n\n### **Methods:**\n - **reset(): _void_** - Resets the step to its initial state, clearing any form data.\n- **attach(control: _HTMLElement_): _void_** - Attaches the element to an interactive control.\n- **detach(): _void_** - Detaches the element from its current interactive control.\n\n### **Slots:**\n - _default_ - Renders the label of the step.\n- **icon** - Renders the icon of the step.\n- **done-icon** - Renders the icon of a completed step.\n- **edit-icon** - Renders the icon of a completed editable step.\n- **error-icon** - Renders icon of an invalid step.\n- **hint** - Renders the hint text of the step.\n- **error** - Renders the error message for an invalid step.\n\n### **CSS Properties:**\n - **--m3e-step-shape** - Border radius of the step container, defining its visual shape. _(default: undefined)_\n- **--m3e-step-padding** - Internal padding of the step container, used for layout spacing. _(default: undefined)_\n- **--m3e-step-icon-shape** - Border radius of the icon container, controlling its geometric form. _(default: undefined)_\n- **--m3e-step-icon-size** - Width and height of the icon container and icon glyph. _(default: undefined)_\n- **--m3e-step-selected-icon-container-color** - Background color of the icon when the step is selected. _(default: undefined)_\n- **--m3e-step-selected-icon-color** - Foreground color of the icon when the step is selected. _(default: undefined)_\n- **--m3e-step-completed-icon-container-color** - Background color of the icon when the step is completed. _(default: undefined)_\n- **--m3e-step-completed-icon-color** - Foreground color of the icon when the step is completed. _(default: undefined)_\n- **--m3e-step-unselected-icon-container-color** - Background color of the icon when the step is inactive. _(default: undefined)_\n- **--m3e-step-unselected-icon-color** - Foreground color of the icon when the step is inactive. _(default: undefined)_\n- **--m3e-step-icon-error-color** - Foreground color of the icon when the step is invalid. _(default: undefined)_\n- **--m3e-step-disabled-icon-container-color** - Base color used to mix the disabled icon background. _(default: undefined)_\n- **--m3e-step-disabled-icon-color** - Base color used to mix the disabled icon foreground. _(default: undefined)_\n- **--m3e-step-label-color** - Text color of the step label in its default state. _(default: undefined)_\n- **--m3e-step-label-error-color** - Text color of the step label when the step is invalid. _(default: undefined)_\n- **--m3e-step-disabled-label-color** - Base color used to mix the disabled label foreground. _(default: undefined)_\n- **--m3e-step-font-size** - Font size of the step label. _(default: undefined)_\n- **--m3e-step-font-weight** - Font weight of the step label. _(default: undefined)_\n- **--m3e-step-line-height** - Line height of the step label. _(default: undefined)_\n- **--m3e-step-tracking** - Letter spacing of the step label. _(default: undefined)_\n- **--m3e-step-icon-label-space** - Gap between icon and label. _(default: undefined)_\n- **--m3e-step-hint-font-size** - Font size of hint and error messages. _(default: undefined)_\n- **--m3e-step-hint-font-weight** - Font weight of hint and error messages. _(default: undefined)_\n- **--m3e-step-hint-line-height** - Line height of hint and error messages. _(default: undefined)_\n- **--m3e-step-hint-tracking** - Letter spacing of hint and error messages. _(default: undefined)_\n- **--m3e-step-hint-color** - Text color of hint messages in valid state. _(default: undefined)_\n- **--m3e-step-disabled-hint-color** - Base color used to mix the disabled hint foreground. _(default: undefined)_",
|
|
8
|
+
"attributes": [
|
|
9
|
+
{
|
|
10
|
+
"name": "completed",
|
|
11
|
+
"description": "Whether the step has been completed.",
|
|
12
|
+
"values": []
|
|
13
|
+
},
|
|
14
|
+
{
|
|
15
|
+
"name": "disabled",
|
|
16
|
+
"description": "Whether the element is disabled.",
|
|
17
|
+
"values": []
|
|
18
|
+
},
|
|
19
|
+
{
|
|
20
|
+
"name": "editable",
|
|
21
|
+
"description": "Whether the step is editable and users can return to it after completion.",
|
|
22
|
+
"values": []
|
|
23
|
+
},
|
|
24
|
+
{
|
|
25
|
+
"name": "for",
|
|
26
|
+
"description": "The identifier of the interactive control to which this element is attached.",
|
|
27
|
+
"values": []
|
|
28
|
+
},
|
|
29
|
+
{
|
|
30
|
+
"name": "optional",
|
|
31
|
+
"description": "Whether the step is optional.",
|
|
32
|
+
"values": []
|
|
33
|
+
},
|
|
34
|
+
{
|
|
35
|
+
"name": "selected",
|
|
36
|
+
"description": "Whether the element is selected.",
|
|
37
|
+
"values": []
|
|
38
|
+
},
|
|
39
|
+
{
|
|
40
|
+
"name": "invalid",
|
|
41
|
+
"description": "Whether the step has an error.",
|
|
42
|
+
"values": []
|
|
43
|
+
}
|
|
44
|
+
],
|
|
45
|
+
"references": []
|
|
46
|
+
},
|
|
47
|
+
{
|
|
48
|
+
"name": "m3e-step-panel",
|
|
49
|
+
"description": "A panel presented for a step in a wizard-like workflow.\n---\n\n\n### **Slots:**\n - _default_ - Renders the content of the panel.\n- **actions-** - Renders the actions bar of the panel.\n\n### **CSS Properties:**\n - **--m3e-step-panel-padding** - Padding inside the step panel container, defining internal spacing around content. _(default: undefined)_\n- **--m3e-step-panel-spacing** - Vertical gap between stacked elements within the step panel. _(default: undefined)_\n- **--m3e-step-panel-actions-height** - Minimum height of the slotted actions container. _(default: undefined)_",
|
|
50
|
+
"attributes": [],
|
|
51
|
+
"references": []
|
|
52
|
+
},
|
|
53
|
+
{
|
|
54
|
+
"name": "m3e-stepper",
|
|
55
|
+
"description": "Provides a wizard-like workflow by dividing content into logical steps.\n---\n\n\n### **Events:**\n - **change** - Emitted when the selected step changes.\n\n### **Methods:**\n - **movePrevious(): _boolean_** - Moves the stepper to the previous step.\n- **moveNext(): _boolean_** - Moves the stepper to the next step.\n- **moveTo(index: _number_): _boolean_** - Moves the stepper to the step with the specified index.\n- **reset(): _void_** - Resets the stepper to its initial state, clearing any form data.\n\n### **Slots:**\n - **step** - Renders a step.\n- **panel** - Renders a panel.\n\n### **CSS Properties:**\n - **--m3e-step-divider-thickness** - Thickness of the divider line between steps. _(default: undefined)_\n- **--m3e-step-divider-color** - Color of the divider line between steps. _(default: undefined)_\n- **--m3e-step-divider-inset** - Inset offset for divider alignment within step layout. _(default: undefined)_",
|
|
56
|
+
"attributes": [
|
|
57
|
+
{
|
|
58
|
+
"name": "header-position",
|
|
59
|
+
"description": "The position of the step header, when oriented horizontally.",
|
|
60
|
+
"values": [{ "name": "StepHeaderPosition" }]
|
|
61
|
+
},
|
|
62
|
+
{
|
|
63
|
+
"name": "label-position",
|
|
64
|
+
"description": "The position of the step labels, when oriented horizontally.",
|
|
65
|
+
"values": [{ "name": "StepLabelPosition" }]
|
|
66
|
+
},
|
|
67
|
+
{
|
|
68
|
+
"name": "linear",
|
|
69
|
+
"description": "Whether the validity of previous steps should be checked or not.",
|
|
70
|
+
"values": []
|
|
71
|
+
},
|
|
72
|
+
{
|
|
73
|
+
"name": "orientation",
|
|
74
|
+
"description": "The orientation of the stepper.",
|
|
75
|
+
"values": [{ "name": "StepperOrientation" }]
|
|
76
|
+
}
|
|
77
|
+
],
|
|
78
|
+
"references": []
|
|
79
|
+
},
|
|
80
|
+
{
|
|
81
|
+
"name": "m3e-stepper-previous",
|
|
82
|
+
"description": "An element, nested within a clickable element, used to move a stepper to the next step.\n---\n\n\n### **Slots:**\n - _default_ - Renders the content of the action.",
|
|
83
|
+
"attributes": [],
|
|
84
|
+
"references": []
|
|
85
|
+
},
|
|
86
|
+
{
|
|
87
|
+
"name": "m3e-stepper-previous",
|
|
88
|
+
"description": "An element, nested within a clickable element, used to move a stepper to the previous step.\n---\n\n\n### **Slots:**\n - _default_ - Renders the content of the action.",
|
|
89
|
+
"attributes": [],
|
|
90
|
+
"references": []
|
|
91
|
+
},
|
|
92
|
+
{
|
|
93
|
+
"name": "m3e-stepper-reset",
|
|
94
|
+
"description": "An element, nested within a clickable element, used to reset a stepper to its initial state.\n---\n\n\n### **Slots:**\n - _default_ - Renders the content of the action.",
|
|
95
|
+
"attributes": [],
|
|
96
|
+
"references": []
|
|
97
|
+
}
|
|
98
|
+
]
|
|
99
|
+
}
|