jsswift 1.0.44 → 1.0.46

package/dist/documentions/components/icon.md

@@ -1,383 +1,30 @@
 # Icon
 
-Exact JSswift UI metadata contract. Use only the props, slots, events, and methods documented below.
+Exact JSswift UI contract. Shared definitions listed in `commonProps` are in [common props](../ui/common-props.md); all component-specific props, slots, events, and methods are below.
 
 ```json
 {
   "signature": "_.Icon(name) | _.Icon(props) | _.Icon(props, ...children)",
   "props": {
-    "size": {
-      "type": "number|string",
-      "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": "object",
-      "description": "Responsive overrides applied at the base/mobile viewport.",
-      "default": null,
-      "values": null,
-      "category": "layout"
-    },
-    "tablet": {
-      "type": "object",
-      "description": "Responsive overrides applied from the tablet breakpoint upward.",
-      "default": null,
-      "values": null,
-      "category": "layout"
-    },
-    "pc": {
-      "type": "object",
-      "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"
-    },
-    "name": {
-      "type": "string|Node|Function",
-      "description": "HTML name attribute for form submission.",
-      "default": null,
-      "values": null,
-      "category": "general"
-    },
-    "lightShadow": {
-      "type": "boolean",
-      "description": "Component configuration for \"lightShadow\". When not handled internally, it is forwarded to the root element.",
-      "default": null,
-      "values": null,
-      "category": "general"
-    },
-    "border": {
-      "type": "boolean",
-      "description": "Component configuration for \"border\". When not handled internally, it is forwarded to the root element.",
-      "default": null,
-      "values": null,
-      "category": "general"
-    },
-    "glossy": {
-      "type": "boolean",
-      "description": "Component configuration for \"glossy\". When not handled internally, it is forwarded to the root element.",
-      "default": null,
-      "values": null,
-      "category": "general"
-    },
-    "glow": {
-      "type": "boolean",
-      "description": "Component configuration for \"glow\". When not handled internally, it is forwarded to the root element.",
-      "default": null,
-      "values": null,
-      "category": "general"
-    },
-    "glass": {
-      "type": "boolean",
-      "description": "Component configuration for \"glass\". When not handled internally, it is forwarded to the root element.",
-      "default": null,
-      "values": null,
-      "category": "general"
-    },
-    "gradient": {
-      "type": "boolean|number",
-      "description": "Component configuration for \"gradient\". When not handled internally, it is forwarded to the root element.",
-      "default": null,
-      "values": null,
-      "category": "general"
-    },
-    "textGradient": {
-      "type": "boolean",
-      "description": "Component configuration for \"textGradient\". When not handled internally, it is forwarded to the root element.",
-      "default": null,
-      "values": null,
-      "category": "general"
-    },
-    "slots": {
-      "type": "{ 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"
-    }
+    "size": {"type": "number|string", "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"},
+    "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"},
+    "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"},
+    "name": {"type": "string|Node|Function", "description": "HTML name attribute for form submission.", "default": null, "values": null, "category": "general"},
+    "lightShadow": {"type": "boolean", "description": "Component configuration for \"lightShadow\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
+    "border": {"type": "boolean", "description": "Component configuration for \"border\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
+    "glossy": {"type": "boolean", "description": "Component configuration for \"glossy\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
+    "glow": {"type": "boolean", "description": "Component configuration for \"glow\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
+    "glass": {"type": "boolean", "description": "Component configuration for \"glass\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
+    "gradient": {"type": "boolean|number", "description": "Component configuration for \"gradient\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
+    "textGradient": {"type": "boolean", "description": "Component configuration for \"textGradient\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
+    "slots": {"type": "{ 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": {
-    "default": {
-      "type": "Custom icon content",
-      "description": "Primary content for the component.",
-      "default": null,
-      "values": null,
-      "category": "slot"
-    }
+    "default": {"type": "Custom icon content", "description": "Primary content for the component.", "default": null, "values": null, "category": "slot"}
   },
   "returns": "HTMLSpanElement",
-  "description": "Sprite- or text-based icon with configurable size/color."
+  "description": "Sprite- or text-based icon with configurable size/color.",
+  "commonProps": {"path": "ui/common-props.md", "keys": ["color", "outline", "clickable", "padding", "margin", "width", "minWidth", "maxWidth", "height", "minHeight", "maxHeight", "borderRadius", "mobile", "tablet", "pc", "class", "style"]}
 }
 ```