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

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

@@ -0,0 +1,568 @@
+{
+  "name": "ButtonLink",
+  "description": "ButtonLink is a semantic link (`<a>`) styled to look like a button.\nUse it for navigation that should visually appear as a button.\n\nVariants: `primary`, `secondary`, `unstyled`\nColors: `primary`, `success`, `warning`, `error`, `info`, `question`, `neutral`, `radar`\n\n**When to use which component:**\n- `Button`: Semantic button that looks like a button (for actions)\n- `ButtonLink`: Semantic link that looks like a button (for navigation)\n- `Link`: Semantic link that looks like a link (for navigation)\n- `LinkButton`: Semantic button that looks like a link (for actions)",
+  "package": "@redsift/design-system",
+  "filePath": "packages/design-system/src/components/button-link/ButtonLink.tsx",
+  "props": [
+    {
+      "name": "as",
+      "description": "Prop to pass a custom react component instead of a simple HTML anchor (useful for Nextjs or React Router Link component).",
+      "type": [
+        "\"symbol\"",
+        "\"object\"",
+        "\"a\"",
+        "\"abbr\"",
+        "\"address\"",
+        "\"area\"",
+        "\"article\"",
+        "\"aside\"",
+        "\"audio\"",
+        "\"b\"",
+        "\"base\"",
+        "\"bdi\"",
+        "\"bdo\"",
+        "\"big\"",
+        "\"blockquote\"",
+        "\"body\"",
+        "\"br\"",
+        "\"button\"",
+        "\"canvas\"",
+        "\"caption\"",
+        "\"cite\"",
+        "\"code\"",
+        "\"col\"",
+        "\"colgroup\"",
+        "\"data\"",
+        "\"datalist\"",
+        "\"dd\"",
+        "\"del\"",
+        "\"details\"",
+        "\"dfn\"",
+        "\"dialog\"",
+        "\"div\"",
+        "\"dl\"",
+        "\"dt\"",
+        "\"em\"",
+        "\"embed\"",
+        "\"fieldset\"",
+        "\"figcaption\"",
+        "\"figure\"",
+        "\"footer\"",
+        "\"form\"",
+        "\"h1\"",
+        "\"h2\"",
+        "\"h3\"",
+        "\"h4\"",
+        "\"h5\"",
+        "\"h6\"",
+        "\"head\"",
+        "\"header\"",
+        "\"hgroup\"",
+        "\"hr\"",
+        "\"html\"",
+        "\"i\"",
+        "\"iframe\"",
+        "\"img\"",
+        "\"input\"",
+        "\"ins\"",
+        "\"kbd\"",
+        "\"keygen\"",
+        "\"label\"",
+        "\"legend\"",
+        "\"li\"",
+        "\"link\"",
+        "\"main\"",
+        "\"map\"",
+        "\"mark\"",
+        "\"menu\"",
+        "\"menuitem\"",
+        "\"meta\"",
+        "\"meter\"",
+        "\"nav\"",
+        "\"noindex\"",
+        "\"noscript\"",
+        "\"ol\"",
+        "\"optgroup\"",
+        "\"option\"",
+        "\"output\"",
+        "\"p\"",
+        "\"param\"",
+        "\"picture\"",
+        "\"pre\"",
+        "\"progress\"",
+        "\"q\"",
+        "\"rp\"",
+        "\"rt\"",
+        "\"ruby\"",
+        "\"s\"",
+        "\"samp\"",
+        "\"slot\"",
+        "\"script\"",
+        "\"section\"",
+        "\"select\"",
+        "\"small\"",
+        "\"source\"",
+        "\"span\"",
+        "\"strong\"",
+        "\"style\"",
+        "\"sub\"",
+        "\"summary\"",
+        "\"sup\"",
+        "\"table\"",
+        "\"template\"",
+        "\"tbody\"",
+        "\"td\"",
+        "\"textarea\"",
+        "\"tfoot\"",
+        "\"th\"",
+        "\"thead\"",
+        "\"time\"",
+        "\"title\"",
+        "\"tr\"",
+        "\"track\"",
+        "\"u\"",
+        "\"ul\"",
+        "\"var\"",
+        "\"video\"",
+        "\"wbr\"",
+        "\"webview\"",
+        "\"svg\"",
+        "\"animate\"",
+        "\"animateMotion\"",
+        "\"animateTransform\"",
+        "\"circle\"",
+        "\"clipPath\"",
+        "\"defs\"",
+        "\"desc\"",
+        "\"ellipse\"",
+        "\"feBlend\"",
+        "\"feColorMatrix\"",
+        "\"feComponentTransfer\"",
+        "\"feComposite\"",
+        "\"feConvolveMatrix\"",
+        "\"feDiffuseLighting\"",
+        "\"feDisplacementMap\"",
+        "\"feDistantLight\"",
+        "\"feDropShadow\"",
+        "\"feFlood\"",
+        "\"feFuncA\"",
+        "\"feFuncB\"",
+        "\"feFuncG\"",
+        "\"feFuncR\"",
+        "\"feGaussianBlur\"",
+        "\"feImage\"",
+        "\"feMerge\"",
+        "\"feMergeNode\"",
+        "\"feMorphology\"",
+        "\"feOffset\"",
+        "\"fePointLight\"",
+        "\"feSpecularLighting\"",
+        "\"feSpotLight\"",
+        "\"feTile\"",
+        "\"feTurbulence\"",
+        "\"filter\"",
+        "\"foreignObject\"",
+        "\"g\"",
+        "\"image\"",
+        "\"line\"",
+        "\"linearGradient\"",
+        "\"marker\"",
+        "\"mask\"",
+        "\"metadata\"",
+        "\"mpath\"",
+        "\"path\"",
+        "\"pattern\"",
+        "\"polygon\"",
+        "\"polyline\"",
+        "\"radialGradient\"",
+        "\"rect\"",
+        "\"stop\"",
+        "\"switch\"",
+        "\"text\"",
+        "\"textPath\"",
+        "\"tspan\"",
+        "\"use\"",
+        "\"view\"",
+        "\"center\"",
+        "\"search\"",
+        "ComponentClass<any, any>",
+        "FunctionComponent<any>"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "isDisabled",
+      "description": "Whether the component is disabled or not.",
+      "type": [
+        "false",
+        "true"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "leftIcon",
+      "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": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "leftIconProps",
+      "description": "Props to add to the left icon.",
+      "type": "Omit<IconProps, \"ref\" | \"icon\">",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "rightIcon",
+      "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": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "rightIconProps",
+      "description": "Props to add to the right icon.",
+      "type": "Omit<IconProps, \"ref\" | \"icon\">",
+      "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": "height",
+      "description": "The height of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/height\">MDN</a>.",
+      "type": [
+        "string",
+        "number"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "sizing"
+    },
+    {
+      "name": "maxHeight",
+      "description": "The maximum height of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/max-height\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "sizing"
+    },
+    {
+      "name": "maxWidth",
+      "description": "The maximum width of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/max-width\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "sizing"
+    },
+    {
+      "name": "minHeight",
+      "description": "The minimum height of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/min-height\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "sizing"
+    },
+    {
+      "name": "minWidth",
+      "description": "The minimum width of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/min-width\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "sizing"
+    },
+    {
+      "name": "width",
+      "description": "The width of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/width\">MDN</a>.",
+      "type": [
+        "string",
+        "number"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "sizing"
+    },
+    {
+      "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"
+    },
+    {
+      "name": "color",
+      "description": "Color variant.",
+      "type": "string",
+      "required": false,
+      "defaultValue": "'primary'",
+      "category": "props"
+    },
+    {
+      "name": "isActive",
+      "description": "Whether the component is active or not.",
+      "type": [
+        "false",
+        "true"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "isHovered",
+      "description": "Whether the component is hovered or not.",
+      "type": [
+        "false",
+        "true"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "variant",
+      "description": "Button variant.",
+      "type": [
+        "\"primary\"",
+        "\"secondary\"",
+        "\"unstyled\""
+      ],
+      "required": false,
+      "defaultValue": "'primary'",
+      "category": "props"
+    }
+  ],
+  "examples": [],
+  "tags": {}
+}