@maltjoy/mcp-server 0.3.0 → 0.3.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/README.md +11 -28
- package/dist/doc/VJoyAdminBanner/metadata.json +1 -0
- package/dist/doc/VJoyAvailability/metadata.json +1 -0
- package/dist/doc/VJoyAvatar/metadata.json +2 -0
- package/dist/doc/VJoyAvatarsList/metadata.json +1 -0
- package/dist/doc/VJoyBadge/metadata.json +1 -0
- package/dist/doc/VJoyBadgeLevel/metadata.json +1 -0
- package/dist/doc/VJoyBlockSkeleton/metadata.json +1 -0
- package/dist/doc/VJoyBottomSheet/metadata.json +1 -0
- package/dist/doc/VJoyBottomSheetTrigger/metadata.json +1 -0
- package/dist/doc/VJoyButton/JoyButton.types.ts +1 -1
- package/dist/doc/VJoyButton/metadata.json +1 -0
- package/dist/doc/VJoyCheckbox/metadata.json +1 -0
- package/dist/doc/VJoyCollapse/metadata.json +1 -0
- package/dist/doc/VJoyCollapseItem/metadata.json +1 -0
- package/dist/doc/VJoyCompanyAvatar/metadata.json +1 -0
- package/dist/doc/VJoyDialog/metadata.json +1 -0
- package/dist/doc/VJoyDialogTrigger/metadata.json +1 -0
- package/dist/doc/VJoyDot/metadata.json +1 -0
- package/dist/doc/VJoyDrawer/metadata.json +1 -0
- package/dist/doc/VJoyDrawerTrigger/metadata.json +1 -0
- package/dist/doc/VJoyDropdown/metadata.json +1 -0
- package/dist/doc/VJoyDropdownList/metadata.json +1 -0
- package/dist/doc/VJoyDropzone/metadata.json +1 -0
- package/dist/doc/VJoyFilterBar/metadata.json +1 -0
- package/dist/doc/VJoyFilterBarButton/metadata.json +1 -0
- package/dist/doc/VJoyFormError/metadata.json +1 -0
- package/dist/doc/VJoyFormFieldSkeleton/metadata.json +1 -0
- package/dist/doc/VJoyFormGroup/metadata.json +15 -0
- package/dist/doc/VJoyFunnel/metadata.json +1 -0
- package/dist/doc/VJoyFunnelFooter/metadata.json +1 -0
- package/dist/doc/VJoyFunnelHeader/metadata.json +1 -0
- package/dist/doc/VJoyHighlight/metadata.json +1 -0
- package/dist/doc/VJoyIcon/JoyIcon.types.ts +1 -1
- package/dist/doc/VJoyIcon/metadata.json +3 -2
- package/dist/doc/VJoyIndicator/metadata.json +1 -0
- package/dist/doc/VJoyIndicators/metadata.json +1 -0
- package/dist/doc/VJoyInput/JoyInput.types.ts +4 -0
- package/dist/doc/VJoyInput/metadata.json +5 -0
- package/dist/doc/VJoyInputDigit/JoyInputDigit.types.ts +14 -0
- package/dist/doc/VJoyInputDigit/metadata.json +155 -0
- package/dist/doc/VJoyInputPassword/metadata.json +260 -0
- package/dist/doc/VJoyLabel/JoyLabel.types.ts +1 -0
- package/dist/doc/VJoyLabel/metadata.json +1 -0
- package/dist/doc/VJoyLink/metadata.json +1 -0
- package/dist/doc/VJoyListItem/metadata.json +1 -0
- package/dist/doc/VJoyMenu/metadata.json +1 -0
- package/dist/doc/VJoyMenuItem/JoyMenuItem.types.ts +14 -0
- package/dist/doc/VJoyMenuItem/metadata.json +1 -0
- package/dist/doc/VJoyMultiCheckbox/metadata.json +1 -0
- package/dist/doc/VJoyPagination/metadata.json +1 -0
- package/dist/doc/VJoyPanel/metadata.json +1 -0
- package/dist/doc/VJoyPanelSection/metadata.json +1 -0
- package/dist/doc/VJoyPasswordRequirement/JoyPasswordRequirement.types.ts +8 -0
- package/dist/doc/VJoyPasswordRequirement/metadata.json +40 -0
- package/dist/doc/VJoyProductTour/metadata.json +1 -0
- package/dist/doc/VJoyProductTourTrigger/metadata.json +1 -0
- package/dist/doc/VJoyProgressBar/metadata.json +1 -0
- package/dist/doc/VJoyRadio/metadata.json +1 -0
- package/dist/doc/VJoyRadioGroup/metadata.json +1 -0
- package/dist/doc/VJoyRatingStars/metadata.json +1 -0
- package/dist/doc/VJoyScreenLoader/metadata.json +1 -0
- package/dist/doc/VJoySelect/metadata.json +1 -0
- package/dist/doc/VJoySelectableItem/metadata.json +1 -0
- package/dist/doc/VJoySelectableItemGroup/metadata.json +1 -0
- package/dist/doc/VJoySeparator/metadata.json +1 -0
- package/dist/doc/VJoySnackbar/metadata.json +1 -0
- package/dist/doc/VJoySpinner/metadata.json +1 -0
- package/dist/doc/VJoyStep/metadata.json +1 -0
- package/dist/doc/VJoyStepper/metadata.json +1 -0
- package/dist/doc/VJoyTab/metadata.json +1 -0
- package/dist/doc/VJoyTabs/metadata.json +1 -0
- package/dist/doc/VJoyTag/metadata.json +2 -0
- package/dist/doc/VJoyTagsInput/metadata.json +2 -0
- package/dist/doc/VJoyTagsList/metadata.json +2 -0
- package/dist/doc/VJoyTemplate/metadata.json +1 -0
- package/dist/doc/VJoyTemplateShape/metadata.json +1 -0
- package/dist/doc/VJoyText/metadata.json +1 -0
- package/dist/doc/VJoyTextarea/metadata.json +1 -0
- package/dist/doc/VJoyTitleBrand/metadata.json +1 -0
- package/dist/doc/VJoyToggle/metadata.json +1 -0
- package/dist/doc/VJoyTooltip/metadata.json +1 -0
- package/dist/doc/VJoyUserCard/metadata.json +1 -0
- package/dist/doc/VJoyWalkthrough/metadata.json +1 -0
- package/dist/doc/VJoyWalkthroughTrigger/metadata.json +1 -0
- package/dist/doc/VJoyWrapper/metadata.json +1 -0
- package/dist/doc/index.json +117 -7
- package/dist/index.js +1 -1
- package/dist/parser.d.ts +9 -0
- package/dist/parser.d.ts.map +1 -1
- package/dist/parser.js +22 -0
- package/dist/parser.js.map +1 -1
- package/dist/tools/list-components.d.ts +2 -1
- package/dist/tools/list-components.d.ts.map +1 -1
- package/dist/tools/list-components.js +3 -3
- package/dist/tools/list-components.js.map +1 -1
- package/package.json +1 -1
package/dist/doc/index.json
CHANGED
|
@@ -1,18 +1,19 @@
|
|
|
1
1
|
{
|
|
2
|
-
"generated": "2026-
|
|
3
|
-
"version": "
|
|
2
|
+
"generated": "2026-03-31T07:17:49.017Z",
|
|
3
|
+
"version": "0.3.2",
|
|
4
4
|
"statistics": {
|
|
5
|
-
"totalComponents":
|
|
6
|
-
"totalProps":
|
|
7
|
-
"totalEvents":
|
|
8
|
-
"totalSlots":
|
|
9
|
-
"componentsWithVModel":
|
|
5
|
+
"totalComponents": 78,
|
|
6
|
+
"totalProps": 433,
|
|
7
|
+
"totalEvents": 62,
|
|
8
|
+
"totalSlots": 139,
|
|
9
|
+
"componentsWithVModel": 20,
|
|
10
10
|
"componentsWithErrors": 0,
|
|
11
11
|
"componentsWithPartialErrors": 1
|
|
12
12
|
},
|
|
13
13
|
"components": [
|
|
14
14
|
{
|
|
15
15
|
"name": "VJoyAdminBanner",
|
|
16
|
+
"description": "The AdminBanner component displays a visual indicator when users are viewing the application in admin mode. It features a distinctive banner with an eye icon and customizable label, typically positioned at the top of the interface to clearly communicate the current viewing context to administrators.",
|
|
16
17
|
"path": "VJoyAdminBanner/metadata.json",
|
|
17
18
|
"propsCount": 1,
|
|
18
19
|
"eventsCount": 0,
|
|
@@ -21,6 +22,7 @@
|
|
|
21
22
|
},
|
|
22
23
|
{
|
|
23
24
|
"name": "VJoyAvailability",
|
|
25
|
+
"description": "A status indicator component for displaying user availability information. Features colored dots and optional labels to communicate different availability states such as available, not available, available soon, or partially available. Can be displayed as a simple dot indicator or with descriptive text labels that handle long content gracefully.",
|
|
24
26
|
"path": "VJoyAvailability/metadata.json",
|
|
25
27
|
"propsCount": 3,
|
|
26
28
|
"eventsCount": 0,
|
|
@@ -29,6 +31,7 @@
|
|
|
29
31
|
},
|
|
30
32
|
{
|
|
31
33
|
"name": "VJoyAvatar",
|
|
34
|
+
"description": "A versatile avatar component for displaying user profile pictures, initials, or placeholders depending on given properties. Supports multiple sizes, fallback to initials when no photo is provided, anonymous states with icons, numeric indicators for \"more users\" displays, and special variants like strategy profiles and company avatars. Can be styled as clickable links and includes empty states for various use cases.",
|
|
32
35
|
"path": "VJoyAvatar/metadata.json",
|
|
33
36
|
"propsCount": 10,
|
|
34
37
|
"eventsCount": 1,
|
|
@@ -37,6 +40,7 @@
|
|
|
37
40
|
},
|
|
38
41
|
{
|
|
39
42
|
"name": "VJoyAvatarsList",
|
|
43
|
+
"description": "A container component for displaying multiple avatars in a styled group layout. Provides consistent spacing and alignment for avatar collections, with an optional compressed mode for more compact displays. Designed to work seamlessly with VJoyAvatar components.",
|
|
40
44
|
"path": "VJoyAvatarsList/metadata.json",
|
|
41
45
|
"propsCount": 1,
|
|
42
46
|
"eventsCount": 0,
|
|
@@ -45,6 +49,7 @@
|
|
|
45
49
|
},
|
|
46
50
|
{
|
|
47
51
|
"name": "VJoyBadge",
|
|
52
|
+
"description": "A versatile badge component for labeling, categorizing, and highlighting content with colored indicators. Supports various color variants for different semantic meanings, optional bulletpoint dots for visual emphasis, and can display either text labels or numeric values. Perfect for status indicators, tags, and notification counters.",
|
|
48
53
|
"path": "VJoyBadge/metadata.json",
|
|
49
54
|
"propsCount": 3,
|
|
50
55
|
"eventsCount": 0,
|
|
@@ -53,6 +58,7 @@
|
|
|
53
58
|
},
|
|
54
59
|
{
|
|
55
60
|
"name": "VJoyBadgeLevel",
|
|
61
|
+
"description": "A specialized badge component for displaying user achievement levels and status indicators. Features custom SVG icons for different categories including SuperMalter levels (with crown icons), High Potential badges (with diamond icons), verified status, and special designations like Malt Linker. Can display icons only or with accompanying text labels for different user recognition levels.",
|
|
56
62
|
"path": "VJoyBadgeLevel/metadata.json",
|
|
57
63
|
"propsCount": 3,
|
|
58
64
|
"eventsCount": 0,
|
|
@@ -61,6 +67,7 @@
|
|
|
61
67
|
},
|
|
62
68
|
{
|
|
63
69
|
"name": "VJoyBlockSkeleton",
|
|
70
|
+
"description": "A highly configurable skeleton loading component for creating placeholder blocks during content loading. Features customizable dimensions, circle variant for avatars, and smooth shimmer animations to improve perceived performance. More flexible than VJoyFormFieldSkeleton and integrates seamlessly with VJoyWrapper for responsive layouts.",
|
|
64
71
|
"path": "VJoyBlockSkeleton/metadata.json",
|
|
65
72
|
"propsCount": 3,
|
|
66
73
|
"eventsCount": 0,
|
|
@@ -69,6 +76,7 @@
|
|
|
69
76
|
},
|
|
70
77
|
{
|
|
71
78
|
"name": "VJoyBottomSheet",
|
|
79
|
+
"description": "",
|
|
72
80
|
"path": "VJoyBottomSheet/metadata.json",
|
|
73
81
|
"propsCount": 5,
|
|
74
82
|
"eventsCount": 1,
|
|
@@ -77,6 +85,7 @@
|
|
|
77
85
|
},
|
|
78
86
|
{
|
|
79
87
|
"name": "VJoyBottomSheetTrigger",
|
|
88
|
+
"description": "",
|
|
80
89
|
"path": "VJoyBottomSheetTrigger/metadata.json",
|
|
81
90
|
"propsCount": 1,
|
|
82
91
|
"eventsCount": 1,
|
|
@@ -85,6 +94,7 @@
|
|
|
85
94
|
},
|
|
86
95
|
{
|
|
87
96
|
"name": "VJoyButton",
|
|
97
|
+
"description": "A button component supporting multiple variants, sizes, and states. Features icon support, loading states and can function as either a button or link element. Includes ripple effects and comprehensive styling options for different use cases from primary actions to subtle ghost buttons. **Tips:** set a \"href\" attribute to make the button a link.",
|
|
88
98
|
"path": "VJoyButton/metadata.json",
|
|
89
99
|
"propsCount": 9,
|
|
90
100
|
"eventsCount": 0,
|
|
@@ -93,6 +103,7 @@
|
|
|
93
103
|
},
|
|
94
104
|
{
|
|
95
105
|
"name": "VJoyCheckbox",
|
|
106
|
+
"description": "A form checkbox component with support for standard, indeterminate, and disabled states. Features accessible labeling, focus indicators, form integration with validation feedback, and additional content slots. Supports both single selections scenarios with proper event handling and state management.",
|
|
96
107
|
"path": "VJoyCheckbox/metadata.json",
|
|
97
108
|
"propsCount": 10,
|
|
98
109
|
"eventsCount": 3,
|
|
@@ -101,6 +112,7 @@
|
|
|
101
112
|
},
|
|
102
113
|
{
|
|
103
114
|
"name": "VJoyCollapse",
|
|
115
|
+
"description": "A container component for creating accordion and collapsible content sections. Manages multiple VJoyCollapseItem components with support for accordion mode (single open item) or standard collapse behavior (multiple open items). Features v-model integration for programmatic control and various visual modes for different design requirements.",
|
|
104
116
|
"path": "VJoyCollapse/metadata.json",
|
|
105
117
|
"propsCount": 3,
|
|
106
118
|
"eventsCount": 1,
|
|
@@ -109,6 +121,7 @@
|
|
|
109
121
|
},
|
|
110
122
|
{
|
|
111
123
|
"name": "VJoyCollapseItem",
|
|
124
|
+
"description": "An individual collapsible content item that can expand and collapse to show/hide content. Features header and subheader support, optional summary icons, preview content when collapsed, and custom header actions. Can be used within VJoyCollapse for grouped accordion behavior.",
|
|
112
125
|
"path": "VJoyCollapseItem/metadata.json",
|
|
113
126
|
"propsCount": 6,
|
|
114
127
|
"eventsCount": 2,
|
|
@@ -117,6 +130,7 @@
|
|
|
117
130
|
},
|
|
118
131
|
{
|
|
119
132
|
"name": "VJoyCompanyAvatar",
|
|
133
|
+
"description": "DEPRECATED. Use VJoyAvatar component instead.",
|
|
120
134
|
"path": "VJoyCompanyAvatar/metadata.json",
|
|
121
135
|
"propsCount": 5,
|
|
122
136
|
"eventsCount": 0,
|
|
@@ -125,6 +139,7 @@
|
|
|
125
139
|
},
|
|
126
140
|
{
|
|
127
141
|
"name": "VJoyDialog",
|
|
142
|
+
"description": "VJoyDialog component exposes two methods: `show` and `hide`. **Both are asynchronous**. You can use the `VJoyDialogTrigger` component as well if it's easier. ```html <template> <VJoyDialog ref=\"dialog\">...</VJoyDialog> </template> <script lang=\"ts\" setup> import {ref} from 'vue'; import {VJoyDialog} from '@maltjoy/core-vue'; const dialog = ref<InstanceType<typeof VJoyDialog>>(); async function showDialog() { await dialog.value?.show(); } // execute the publicly exposed hide function. async function hideDialog() { // you can pass an object as parameter: {fireHideEvent: false} if you don't want to emit dialog:hide event. await dialog.value?.hide(); } </script> ``` > FYI, the \"teleport\" property is applied on these docs only for preview quality purpose. > By default, dialogs are rendered at the end of body tag.",
|
|
128
143
|
"path": "VJoyDialog/metadata.json",
|
|
129
144
|
"propsCount": 16,
|
|
130
145
|
"eventsCount": 6,
|
|
@@ -133,6 +148,7 @@
|
|
|
133
148
|
},
|
|
134
149
|
{
|
|
135
150
|
"name": "VJoyDialogTrigger",
|
|
151
|
+
"description": "",
|
|
136
152
|
"path": "VJoyDialogTrigger/metadata.json",
|
|
137
153
|
"propsCount": 1,
|
|
138
154
|
"eventsCount": 1,
|
|
@@ -141,6 +157,7 @@
|
|
|
141
157
|
},
|
|
142
158
|
{
|
|
143
159
|
"name": "VJoyDot",
|
|
160
|
+
"description": "A simple colored dot indicator component for status display and notifications. Can display as a plain colored dot or include numeric values for notification counters. Features automatic formatting for large numbers (99+) and supports multiple color variants for different semantic meanings and visual emphasis.",
|
|
144
161
|
"path": "VJoyDot/metadata.json",
|
|
145
162
|
"propsCount": 2,
|
|
146
163
|
"eventsCount": 0,
|
|
@@ -149,6 +166,7 @@
|
|
|
149
166
|
},
|
|
150
167
|
{
|
|
151
168
|
"name": "VJoyDrawer",
|
|
169
|
+
"description": "VJoyDrawer component exposes two methods: `show` and `hide`. **Both are asynchronous**. You can use the `VJoyDrawerTrigger` component as well if it's easier. ```html <template> <VJoyDrawer ref=\"dialog\">...</VJoyDrawer> </template> <script lang=\"ts\" setup> import {ref} from 'vue'; import {VJoyDrawer} from '@maltjoy/core-vue'; const drawer = ref<InstanceType<typeof VJoyDrawer> | null>(null); async function showDrawer() { await drawer.value?.show(); } // execute the publicly exposed hide function. async function hideDrawer() { // you can pass an object as parameter: {fireHideEvent: false} if you don't want to emit drawer:hide event. await drawer.value?.hide(); } </script> ``` If you need confirmation from the user or wait for an API call to close the drawer you can use the `on-before-hide` function property. This function can be either synchronous or asynchronous and should return a boolean. Returning `true` closes the drawer and returning `false` cancels the closing.",
|
|
152
170
|
"path": "VJoyDrawer/metadata.json",
|
|
153
171
|
"propsCount": 12,
|
|
154
172
|
"eventsCount": 6,
|
|
@@ -157,6 +175,7 @@
|
|
|
157
175
|
},
|
|
158
176
|
{
|
|
159
177
|
"name": "VJoyDrawerTrigger",
|
|
178
|
+
"description": "",
|
|
160
179
|
"path": "VJoyDrawerTrigger/metadata.json",
|
|
161
180
|
"propsCount": 1,
|
|
162
181
|
"eventsCount": 1,
|
|
@@ -165,6 +184,7 @@
|
|
|
165
184
|
},
|
|
166
185
|
{
|
|
167
186
|
"name": "VJoyDropdown",
|
|
187
|
+
"description": "A flexible dropdown component for creating contextual menus and option lists. Features customizable trigger buttons, positioning options (left/right/up/down), and support for both predefined option lists and completely custom content. Includes proper accessibility support and click-outside behavior for seamless user interaction. **ACCESSIBILITY FOCUS:** When using this component, to properly apply useful informations for screen readers, you will need to set an **aria-label** to your dropdown trigger if it has no default text.",
|
|
168
188
|
"path": "VJoyDropdown/metadata.json",
|
|
169
189
|
"propsCount": 13,
|
|
170
190
|
"eventsCount": 4,
|
|
@@ -173,6 +193,7 @@
|
|
|
173
193
|
},
|
|
174
194
|
{
|
|
175
195
|
"name": "VJoyDropdownList",
|
|
196
|
+
"description": "The core list component used within dropdown interfaces for displaying selectable options. Features customizable sizing, header/footer slots, keyboard navigation, and accessibility compliance. Supports both predefined option arrays and custom content through slots. Can be used standalone or as part of the VJoyDropdown component for complete dropdown functionality.",
|
|
176
197
|
"path": "VJoyDropdownList/metadata.json",
|
|
177
198
|
"propsCount": 9,
|
|
178
199
|
"eventsCount": 3,
|
|
@@ -181,6 +202,7 @@
|
|
|
181
202
|
},
|
|
182
203
|
{
|
|
183
204
|
"name": "VJoyDropzone",
|
|
205
|
+
"description": "A file upload component with drag-and-drop functionality for handling file selection and management. Supports single or multiple file uploads, file validation and customizable file displays. Features visual feedback for drag states, error handling, and flexible content slots for file information and actions. The dropzone required as `v-model` an array containing objects with at least the \"name\" property.",
|
|
184
206
|
"path": "VJoyDropzone/metadata.json",
|
|
185
207
|
"propsCount": 11,
|
|
186
208
|
"eventsCount": 0,
|
|
@@ -189,6 +211,7 @@
|
|
|
189
211
|
},
|
|
190
212
|
{
|
|
191
213
|
"name": "VJoyFilterBar",
|
|
214
|
+
"description": "A container component for creating grouped filter interfaces with connected filter buttons. Automatically applies appropriate border radius styling to create seamless filter groups that work perfectly with VJoyFilterBarButton components. Includes accessibility support and integrates well with dropdowns for complex filtering scenarios.",
|
|
192
215
|
"path": "VJoyFilterBar/metadata.json",
|
|
193
216
|
"propsCount": 1,
|
|
194
217
|
"eventsCount": 0,
|
|
@@ -197,6 +220,7 @@
|
|
|
197
220
|
},
|
|
198
221
|
{
|
|
199
222
|
"name": "VJoyFilterBarButton",
|
|
223
|
+
"description": "",
|
|
200
224
|
"path": "VJoyFilterBarButton/metadata.json",
|
|
201
225
|
"propsCount": 3,
|
|
202
226
|
"eventsCount": 1,
|
|
@@ -205,6 +229,7 @@
|
|
|
205
229
|
},
|
|
206
230
|
{
|
|
207
231
|
"name": "VJoyFormError",
|
|
232
|
+
"description": "A form error display component for showing error messages. Features a warning icon, support for single error messages or multiple error lists, and visibility control for conditional error display. Includes proper accessibility attributes with alert role for screen reader announcement of form errors.",
|
|
208
233
|
"path": "VJoyFormError/metadata.json",
|
|
209
234
|
"propsCount": 4,
|
|
210
235
|
"eventsCount": 0,
|
|
@@ -213,14 +238,25 @@
|
|
|
213
238
|
},
|
|
214
239
|
{
|
|
215
240
|
"name": "VJoyFormFieldSkeleton",
|
|
241
|
+
"description": "A specialized skeleton loading component designed specifically for form field placeholders. Features form-appropriate sizing, flexible layout support with VJoyWrapper integration, and consistent styling that matches form field dimensions. Perfect for creating skeleton forms and improving perceived loading performance in form-heavy interfaces. Skeleton is 100% width by default. If you want to have a better control on this, use the \"width\" property.",
|
|
216
242
|
"path": "VJoyFormFieldSkeleton/metadata.json",
|
|
217
243
|
"propsCount": 3,
|
|
218
244
|
"eventsCount": 0,
|
|
219
245
|
"slotsCount": 0,
|
|
220
246
|
"hasError": false
|
|
221
247
|
},
|
|
248
|
+
{
|
|
249
|
+
"name": "VJoyFormGroup",
|
|
250
|
+
"description": "A form group component to group form elements together. It is used to group a label, any form component, and form errors together. It is also used to handle the gap between the form elements, and **it resets the existing margins** within form elements!",
|
|
251
|
+
"path": "VJoyFormGroup/metadata.json",
|
|
252
|
+
"propsCount": 0,
|
|
253
|
+
"eventsCount": 0,
|
|
254
|
+
"slotsCount": 1,
|
|
255
|
+
"hasError": false
|
|
256
|
+
},
|
|
222
257
|
{
|
|
223
258
|
"name": "VJoyFunnel",
|
|
259
|
+
"description": "A full-page layout component designed for multi-step workflows and guided user flows. Features decorative background shapes, header and footer areas, and seamless integration with stepper components. Optimized for mobile experiences and onboarding funnels with different visual profiles and customizable content areas.",
|
|
224
260
|
"path": "VJoyFunnel/metadata.json",
|
|
225
261
|
"propsCount": 3,
|
|
226
262
|
"eventsCount": 0,
|
|
@@ -229,6 +265,7 @@
|
|
|
229
265
|
},
|
|
230
266
|
{
|
|
231
267
|
"name": "VJoyFunnelFooter",
|
|
268
|
+
"description": "",
|
|
232
269
|
"path": "VJoyFunnelFooter/metadata.json",
|
|
233
270
|
"propsCount": 0,
|
|
234
271
|
"eventsCount": 0,
|
|
@@ -237,6 +274,7 @@
|
|
|
237
274
|
},
|
|
238
275
|
{
|
|
239
276
|
"name": "VJoyFunnelHeader",
|
|
277
|
+
"description": "",
|
|
240
278
|
"path": "VJoyFunnelHeader/metadata.json",
|
|
241
279
|
"propsCount": 0,
|
|
242
280
|
"eventsCount": 0,
|
|
@@ -245,6 +283,7 @@
|
|
|
245
283
|
},
|
|
246
284
|
{
|
|
247
285
|
"name": "VJoyHighlight",
|
|
286
|
+
"description": "A content highlighting component for displaying important information with visual emphasis. Features different severity levels (success, info, warning, error, neutral), optional accent borders, customizable icons, and title support. Includes an experimental AI variant for AI-related content with special styling and decorative elements.",
|
|
248
287
|
"path": "VJoyHighlight/metadata.json",
|
|
249
288
|
"propsCount": 5,
|
|
250
289
|
"eventsCount": 0,
|
|
@@ -253,6 +292,7 @@
|
|
|
253
292
|
},
|
|
254
293
|
{
|
|
255
294
|
"name": "VJoyIcon",
|
|
295
|
+
"description": "An icon component supporting the complete Joy icon library with customizable sizing and theming. Features accessibility support with aria labels, multiple color variants and different size options. Provides consistent icon rendering across the design system with proper semantic markup and keyboard navigation capabilities.",
|
|
256
296
|
"path": "VJoyIcon/metadata.json",
|
|
257
297
|
"propsCount": 7,
|
|
258
298
|
"eventsCount": 0,
|
|
@@ -261,6 +301,7 @@
|
|
|
261
301
|
},
|
|
262
302
|
{
|
|
263
303
|
"name": "VJoyIndicator",
|
|
304
|
+
"description": "",
|
|
264
305
|
"path": "VJoyIndicator/metadata.json",
|
|
265
306
|
"propsCount": 4,
|
|
266
307
|
"eventsCount": 0,
|
|
@@ -269,6 +310,7 @@
|
|
|
269
310
|
},
|
|
270
311
|
{
|
|
271
312
|
"name": "VJoyIndicators",
|
|
313
|
+
"description": "A navigation component for creating page or content indicators, commonly used in carousels and dialogs. Manages a collection of VJoyIndicator components with selection state and v-model support. Features visual variants and automatic indicator management for seamless navigation experiences with proper accessibility and keyboard interaction support.",
|
|
272
314
|
"path": "VJoyIndicators/metadata.json",
|
|
273
315
|
"propsCount": 2,
|
|
274
316
|
"eventsCount": 1,
|
|
@@ -277,14 +319,34 @@
|
|
|
277
319
|
},
|
|
278
320
|
{
|
|
279
321
|
"name": "VJoyInput",
|
|
322
|
+
"description": "A comprehensive form input component with extensive customization and validation features. Supports multiple input types, icon support, clearable functionality, unit displays, and comprehensive validation states. Features auto-focus capabilities, accessibility compliance, and seamless integration with form validation systems.",
|
|
280
323
|
"path": "VJoyInput/metadata.json",
|
|
281
324
|
"propsCount": 19,
|
|
282
325
|
"eventsCount": 1,
|
|
326
|
+
"slotsCount": 2,
|
|
327
|
+
"hasError": false
|
|
328
|
+
},
|
|
329
|
+
{
|
|
330
|
+
"name": "VJoyInputDigit",
|
|
331
|
+
"description": "One-time code input with auto-navigation between slots. Supports numeric filtering with disabled/invalid states.",
|
|
332
|
+
"path": "VJoyInputDigit/metadata.json",
|
|
333
|
+
"propsCount": 6,
|
|
334
|
+
"eventsCount": 4,
|
|
335
|
+
"slotsCount": 0,
|
|
336
|
+
"hasError": false
|
|
337
|
+
},
|
|
338
|
+
{
|
|
339
|
+
"name": "VJoyInputPassword",
|
|
340
|
+
"description": "Password input built on top of VJoyInput with built-in visibility toggle.",
|
|
341
|
+
"path": "VJoyInputPassword/metadata.json",
|
|
342
|
+
"propsCount": 15,
|
|
343
|
+
"eventsCount": 1,
|
|
283
344
|
"slotsCount": 1,
|
|
284
345
|
"hasError": false
|
|
285
346
|
},
|
|
286
347
|
{
|
|
287
348
|
"name": "VJoyLabel",
|
|
349
|
+
"description": "A flexible form label component with enhanced functionality for complex form layouts. Features size variants, required/optional indicators, tooltip support, and legend text capabilities. Supports both label and legend tag rendering for different form contexts with integrated accessibility features and consistent styling across the design system. All native attributes are not declared as Vue component properties. But the actual label tag inherits from every attribute you pass.",
|
|
288
350
|
"path": "VJoyLabel/metadata.json",
|
|
289
351
|
"propsCount": 5,
|
|
290
352
|
"eventsCount": 0,
|
|
@@ -293,6 +355,7 @@
|
|
|
293
355
|
},
|
|
294
356
|
{
|
|
295
357
|
"name": "VJoyLink",
|
|
358
|
+
"description": "Simple link component that should adapt its style depending on the context. Could be a button if **href** prop is undefined (add a **type** prop if needed).",
|
|
296
359
|
"path": "VJoyLink/metadata.json",
|
|
297
360
|
"propsCount": 5,
|
|
298
361
|
"eventsCount": 0,
|
|
@@ -301,6 +364,7 @@
|
|
|
301
364
|
},
|
|
302
365
|
{
|
|
303
366
|
"name": "VJoyListItem",
|
|
367
|
+
"description": "A structured list item component for creating consistent, interactive list entries. Features left and right content areas, optional icon support, hover states, and click handling. Perfect for data lists, navigation items, and content cards where consistent spacing and interactive feedback are essential for user experience.",
|
|
304
368
|
"path": "VJoyListItem/metadata.json",
|
|
305
369
|
"propsCount": 1,
|
|
306
370
|
"eventsCount": 1,
|
|
@@ -309,6 +373,7 @@
|
|
|
309
373
|
},
|
|
310
374
|
{
|
|
311
375
|
"name": "VJoyMenu",
|
|
376
|
+
"description": "A navigation menu component for creating accessible menu lists with keyboard navigation support. Works with VJoyMenuItem components to build complex navigation structures with icons, status indicators, and various link types. Features proper ARIA attributes, selection states, and integration with routing systems for seamless navigation experiences. items property is deprecated. Please use VJoyMenuItem with default slot. Docs generation is broken for the VJoyMenuItem component. Here you have the props interface as workaround. ```ts interface IJoyMenuItem { label: string; icon?: TJoyIconsNames; current?: boolean; disabled?: boolean; status?: TJoyIconsNames; statusColor?: TJoyIconsColors; type?: Component | 'a' | 'button'; linkProps?: ComponentProps<T>; } ```",
|
|
312
377
|
"path": "VJoyMenu/metadata.json",
|
|
313
378
|
"propsCount": 3,
|
|
314
379
|
"eventsCount": 1,
|
|
@@ -317,6 +382,7 @@
|
|
|
317
382
|
},
|
|
318
383
|
{
|
|
319
384
|
"name": "VJoyMenuItem",
|
|
385
|
+
"description": "",
|
|
320
386
|
"path": "VJoyMenuItem/metadata.json",
|
|
321
387
|
"propsCount": 9,
|
|
322
388
|
"eventsCount": 0,
|
|
@@ -325,6 +391,7 @@
|
|
|
325
391
|
},
|
|
326
392
|
{
|
|
327
393
|
"name": "VJoyMultiCheckbox",
|
|
394
|
+
"description": "A multi-selection checkbox group component for handling arrays of selected values. Simplifies multi-selection scenarios by managing checkbox states and array manipulation automatically. Features integrated labeling, fieldset structure for accessibility, and customizable checkbox content through slots. Perfect for filtering interfaces and bulk selection operations.",
|
|
328
395
|
"path": "VJoyMultiCheckbox/metadata.json",
|
|
329
396
|
"propsCount": 8,
|
|
330
397
|
"eventsCount": 1,
|
|
@@ -333,6 +400,7 @@
|
|
|
333
400
|
},
|
|
334
401
|
{
|
|
335
402
|
"name": "VJoyPagination",
|
|
403
|
+
"description": "A complete pagination component for navigating through large datasets with proper accessibility support. Features automatic page number calculation, gap handling for large page counts, customizable navigation arrows, and router integration support through slots. Includes proper ARIA attributes and keyboard navigation for an accessible pagination experience across different content types.",
|
|
336
404
|
"path": "VJoyPagination/metadata.json",
|
|
337
405
|
"propsCount": 5,
|
|
338
406
|
"eventsCount": 1,
|
|
@@ -341,6 +409,7 @@
|
|
|
341
409
|
},
|
|
342
410
|
{
|
|
343
411
|
"name": "VJoyPanel",
|
|
412
|
+
"description": "A structured content container component providing consistent layout patterns for cards and sections. Features header with title/subtitle/actions, main body content, footer actions, and loading overlay support. Includes flexible sizing, padding options, AI variant styling, and seamless integration with VJoyPanelSection for complex nested layouts and modular content organization.",
|
|
344
413
|
"path": "VJoyPanel/metadata.json",
|
|
345
414
|
"propsCount": 7,
|
|
346
415
|
"eventsCount": 0,
|
|
@@ -349,14 +418,25 @@
|
|
|
349
418
|
},
|
|
350
419
|
{
|
|
351
420
|
"name": "VJoyPanelSection",
|
|
421
|
+
"description": "",
|
|
352
422
|
"path": "VJoyPanelSection/metadata.json",
|
|
353
423
|
"propsCount": 0,
|
|
354
424
|
"eventsCount": 0,
|
|
355
425
|
"slotsCount": 2,
|
|
356
426
|
"hasError": false
|
|
357
427
|
},
|
|
428
|
+
{
|
|
429
|
+
"name": "VJoyPasswordRequirement",
|
|
430
|
+
"description": "A component to display a password requirement status. This is meant to be displayed under a VJoyInput of type password.",
|
|
431
|
+
"path": "VJoyPasswordRequirement/metadata.json",
|
|
432
|
+
"propsCount": 2,
|
|
433
|
+
"eventsCount": 0,
|
|
434
|
+
"slotsCount": 0,
|
|
435
|
+
"hasError": false
|
|
436
|
+
},
|
|
358
437
|
{
|
|
359
438
|
"name": "VJoyProductTour",
|
|
439
|
+
"description": "An advanced guided tour component for creating interactive product demonstrations with element highlighting. Features intelligent positioning around target elements, multi-step tour progression, customizable banners and actions, and spotlight effects for drawing user attention. Includes SSR compatibility and proper z-index management through Teleport for seamless user onboarding and feature discovery experiences.",
|
|
360
440
|
"path": "VJoyProductTour/metadata.json",
|
|
361
441
|
"propsCount": 10,
|
|
362
442
|
"eventsCount": 1,
|
|
@@ -365,6 +445,7 @@
|
|
|
365
445
|
},
|
|
366
446
|
{
|
|
367
447
|
"name": "VJoyProductTourTrigger",
|
|
448
|
+
"description": "",
|
|
368
449
|
"path": "VJoyProductTourTrigger/metadata.json",
|
|
369
450
|
"propsCount": 1,
|
|
370
451
|
"eventsCount": 1,
|
|
@@ -373,6 +454,7 @@
|
|
|
373
454
|
},
|
|
374
455
|
{
|
|
375
456
|
"name": "VJoyProgressBar",
|
|
457
|
+
"description": "A visual progress indicator component for displaying completion status with percentage or step-based progress. Features multiple color variants for different semantic meanings (success, warning, error), optional label display, and dual mode support (percentage-based or step-based calculations). Perfect for indicating task completion, loading states, and multi-step process progress with clear visual feedback.",
|
|
376
458
|
"path": "VJoyProgressBar/metadata.json",
|
|
377
459
|
"propsCount": 5,
|
|
378
460
|
"eventsCount": 0,
|
|
@@ -381,6 +463,7 @@
|
|
|
381
463
|
},
|
|
382
464
|
{
|
|
383
465
|
"name": "VJoyRadio",
|
|
466
|
+
"description": "",
|
|
384
467
|
"path": "VJoyRadio/metadata.json",
|
|
385
468
|
"propsCount": 8,
|
|
386
469
|
"eventsCount": 1,
|
|
@@ -389,6 +472,7 @@
|
|
|
389
472
|
},
|
|
390
473
|
{
|
|
391
474
|
"name": "VJoyRadioGroup",
|
|
475
|
+
"description": "A container component for organizing radio button groups with proper fieldset structure and accessibility. Features horizontal and vertical layout options, legend support for group labeling, and seamless integration with VJoyRadio components. Provides proper ARIA attributes and form association for accessible single-choice selection interfaces with consistent spacing and visual organization. Use the same v-model for each `VJoyRadio` (modelValue). Create a ref for it.",
|
|
392
476
|
"path": "VJoyRadioGroup/metadata.json",
|
|
393
477
|
"propsCount": 4,
|
|
394
478
|
"eventsCount": 0,
|
|
@@ -397,6 +481,7 @@
|
|
|
397
481
|
},
|
|
398
482
|
{
|
|
399
483
|
"name": "VJoyRatingStars",
|
|
484
|
+
"description": "A visual rating display component using star icons to represent rating values from 0 to 5. Features support for fractional ratings with half-star display, multiple size variants, review count display, and customizable content slots. Includes proper accessibility attributes with configurable ARIA labels for screen reader compatibility. **Accessibility focus**: you can give an aria-label to the component to actually describe the rating. By default it is set to \"Rating: X out of 5\" but is obviously not translated.",
|
|
400
485
|
"path": "VJoyRatingStars/metadata.json",
|
|
401
486
|
"propsCount": 3,
|
|
402
487
|
"eventsCount": 0,
|
|
@@ -405,6 +490,7 @@
|
|
|
405
490
|
},
|
|
406
491
|
{
|
|
407
492
|
"name": "VJoyScreenLoader",
|
|
493
|
+
"description": "A full-screen loading overlay component for indicating page or section loading states. Features light and dark color modes, overlay positioning for absolute coverage, customizable spinner slots, and content areas for loading messages. Perfect for blocking user interactions during data loading with professional loading animations and flexible content presentation.",
|
|
408
494
|
"path": "VJoyScreenLoader/metadata.json",
|
|
409
495
|
"propsCount": 2,
|
|
410
496
|
"eventsCount": 0,
|
|
@@ -413,6 +499,7 @@
|
|
|
413
499
|
},
|
|
414
500
|
{
|
|
415
501
|
"name": "VJoySelect",
|
|
502
|
+
"description": "A styled select dropdown component with integrated labeling. Features multiple size variants, disabled and invalid states, and flexible option rendering. Supports both inline label props and external VJoyLabel component usage.",
|
|
416
503
|
"path": "VJoySelect/metadata.json",
|
|
417
504
|
"propsCount": 12,
|
|
418
505
|
"eventsCount": 1,
|
|
@@ -421,6 +508,7 @@
|
|
|
421
508
|
},
|
|
422
509
|
{
|
|
423
510
|
"name": "VJoySelectableItem",
|
|
511
|
+
"description": "",
|
|
424
512
|
"path": "VJoySelectableItem/metadata.json",
|
|
425
513
|
"propsCount": 11,
|
|
426
514
|
"eventsCount": 1,
|
|
@@ -429,6 +517,7 @@
|
|
|
429
517
|
},
|
|
430
518
|
{
|
|
431
519
|
"name": "VJoySelectableItemGroup",
|
|
520
|
+
"description": "Basic full implementation example : ```html <template> <VJoySelectableItemGroup :options=\"options\" v-model:value=\"selectableModel\" /> <template> <script setup lang=\"ts\"> import {ref} from 'vue'; import {TJoySelectableItemOption} from '@maltjoy/core-vue'; const options = ref<TJoySelectableItemOption[]>([ {value: 'first-selectable-value', label: 'Option 1'}, {value: 'second-selectable-value', label: 'Option 2'}, {value: 'third-selectable-value', label: 'Option 3', {attrs: {...}}}, ]); // Use any type you prefer here, depending on what the backend is sending to you const selectableModel = ref(['second-selectable-value']); </script> ``` > When passing the `options` property, you can include both `value` and `label` properties to each option. > But if it's simpler to use other key names, you can use `valueKey` and `labelKey` properties from `VJoySelectableItemGroup` to define the keys you prefer. > > You will have to deal with the typings by yourself, by creating a mix of interfaces or using satifies with type `TJoySelectableItemOption` depending on your cases. > > Example: `satisfies (TJoySelectableItemOption & Record<string, unknown>)[]`",
|
|
432
521
|
"path": "VJoySelectableItemGroup/metadata.json",
|
|
433
522
|
"propsCount": 14,
|
|
434
523
|
"eventsCount": 1,
|
|
@@ -437,6 +526,7 @@
|
|
|
437
526
|
},
|
|
438
527
|
{
|
|
439
528
|
"name": "VJoySeparator",
|
|
529
|
+
"description": "A visual content separator component with text labeling capabilities for organizing interface sections. Features customizable text content, multiple size options, and styled horizontal lines for improved visual hierarchy. Enhanced version of the HTML hr element with better styling control and integrated text display for clearer content separation and section identification.",
|
|
440
530
|
"path": "VJoySeparator/metadata.json",
|
|
441
531
|
"propsCount": 2,
|
|
442
532
|
"eventsCount": 0,
|
|
@@ -445,6 +535,7 @@
|
|
|
445
535
|
},
|
|
446
536
|
{
|
|
447
537
|
"name": "VJoySnackbar",
|
|
538
|
+
"description": "This component should not be directly used. To display it, please use the pushVJoySnackbar service : ```typescript import {pushVJoySnackbar} from '@maltjoy/core-vue'; function yourFunction() { pushVJoySnackbar({ props: { // at least message is mandatory message: 'Your message' } }); } ``` If you need to listen to events fired by the component, you can actually grab the event bus : ```typescript import {pushVJoySnackbar} from '@maltjoy/core-vue'; function yourFunction() { const {snackbarEventBus} = pushVJoySnackbar({ props: { // at least message is mandatory message: 'Your message' } }); snackbarEventBus.on('snackbar:hide', () => { // do what you want, and don't forget to unregister the listener on component destroy }); } ``` On the other hand, if you need to access the component instance, you can grab it as well ```typescript import {pushVJoySnackbar} from '@maltjoy/core-vue'; function yourFunction() { const {snackbarApp} = pushVJoySnackbar({ props: { // at least message is mandatory message: 'Your message' } }); } ```",
|
|
448
539
|
"path": "VJoySnackbar/metadata.json",
|
|
449
540
|
"propsCount": 9,
|
|
450
541
|
"eventsCount": 0,
|
|
@@ -453,6 +544,7 @@
|
|
|
453
544
|
},
|
|
454
545
|
{
|
|
455
546
|
"name": "VJoySpinner",
|
|
547
|
+
"description": "A simple animated loading spinner component for indicating processing or loading states. Features customizable color variants to match different contexts and design requirements. Lightweight and performant with CSS-based animations, perfect for buttons, forms, and content areas that need visual loading feedback.",
|
|
456
548
|
"path": "VJoySpinner/metadata.json",
|
|
457
549
|
"propsCount": 1,
|
|
458
550
|
"eventsCount": 0,
|
|
@@ -461,6 +553,7 @@
|
|
|
461
553
|
},
|
|
462
554
|
{
|
|
463
555
|
"name": "VJoyStep",
|
|
556
|
+
"description": "",
|
|
464
557
|
"path": "VJoyStep/metadata.json",
|
|
465
558
|
"propsCount": 6,
|
|
466
559
|
"eventsCount": 1,
|
|
@@ -469,6 +562,7 @@
|
|
|
469
562
|
},
|
|
470
563
|
{
|
|
471
564
|
"name": "VJoyStepper",
|
|
565
|
+
"description": "A progress stepper component for visualizing multi-step processes and user workflows. Manages a collection of VJoyStep components with support for main steps and sub-steps for granular progress tracking. Features automatic step state management (completed, current, upcoming), visual progress indicators, and flexible step sizing. Perfect for onboarding flows, form wizards, and guided processes. See **VJoyStep** stories for properties related to `VJoyStepper` children",
|
|
472
566
|
"path": "VJoyStepper/metadata.json",
|
|
473
567
|
"propsCount": 2,
|
|
474
568
|
"eventsCount": 0,
|
|
@@ -477,6 +571,7 @@
|
|
|
477
571
|
},
|
|
478
572
|
{
|
|
479
573
|
"name": "VJoyTab",
|
|
574
|
+
"description": "",
|
|
480
575
|
"path": "VJoyTab/metadata.json",
|
|
481
576
|
"propsCount": 4,
|
|
482
577
|
"eventsCount": 0,
|
|
@@ -485,6 +580,7 @@
|
|
|
485
580
|
},
|
|
486
581
|
{
|
|
487
582
|
"name": "VJoyTabs",
|
|
583
|
+
"description": "A tabbed navigation component for organizing content into switchable panels with proper accessibility support. Features scrollable tab headers for overflow management, notification badges, custom header content slots, and both local navigation and external link support. Includes automatic tab selection management and event handling for seamless content organization and user experience.",
|
|
488
584
|
"path": "VJoyTabs/metadata.json",
|
|
489
585
|
"propsCount": 1,
|
|
490
586
|
"eventsCount": 1,
|
|
@@ -493,6 +589,7 @@
|
|
|
493
589
|
},
|
|
494
590
|
{
|
|
495
591
|
"name": "VJoyTag",
|
|
592
|
+
"description": "A versatile tag component for labeling, categorizing, and interactive content organization. Features multiple variants and sizes, removable functionality, drag visual indicators, selectable states, link styling, and AI-specific variants. Supports click handlers, removal events, and flexible content through slots for complex tag implementations.",
|
|
496
593
|
"path": "VJoyTag/metadata.json",
|
|
497
594
|
"propsCount": 12,
|
|
498
595
|
"eventsCount": 3,
|
|
@@ -501,6 +598,7 @@
|
|
|
501
598
|
},
|
|
502
599
|
{
|
|
503
600
|
"name": "VJoyTagsInput",
|
|
601
|
+
"description": "A specialized form input component for managing collections of tags with dynamic add/remove functionality. Features email validation, duplication detection, multi-line responsive layout, and comprehensive error handling. Integrates seamlessly with VJoyTag components for consistent tag display and provides flexible labeling options for complex form scenarios with collections management. > **To render the component with default model, pass it an array of values.** > **Storybook code snippet is broken at the moment.**",
|
|
504
602
|
"path": "VJoyTagsInput/metadata.json",
|
|
505
603
|
"propsCount": 9,
|
|
506
604
|
"eventsCount": 2,
|
|
@@ -509,6 +607,7 @@
|
|
|
509
607
|
},
|
|
510
608
|
{
|
|
511
609
|
"name": "VJoyTagsList",
|
|
610
|
+
"description": "**VJoyTagsList** is a simple wrapper for **VJoyTag** allowing you to create a list with pre-defined style. If it is more flexible for you to directly use **VJoyTag** don't hesitate to get rid of this parent component! Instead you can wrap your **VJoyTag** list in a **VJoyWrapper** for instance",
|
|
512
611
|
"path": "VJoyTagsList/metadata.json",
|
|
513
612
|
"propsCount": 6,
|
|
514
613
|
"eventsCount": 2,
|
|
@@ -517,6 +616,7 @@
|
|
|
517
616
|
},
|
|
518
617
|
{
|
|
519
618
|
"name": "VJoyTemplate",
|
|
619
|
+
"description": "A comprehensive page layout template component providing structured slots for complete page organization. Features header area with title/subtitle/actions, main content with optional sidebar, back navigation support, loading overlay integration, and decorative background shapes. Perfect for creating consistent page layouts with flexible content positioning and professional presentation across the application.",
|
|
520
620
|
"path": "VJoyTemplate/metadata.json",
|
|
521
621
|
"propsCount": 5,
|
|
522
622
|
"eventsCount": 0,
|
|
@@ -525,6 +625,7 @@
|
|
|
525
625
|
},
|
|
526
626
|
{
|
|
527
627
|
"name": "VJoyTemplateShape",
|
|
628
|
+
"description": "",
|
|
528
629
|
"path": "VJoyTemplateShape/metadata.json",
|
|
529
630
|
"propsCount": 0,
|
|
530
631
|
"eventsCount": 0,
|
|
@@ -533,6 +634,7 @@
|
|
|
533
634
|
},
|
|
534
635
|
{
|
|
535
636
|
"name": "VJoyText",
|
|
637
|
+
"description": "This component is directly dependant from `@maltjoy/css` package, a CSS class utils package built on top of `@maltjoy/themes` that contains our design tokens. **Reminder**: values ending with 50 have same size but are bold. See \"Fonts\" section here https://doc.malt.tech/joy-storybook/?path=/docs/css-framework--docs#advanced-fonts **Warning** If you use long text within a VJoyWrapper, you'll have to set a max-width to prevent the text from breaking the layout.",
|
|
536
638
|
"path": "VJoyText/metadata.json",
|
|
537
639
|
"propsCount": 2,
|
|
538
640
|
"eventsCount": 0,
|
|
@@ -541,6 +643,7 @@
|
|
|
541
643
|
},
|
|
542
644
|
{
|
|
543
645
|
"name": "VJoyTextarea",
|
|
646
|
+
"description": "A comprehensive multi-line text input component with advanced features for form interfaces. Features autogrow functionality, character count validation, min/max length constraints, integrated labeling, and form validation support. Includes visual feedback for length limits, disabled states, and seamless integration with VJoyLabel for flexible form layouts.",
|
|
544
647
|
"path": "VJoyTextarea/metadata.json",
|
|
545
648
|
"propsCount": 16,
|
|
546
649
|
"eventsCount": 1,
|
|
@@ -549,6 +652,7 @@
|
|
|
549
652
|
},
|
|
550
653
|
{
|
|
551
654
|
"name": "VJoyTitleBrand",
|
|
655
|
+
"description": "A branded title component for creating visually striking headings with highlighted text segments. Features flexible HTML tag rendering (h1-h6, p) and automatic styling for span elements with rotated background highlights. Perfect for page headers, dialog titles, and marketing content where brand emphasis is important for visual hierarchy and user attention. This component can be used in `VJoyTemplate` or `VJoyDialog`.",
|
|
552
656
|
"path": "VJoyTitleBrand/metadata.json",
|
|
553
657
|
"propsCount": 1,
|
|
554
658
|
"eventsCount": 0,
|
|
@@ -557,6 +661,7 @@
|
|
|
557
661
|
},
|
|
558
662
|
{
|
|
559
663
|
"name": "VJoyToggle",
|
|
664
|
+
"description": "A form toggle switch component for binary on/off state management with visual feedback. Features multiple variants including default (with smile icon) and admin (with eye icon), integrated labeling, disabled states, and proper accessibility attributes. Provides smooth animations and clear visual indicators for user interactions in forms and settings interfaces.",
|
|
560
665
|
"path": "VJoyToggle/metadata.json",
|
|
561
666
|
"propsCount": 10,
|
|
562
667
|
"eventsCount": 1,
|
|
@@ -565,6 +670,7 @@
|
|
|
565
670
|
},
|
|
566
671
|
{
|
|
567
672
|
"name": "VJoyTooltip",
|
|
673
|
+
"description": "A floating tooltip overlay component for providing contextual information and help text. Features intelligent positioning with automatic placement adjustments, support for both hover and click triggers, and flexible content through text props or HTML slots. Uses Teleport for proper z-index management and includes proper accessibility attributes with ARIA support for screen readers.",
|
|
568
674
|
"path": "VJoyTooltip/metadata.json",
|
|
569
675
|
"propsCount": 8,
|
|
570
676
|
"eventsCount": 0,
|
|
@@ -573,6 +679,7 @@
|
|
|
573
679
|
},
|
|
574
680
|
{
|
|
575
681
|
"name": "VJoyUserCard",
|
|
682
|
+
"description": "A comprehensive user profile card component for displaying user information in a structured layout. Features integrated avatar display, name/subtitle presentation, rating stars support, and optional link functionality for navigation. Includes multiple customization slots for avatar, title, subtitle, and rating components, with full attribute inheritance for link behavior and accessibility.",
|
|
576
683
|
"path": "VJoyUserCard/metadata.json",
|
|
577
684
|
"propsCount": 5,
|
|
578
685
|
"eventsCount": 0,
|
|
@@ -581,6 +688,7 @@
|
|
|
581
688
|
},
|
|
582
689
|
{
|
|
583
690
|
"name": "VJoyWalkthrough",
|
|
691
|
+
"description": "A comprehensive guided tour component for creating interactive onboarding experiences and feature walkthroughs. Features collapsible modal interface with trigger button, progress tracking with visual indicators, mobile-responsive design, and flexible content slots for illustrations, descriptions, and custom actions. Uses Teleport for proper z-index management and includes accessibility support for guided user experiences. > ⚠ The use of **disableTeleport** property is only for documentation purpose. You won't need it in production.",
|
|
584
692
|
"path": "VJoyWalkthrough/metadata.json",
|
|
585
693
|
"propsCount": 7,
|
|
586
694
|
"eventsCount": 3,
|
|
@@ -589,6 +697,7 @@
|
|
|
589
697
|
},
|
|
590
698
|
{
|
|
591
699
|
"name": "VJoyWalkthroughTrigger",
|
|
700
|
+
"description": "",
|
|
592
701
|
"path": "VJoyWalkthroughTrigger/metadata.json",
|
|
593
702
|
"propsCount": 4,
|
|
594
703
|
"eventsCount": 0,
|
|
@@ -597,6 +706,7 @@
|
|
|
597
706
|
},
|
|
598
707
|
{
|
|
599
708
|
"name": "VJoyWrapper",
|
|
709
|
+
"description": "A flexible CSS flexbox utility wrapper component for creating responsive layouts with consistent spacing. Features comprehensive flexbox controls including justify-content, align-items, flex-direction, and wrap properties. Includes automatic gap management, item stretching capabilities, and margin controls. Perfect for form layouts, button groups, and any content that needs structured, responsive arrangement with minimal CSS.",
|
|
600
710
|
"path": "VJoyWrapper/metadata.json",
|
|
601
711
|
"propsCount": 8,
|
|
602
712
|
"eventsCount": 0,
|