jsswift 1.0.43 → 1.0.44

package/dist/documentions/components/grid-col.md

@@ -0,0 +1,559 @@
+# GridCol
+
+Exact JSswift UI metadata contract. Use only the props, slots, events, and methods documented below.
+
+```json
+{
+  "signature": "_.GridCol(...children) | _.GridCol(props, ...children)",
+  "props": {
+    "size": {
+      "type": "string|number",
+      "description": "Size token, number, or CSS length for sizing.",
+      "default": null,
+      "values": [
+        "number",
+        "CSS units",
+        "xxs",
+        "xs",
+        "sm",
+        "md",
+        "lg",
+        "xl",
+        "xxl",
+        "xxxl"
+      ],
+      "category": "style"
+    },
+    "color": {
+      "type": "string",
+      "description": "Semantic color name used to style the component.",
+      "default": null,
+      "values": [
+        "primary",
+        "secondary",
+        "success",
+        "warning",
+        "danger",
+        "info",
+        "light",
+        "dark"
+      ],
+      "category": "style"
+    },
+    "outline": {
+      "type": "boolean",
+      "description": "Uses outlined visual style.",
+      "default": false,
+      "values": [
+        "number",
+        "CSS units",
+        "xxs",
+        "xs",
+        "sm",
+        "md",
+        "lg",
+        "xl",
+        "xxl",
+        "xxxl"
+      ],
+      "category": "style"
+    },
+    "clickable": {
+      "type": "boolean",
+      "description": "Enables pointer/hover styles and click handling on the component.",
+      "default": false,
+      "values": null,
+      "category": "behavior"
+    },
+    "padding": {
+      "type": "string|number",
+      "description": "Padding applied to the component root element.",
+      "default": null,
+      "values": [
+        "number",
+        "CSS units",
+        "xxs",
+        "xs",
+        "sm",
+        "md",
+        "lg",
+        "xl",
+        "xxl",
+        "xxxl"
+      ],
+      "category": "layout"
+    },
+    "margin": {
+      "type": "string|number",
+      "description": "Margin applied to the component root element.",
+      "default": null,
+      "values": [
+        "number",
+        "CSS units",
+        "xxs",
+        "xs",
+        "sm",
+        "md",
+        "lg",
+        "xl",
+        "xxl",
+        "xxxl"
+      ],
+      "category": "layout"
+    },
+    "width": {
+      "type": "string|number",
+      "description": "Explicit width (number interpreted as px or CSS length).",
+      "default": null,
+      "values": [
+        "number",
+        "CSS units",
+        "xxs",
+        "xs",
+        "sm",
+        "md",
+        "lg",
+        "xl",
+        "xxl",
+        "xxxl"
+      ],
+      "category": "layout"
+    },
+    "minWidth": {
+      "type": "string|number",
+      "description": "Minimum width constraint (number interpreted as px or CSS length).",
+      "default": null,
+      "values": [
+        "number",
+        "CSS units",
+        "xxs",
+        "xs",
+        "sm",
+        "md",
+        "lg",
+        "xl",
+        "xxl",
+        "xxxl"
+      ],
+      "category": "layout"
+    },
+    "maxWidth": {
+      "type": "string|number",
+      "description": "Maximum width constraint (number interpreted as px or CSS length).",
+      "default": null,
+      "values": [
+        "number",
+        "CSS units",
+        "xxs",
+        "xs",
+        "sm",
+        "md",
+        "lg",
+        "xl",
+        "xxl",
+        "xxxl"
+      ],
+      "category": "layout"
+    },
+    "height": {
+      "type": "string|number",
+      "description": "Explicit height (number interpreted as px or CSS length).",
+      "default": null,
+      "values": [
+        "number",
+        "CSS units",
+        "xxs",
+        "xs",
+        "sm",
+        "md",
+        "lg",
+        "xl",
+        "xxl",
+        "xxxl"
+      ],
+      "category": "layout"
+    },
+    "minHeight": {
+      "type": "string|number",
+      "description": "Minimum height constraint (number interpreted as px or CSS length).",
+      "default": null,
+      "values": [
+        "number",
+        "CSS units",
+        "xxs",
+        "xs",
+        "sm",
+        "md",
+        "lg",
+        "xl",
+        "xxl",
+        "xxxl"
+      ],
+      "category": "layout"
+    },
+    "maxHeight": {
+      "type": "string|number",
+      "description": "Maximum height constraint (number interpreted as px or CSS length).",
+      "default": null,
+      "values": [
+        "number",
+        "CSS units",
+        "xxs",
+        "xs",
+        "sm",
+        "md",
+        "lg",
+        "xl",
+        "xxl",
+        "xxxl"
+      ],
+      "category": "layout"
+    },
+    "radius": {
+      "type": "number|string",
+      "description": "Border radius token or CSS length applied to the component.",
+      "default": null,
+      "values": [
+        "number",
+        "CSS units",
+        "xxs",
+        "xs",
+        "sm",
+        "md",
+        "lg",
+        "xl",
+        "xxl",
+        "xxxl"
+      ],
+      "category": "style"
+    },
+    "borderRadius": {
+      "type": "string|number",
+      "description": "Border radius token or CSS length applied to the component.",
+      "default": null,
+      "values": [
+        "number",
+        "CSS units",
+        "xxs",
+        "xs",
+        "sm",
+        "md",
+        "lg",
+        "xl",
+        "xxl",
+        "xxxl"
+      ],
+      "category": "style"
+    },
+    "shadow": {
+      "type": "boolean|string",
+      "description": "Shadow token or CSS box-shadow string applied to the component.",
+      "default": null,
+      "values": [
+        "none",
+        "xxs",
+        "xs",
+        "sm",
+        "md",
+        "lg",
+        "xl",
+        "xxl",
+        "xxxl"
+      ],
+      "category": "style"
+    },
+    "mobile": {
+      "type": "{ span?, col?, gap?, direction?, contentAlign?, contentJustify? }",
+      "description": "Responsive overrides applied at the base/mobile viewport.",
+      "default": null,
+      "values": null,
+      "category": "layout"
+    },
+    "tablet": {
+      "type": "{ span?, col?, gap?, direction?, contentAlign?, contentJustify? }",
+      "description": "Responsive overrides applied from the tablet breakpoint upward.",
+      "default": null,
+      "values": null,
+      "category": "layout"
+    },
+    "pc": {
+      "type": "{ span?, col?, gap?, direction?, contentAlign?, contentJustify? }",
+      "description": "Responsive overrides applied from the desktop breakpoint upward.",
+      "default": null,
+      "values": null,
+      "category": "layout"
+    },
+    "class": {
+      "type": "string",
+      "description": "Additional CSS classes applied to the component root element.",
+      "default": null,
+      "values": null,
+      "category": "style"
+    },
+    "style": {
+      "type": "object",
+      "description": "Inline styles applied to the component root element.",
+      "default": null,
+      "values": null,
+      "category": "style"
+    },
+    "span": {
+      "type": "number|string",
+      "description": "Column span within a grid.",
+      "default": null,
+      "values": null,
+      "category": "general"
+    },
+    "col": {
+      "type": "alias di span",
+      "description": "Component configuration for \"col\". When not handled internally, it is forwarded to the root element.",
+      "default": null,
+      "values": null,
+      "category": "general"
+    },
+    "sm": {
+      "type": "number|string",
+      "description": "Column span at small breakpoint.",
+      "default": null,
+      "values": null,
+      "category": "general"
+    },
+    "md": {
+      "type": "number|string",
+      "description": "Column span at medium breakpoint.",
+      "default": null,
+      "values": null,
+      "category": "general"
+    },
+    "lg": {
+      "type": "number|string",
+      "description": "Column span at large breakpoint.",
+      "default": null,
+      "values": null,
+      "category": "general"
+    },
+    "auto": {
+      "type": "boolean",
+      "description": "Enables automatic sizing or layout behavior instead of fixed sizing.",
+      "default": null,
+      "values": null,
+      "category": "general"
+    },
+    "row": {
+      "type": "number|string",
+      "description": "Component configuration for \"row\". When not handled internally, it is forwarded to the root element.",
+      "default": null,
+      "values": null,
+      "category": "general"
+    },
+    "rowSpan": {
+      "type": "number|string",
+      "description": "Component configuration for \"rowSpan\". When not handled internally, it is forwarded to the root element.",
+      "default": null,
+      "values": null,
+      "category": "general"
+    },
+    "area": {
+      "type": "string",
+      "description": "Component configuration for \"area\". When not handled internally, it is forwarded to the root element.",
+      "default": null,
+      "values": null,
+      "category": "general"
+    },
+    "align": {
+      "type": "string (align-self)",
+      "description": "Alignment of content along the cross axis (e.g. left/center/right).",
+      "default": null,
+      "values": [
+        "left",
+        "center",
+        "right"
+      ],
+      "category": "general"
+    },
+    "justify": {
+      "type": "string (justify-self)",
+      "description": "Justification of items along the main axis.",
+      "default": null,
+      "values": [
+        "start",
+        "center",
+        "end",
+        "space-between",
+        "space-around",
+        "space-evenly"
+      ],
+      "category": "general"
+    },
+    "place": {
+      "type": "string (place-self)",
+      "description": "Component configuration for \"place\". When not handled internally, it is forwarded to the root element.",
+      "default": null,
+      "values": null,
+      "category": "general"
+    },
+    "gap": {
+      "type": "string|number",
+      "description": "Gap/spacing between child elements.",
+      "default": null,
+      "values": null,
+      "category": "general"
+    },
+    "rowGap": {
+      "type": "string|number",
+      "description": "Component configuration for \"rowGap\". When not handled internally, it is forwarded to the root element.",
+      "default": null,
+      "values": null,
+      "category": "general"
+    },
+    "columnGap": {
+      "type": "string|number",
+      "description": "Component configuration for \"columnGap\". When not handled internally, it is forwarded to the root element.",
+      "default": null,
+      "values": null,
+      "category": "general"
+    },
+    "fullHeight": {
+      "type": "boolean",
+      "description": "Component configuration for \"fullHeight\". When not handled internally, it is forwarded to the root element.",
+      "default": null,
+      "values": null,
+      "category": "general"
+    },
+    "stack": {
+      "type": "boolean",
+      "description": "Component configuration for \"stack\". When not handled internally, it is forwarded to the root element.",
+      "default": null,
+      "values": null,
+      "category": "general"
+    },
+    "inline": {
+      "type": "boolean",
+      "description": "Component configuration for \"inline\". When not handled internally, it is forwarded to the root element.",
+      "default": null,
+      "values": null,
+      "category": "general"
+    },
+    "direction": {
+      "type": "column|row|string",
+      "description": "Component configuration for \"direction\". When not handled internally, it is forwarded to the root element.",
+      "default": null,
+      "values": null,
+      "category": "general"
+    },
+    "contentAlign": {
+      "type": "string",
+      "description": "Component configuration for \"contentAlign\". When not handled internally, it is forwarded to the root element.",
+      "default": null,
+      "values": null,
+      "category": "general"
+    },
+    "contentJustify": {
+      "type": "string",
+      "description": "Component configuration for \"contentJustify\". When not handled internally, it is forwarded to the root element.",
+      "default": null,
+      "values": null,
+      "category": "general"
+    },
+    "center": {
+      "type": "boolean",
+      "description": "Component configuration for \"center\". When not handled internally, it is forwarded to the root element.",
+      "default": null,
+      "values": null,
+      "category": "general"
+    },
+    "scroll": {
+      "type": "boolean|string",
+      "description": "Component configuration for \"scroll\". When not handled internally, it is forwarded to the root element.",
+      "default": null,
+      "values": null,
+      "category": "general"
+    },
+    "panel": {
+      "type": "boolean",
+      "description": "Component configuration for \"panel\". When not handled internally, it is forwarded to the root element.",
+      "default": null,
+      "values": null,
+      "category": "general"
+    },
+    "to": {
+      "type": "string",
+      "description": "Navigation target/route to open on click.",
+      "default": null,
+      "values": null,
+      "category": "general"
+    },
+    "start": {
+      "type": "Node|Function|Array",
+      "description": "Component configuration for \"start\". When not handled internally, it is forwarded to the root element.",
+      "default": null,
+      "values": null,
+      "category": "general"
+    },
+    "body": {
+      "type": "Node|Function|Array",
+      "description": "Component configuration for \"body\". When not handled internally, it is forwarded to the root element.",
+      "default": null,
+      "values": null,
+      "category": "general"
+    },
+    "end": {
+      "type": "Node|Function|Array",
+      "description": "Component configuration for \"end\". When not handled internally, it is forwarded to the root element.",
+      "default": null,
+      "values": null,
+      "category": "general"
+    },
+    "slots": {
+      "type": "{ start?, body?, end?, default? }",
+      "description": "Named slots map for render overrides.",
+      "default": null,
+      "values": null,
+      "category": "general"
+    },
+    "children": {
+      "type": "Node|Array|Function",
+      "description": "Default child content (nodes, arrays, or render function).",
+      "default": null,
+      "values": null,
+      "category": "general"
+    }
+  },
+  "slots": {
+    "start": {
+      "type": "Top/header region",
+      "description": "Slot content for \"start\". Accepts nodes, arrays, or render functions.",
+      "default": null,
+      "values": null,
+      "category": "slot"
+    },
+    "body": {
+      "type": "Main body region",
+      "description": "Slot content for \"body\". Accepts nodes, arrays, or render functions.",
+      "default": null,
+      "values": null,
+      "category": "slot"
+    },
+    "end": {
+      "type": "Bottom/footer region",
+      "description": "Slot content for \"end\". Accepts nodes, arrays, or render functions.",
+      "default": null,
+      "values": null,
+      "category": "slot"
+    },
+    "default": {
+      "type": "Fallback content",
+      "description": "Primary content for the component.",
+      "default": null,
+      "values": null,
+      "category": "slot"
+    }
+  },
+  "events": {
+    "onClick": "MouseEvent",
+    "onKeydown": "KeyboardEvent"
+  },
+  "returns": "HTMLDivElement",
+  "description": "CSS Grid item with responsive spans, optional internal stack layout, start/body/end regions, and lightweight visual variants."
+}
+```