@stechquick/studio-cli 4.2.0-1 → 4.2.0-3

package/dist/studio-cli/kits/mobile-app-kit/.ai-kit/ui-kit/reference/component-index.json

@@ -0,0 +1,266 @@
+{
+  "$comment": "Quick component registry. The 'T' values listed here are the type names the runtime resolves; author against them. Editor display names / aliases may differ — prefer these runtime names.",
+  "version": 1,
+  "styleBlockNote": "Only the components in `componentsWithStyleBlocks` have a block in component-styles.json. If a component is NOT listed there, it has no Style-tab params — a grep returning nothing is the expected result, not a failed lookup. `componentsWithSC` additionally carry an `inheritedChildList`; those (and only those) get an `SC` object on the node.",
+  "componentsWithStyleBlocks": [
+    "Messaging",
+    "QDocumentViewer",
+    "QFrame",
+    "QLabel",
+    "QMap",
+    "QOtp",
+    "VAlert",
+    "VAppBar",
+    "VAutocomplete",
+    "VAvatar",
+    "VBottomNavigation",
+    "VBottomSheet",
+    "VBtn",
+    "VBtnToggle",
+    "VCard",
+    "VCarousel",
+    "VCheckbox",
+    "VChip",
+    "VChipGroup",
+    "VCol",
+    "VContainer",
+    "VDataTable",
+    "VDialog",
+    "VDivider",
+    "VExpansionPanel",
+    "VExpansionPanelContent",
+    "VExpansionPanelHeader",
+    "VExpansionPanels",
+    "VFileInput",
+    "VFooter",
+    "VIcon",
+    "VImg",
+    "VInlineDatepicker",
+    "VList",
+    "VListGroup",
+    "VListItem",
+    "VNavigationDrawer",
+    "VProgressCircular",
+    "VProgressLinear",
+    "VRadio",
+    "VRadioGroup",
+    "VRow",
+    "VSelect",
+    "VSheet",
+    "VSlideGroup",
+    "VSlider",
+    "VStepper",
+    "VStepperContent",
+    "VStepperHeader",
+    "VStepperItems",
+    "VStepperStep",
+    "VSwitch",
+    "VTab",
+    "VTabItem",
+    "VTabs",
+    "VTextField",
+    "VTextarea",
+    "VTimeline",
+    "VTimelineItem"
+  ],
+  "componentsWithSC": [
+    "VBottomNavigation",
+    "VBtn",
+    "VBtnToggle",
+    "VChip",
+    "VChipGroup",
+    "VExpansionPanels",
+    "VListItem",
+    "VNavigationDrawer",
+    "VRadioGroup",
+    "VSlideGroup",
+    "VStepper",
+    "VTabs"
+  ],
+  "families": {
+    "vuetify": "Vuetify 2 components (V-prefixed). Standard Vuetify props/events/slots apply unless wrapped.",
+    "quick": "Quick-native components (Q-prefixed or special names).",
+    "chart": "Chart.js-backed chart components. Only Bar, Line, Doughnut exist at runtime.",
+    "lifecycle": "Non-visual system components managing page lifecycle / embedding."
+  },
+  "lifecycle": [
+    "Messaging",
+    "CustomComponent"
+  ],
+  "chart": [],
+  "chartNotReal": [
+    "QPieChart"
+  ],
+  "chartNotRealNote": "Pie is NOT a runtime chart type. The chart library registers only { Doughnut, Bar, Line }. Render a pie shape with T:'Doughnut' and cutoutPercentage:0. (QPieChart exists only as a mobile-only placeholder.)",
+  "vuetify": [
+    "VAppBar",
+    "VAlert",
+    "VAutocomplete",
+    "VAvatar",
+    "VBottomNavigation",
+    "VBottomSheet",
+    "VBtn",
+    "VBtnToggle",
+    "VCard",
+    "VCarousel",
+    "VCarouselItem",
+    "VCheckbox",
+    "VStepper",
+    "VStepperHeader",
+    "VStepperStep",
+    "VStepperItems",
+    "VStepperContent",
+    "VChip",
+    "VChipGroup",
+    "VDataTable",
+    "VDialog",
+    "VDivider",
+    "VExpansionPanel",
+    "VExpansionPanels",
+    "VExpansionPanelContent",
+    "VExpansionPanelHeader",
+    "VFileInput",
+    "VFooter",
+    "VIcon",
+    "VImg",
+    "VList",
+    "VListGroup",
+    "VListItemGroup",
+    "VListItem",
+    "VListItemContent",
+    "VNavigationDrawer",
+    "VParallax",
+    "VProgressCircular",
+    "VProgressLinear",
+    "VRadioGroup",
+    "VRadio",
+    "VRangeSlider",
+    "VRating",
+    "VSheet",
+    "VSelect",
+    "VSlider",
+    "VSwitch",
+    "VTabs",
+    "VTab",
+    "VTabsItems",
+    "VTabItem",
+    "VTabsSlider",
+    "VTextField",
+    "VTextarea",
+    "VTimeline",
+    "VTimelineItem",
+    "VSlideGroup",
+    "VSlideItem",
+    "VBadge"
+  ],
+  "quick": [
+    "QLabel",
+    "Ghost",
+    "VContainer",
+    "VCol",
+    "VRow",
+    "QDocumentViewer",
+    "VInlineDatepicker",
+    "QOtp",
+    "InfiniteScroll",
+    "QAppointmentCalendar",
+    "QFrame",
+    "QAnimation",
+    "QVideo",
+    "QMap",
+    "QTimer",
+    "QIdleTimer"
+  ],
+  "devexpress": [],
+  "devexpressNote": "DevExpress components are available only when the DevExpress library group is enabled for the project. DxDataGrid/DxTreeList are containers; the rest (DxColumn, DxEditing, DxPaging, ...) are configuration child components placed inside them.",
+  "placeholderOrSpecial": [
+    "CustomComponent",
+    "QPieChart",
+    "QQrReader"
+  ],
+  "propValidation": {
+    "$comment": "The PIM (component-contracts.json) lists the editor's curated props; a few valid props aren't in it (legacy/internal/raw-Vuetify), recorded here as also-valid when authoring. DevExpress config sub-components use a different prop universe. Seeded from real shipping files.",
+    "extraValidProps": [
+      "regular",
+      "customCompClass",
+      "value",
+      "nuxt",
+      "hover",
+      "raised",
+      "fluid",
+      "eager"
+    ],
+    "skipUnknownPropFamily": "devexpress"
+  },
+  "containmentRules": {
+    "$comment": "Editor-enforced parent/child nesting rules (acceptableParentComps / acceptableChildComps, plus restricted components). The editor refuses placements that violate these; the official docs state them too (e.g. layout.md: 'You cannot use VCol alone or within any other components. Always use VCol with VRow as its parent.').",
+    "mustHaveParent": [
+      "VCol"
+    ],
+    "acceptableParents": {
+      "VCol": [
+        "VRow"
+      ]
+    },
+    "acceptableChildren": {
+      "VRow": [
+        "VCol"
+      ],
+      "VFooter": [
+        "VContainer"
+      ]
+    },
+    "notes": [
+      "VCol must be a child of VRow and cannot sit at the page root.",
+      "VRow accepts only VCol children.",
+      "VFooter accepts only VContainer children.",
+      "Canonical page structure: VContainer > VRow > VCol > content. Other components have no hard parent/child restriction, but follow the grid for layout.",
+      "Some container components (VTabs/VStepper/VExpansionPanels/VCarousel) use fixed child generators in the editor; place their documented item components (VTab/VTabItem, VStepperStep/VStepperContent, VExpansionPanel, VCarouselItem) inside them. VTab and VTabItem are sibling pairs in VTabs (VTab1, VTabItem1, VTab2, VTabItem2, ...), never nested; panel content is VTabItem > VContainer > VRow > VCol > content.",
+      "NEW PAGES ONLY: a newly-created page must wrap all UI content in a single top-level VContainer (the content root); the only allowed non-VContainer top-level pJson siblings are the non-visual Messaging event hub and an optional service component. Do NOT retrofit a VContainer root onto an existing page unless the user explicitly asks (existing pages may legitimately root on VAppBar, VDataTable, etc.). See newPageContentRoot below and s-track.md rule S4."
+    ],
+    "newPageContentRoot": {
+      "component": "VContainer",
+      "allowedTopLevelSiblings": [
+        "Messaging",
+        "<optional service component>"
+      ],
+      "appliesTo": "new pages only",
+      "doNotRetrofitExisting": true,
+      "note": "For a newly-created page, wrap all UI/visual content in a single top-level VContainer. When editing an existing page, keep its current root and do not insert a VContainer unless the user explicitly asks."
+    }
+  },
+  "criticals": {
+    "QLabel": {
+      "text": {
+        "pType": "prop",
+        "note": "Icon/label text is the `text` PROP. T must be 'prop'. HL defaults to 'QS'. Never PType 'text'."
+      }
+    },
+    "VIcon": {
+      "text": {
+        "pType": "text",
+        "note": "Icon NAME (e.g. 'mdi-home') goes in `text` with PType 'text' (NOT 'prop'). PType 'text' renders as the component's slot content, which Vuetify reads as the icon."
+      }
+    },
+    "VBtn": {
+      "label": "No text prop. Put a child QLabel / VIcon / VImg in the default slot.",
+      "color": "Static string only for per-row variation contexts; conditional QScript (if/else) is allowed in general props (see scripting reference)."
+    },
+    "VDataTable": {
+      "headers": "Prop, default QScript. Object literals use '=' keys: [{text='Name', value='name', sortable=true}].",
+      "items": "Static rows as a prop (QScript '=' literals); dynamic rows assigned in a callback.",
+      "scopedSlots": "Custom cells via C key 'item.<columnValue>' with cType 'scopedSlot'."
+    },
+    "VDialog": {
+      "open": "Set components.<id>.qValue = true/false (preferred; .value also works). The qValue prop is normalized to Vuetify's value.",
+      "render": "Add Render:true and eager:true to access inner components before opening."
+    },
+    "chart": {
+      "labels": "Array of axis/segment labels.",
+      "data": "Number array.",
+      "label": "Singular dataset name (string).",
+      "visible": "Charts have no visible prop; wrap in a VCol and toggle the VCol.",
+      "runtimeUpdate": "Mutate components.<id>.data then call (<any>components.<id>).update()."
+    }
+  }
+}