@redsift/ds-mcp-server 12.3.1-muiv6-alpha.2

package/data/docs/components/design-system/Icon.json

@@ -0,0 +1,325 @@
+{
+  "name": "Icon",
+  "description": "Icon displays SVG icons from the Material Design Icons library or custom paths.\nIcons are decorative by default and hidden from assistive technology.\n\nSizes: `xsmall` (16px), `small` (20px), `medium` (24px), `large` (30px),\n`xlarge` (40px), `xxlarge` (55px), or custom `{ width, height }`\n\nColors: notification palette (`success`, `error`, `warning`, `info`, `question`,\n`no-data`) or any CSS color value.",
+  "package": "@redsift/design-system",
+  "filePath": "packages/design-system/src/components/icon/Icon.tsx",
+  "props": [
+    {
+      "name": "aria-hidden",
+      "description": "Indicates whether the element is exposed to an accessibility API.",
+      "type": [
+        "false",
+        "true",
+        "\"false\"",
+        "\"true\""
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "aria-label",
+      "description": "A screen reader only label for the Icon.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "color",
+      "description": "Color variant. Either from color palette or hex or rgb strings.",
+      "type": [
+        "\"primary\"",
+        "\"secondary\"",
+        "\"error\"",
+        "\"success\"",
+        "\"warning\"",
+        "\"info\"",
+        "\"question\"",
+        "\"no-data\"",
+        "\"asm\"",
+        "\"brand-trust\"",
+        "\"certificates\"",
+        "\"ondmarc\"",
+        "\"pulse\"",
+        "\"radar\"",
+        "\"rojo-ds\"",
+        "\"vendor-secure\"",
+        "\"website\"",
+        "string & {}"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "badge",
+      "description": "Whether the icon has a badge attached to it.",
+      "type": "ReactElement<any, string | JSXElementConstructor<any>>",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "icon",
+      "description": "Can be a string or an array of strings containing `d` property of the `path` SVG element.<br />\nCan also be a ReactElement.",
+      "type": [
+        "string",
+        "string[]",
+        "ReactElement<any, string | JSXElementConstructor<any>>"
+      ],
+      "required": true,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "size",
+      "description": "Icon size.",
+      "type": [
+        "\"xsmall\"",
+        "\"small\"",
+        "\"medium\"",
+        "\"large\"",
+        "\"xlarge\"",
+        "\"xxlarge\"",
+        "IconDimensions"
+      ],
+      "required": false,
+      "defaultValue": "'medium'",
+      "category": "props"
+    },
+    {
+      "name": "svgProps",
+      "description": "Additional properties to forward to the SVG tag.",
+      "type": "SVGProps<SVGSVGElement>",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "theme",
+      "description": "Theme.",
+      "type": [
+        "\"light\"",
+        "\"dark\""
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "flex",
+      "description": "When used in a flex layout, specifies how the element will grow or shrink to fit the space available. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/flex\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "flexGrow",
+      "description": "When used in a flex layout, specifies how the element will grow to fit the space available. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/flex-grow\">MDN</a>.",
+      "type": "number",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "flexShrink",
+      "description": "When used in a flex layout, specifies how the element will shrink to fit the space available. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/flex-shrink\">MDN</a>.",
+      "type": "number",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "flexBasis",
+      "description": "When used in a flex layout, specifies the initial main size of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/flex_basis\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "alignSelf",
+      "description": "Overrides the alignItems property of a flex or grid container. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/align-self\">MDN</a>.",
+      "type": [
+        "\"center\"",
+        "\"auto\"",
+        "\"normal\"",
+        "\"start\"",
+        "\"end\"",
+        "\"flex-start\"",
+        "\"flex-end\"",
+        "\"self-start\"",
+        "\"self-end\"",
+        "\"baseline\"",
+        "\"stretch\""
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "justifySelf",
+      "description": "Specifies how the element is justified inside a flex or grid container. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/justify-self\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "order",
+      "description": "The layout order for the element within a flex or grid container. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/order\">MDN</a>.",
+      "type": "number",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "gridArea",
+      "description": "When used in a grid layout, specifies the named grid area that the element should be placed in within the grid. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/grid-area\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "gridColumn",
+      "description": "When used in a grid layout, specifies the column the element should be placed in within the grid. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "gridRow",
+      "description": "When used in a grid layout, specifies the row the element should be placed in within the grid. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "gridColumnStart",
+      "description": "When used in a grid layout, specifies the starting column to span within the grid. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column-start\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "gridColumnEnd",
+      "description": "When used in a grid layout, specifies the ending column to span within the grid. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column-end\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "gridRowStart",
+      "description": "When used in a grid layout, specifies the starting row to span within the grid. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row-start\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "gridRowEnd",
+      "description": "When used in a grid layout, specifies the ending row to span within the grid. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row-end\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "margin",
+      "description": "The margin for all four sides of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/margin\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "spacing"
+    },
+    {
+      "name": "marginBottom",
+      "description": "The margin for the bottom side of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/margin-bottom\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "spacing"
+    },
+    {
+      "name": "marginLeft",
+      "description": "The margin for the left side of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/margin-left\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "spacing"
+    },
+    {
+      "name": "marginRight",
+      "description": "The margin for the right side of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/margin-right\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "spacing"
+    },
+    {
+      "name": "marginTop",
+      "description": "The margin for the top side of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/margin-top\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "spacing"
+    },
+    {
+      "name": "position",
+      "description": "Specifies how the element is positioned. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/position\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "positioning"
+    },
+    {
+      "name": "top",
+      "description": "The top position for the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/top\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "positioning"
+    },
+    {
+      "name": "bottom",
+      "description": "The bottom position for the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/bottom\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "positioning"
+    },
+    {
+      "name": "left",
+      "description": "The left position for the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/left\">MDN</a>. Consider using start instead for RTL support.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "positioning"
+    },
+    {
+      "name": "right",
+      "description": "The right position for the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/right\">MDN</a>. Consider using start instead for RTL support.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "positioning"
+    },
+    {
+      "name": "zIndex",
+      "description": "The stacking order for the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/z-index\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "positioning"
+    }
+  ],
+  "examples": [],
+  "tags": {}
+}