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

package/data/docs/components/charts/Legend.json

@@ -0,0 +1,510 @@
+{
+  "name": "Legend",
+  "description": "",
+  "package": "@redsift/charts",
+  "filePath": "packages/charts/src/components/Legend/Legend.tsx",
+  "props": [
+    {
+      "name": "children",
+      "description": "Children",
+      "type": [
+        "ReactElement<any, string | JSXElementConstructor<any>>",
+        "ReactElement<any, string | JSXElementConstructor<any>>[]",
+        "(data: (Statistic & { color: string; })[], total?: number | undefined) => ReactElement<any, string | JSXElementConstructor<any>>"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "data",
+      "description": "Data.",
+      "type": "(Statistic & { color: string; })[]",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "isLegendItemSelected",
+      "description": "Method to determine whether a legend is selected or not.",
+      "type": "(datum: LegendItemDatum) => void",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "labelDecorator",
+      "description": "Method to override the data labels.",
+      "type": "(datum: LegendItemDatum, props?: { index?: number | undefined; isSelected?: boolean | undefined; color?: string | undefined; } | undefined) => string | ReactElement<any, string | JSXElementConstructor<any>>",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "legendDecorator",
+      "description": "Method modifying what's displayed within the legend when the variant is \"custom\".",
+      "type": "(datum: LegendItemDatum, props?: { index?: number | undefined; isSelected?: boolean | undefined; color?: string | undefined; } | undefined) => string | ReactElement<any, string | JSXElementConstructor<any>>",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "onLegendItemClick",
+      "description": "Method to be called on a click on a legend item.",
+      "type": "(datum: LegendItemDatum, data: LegendItemDatum[]) => void",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "legendItemRole",
+      "description": "LegendItem role. Used to indicate that legend items are to be considered buttons or links. If an onClick is provided, the legend items will have the role `button` unless specifically set to `link` with this prop.",
+      "type": [
+        "\"button\"",
+        "\"img\"",
+        "\"link\"",
+        "\"option\""
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "variant",
+      "description": "Variant.",
+      "type": [
+        "\"label\"",
+        "\"value\"",
+        "\"none\"",
+        "\"percent\"",
+        "\"custom\""
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "display",
+      "description": "Sets whether an element is treated as a block or inline element and the layout used for its children, such as flow layout, grid or flex. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/display\">MDN</a>.",
+      "type": [
+        "\"inline\"",
+        "\"inherit\"",
+        "\"grid\"",
+        "\"block\"",
+        "\"inline-block\"",
+        "\"flex\"",
+        "\"inline-flex\"",
+        "\"inline-grid\""
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "alignContent",
+      "description": "The distribution of space around child items along the cross axis. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/align-content\">MDN</a>.",
+      "type": [
+        "\"center\"",
+        "\"end\"",
+        "\"flex-start\"",
+        "\"flex-end\"",
+        "\"space-between\"",
+        "\"space-around\"",
+        "\"space-evenly\"",
+        "\"stretch\"",
+        "\"start\"",
+        "\"baseline\"",
+        "\"first baseline\"",
+        "\"last baseline\""
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "alignItems",
+      "description": "The alignment of children within their container. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/align-items\">MDN</a>.",
+      "type": [
+        "\"center\"",
+        "\"end\"",
+        "\"flex-start\"",
+        "\"flex-end\"",
+        "\"stretch\"",
+        "\"start\"",
+        "\"baseline\"",
+        "\"first baseline\"",
+        "\"last baseline\"",
+        "\"self-start\"",
+        "\"self-end\""
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "flexDirection",
+      "description": "The direction in which to layout children. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/flex-direction\">MDN</a>.",
+      "type": [
+        "\"row\"",
+        "\"row-reverse\"",
+        "\"column\"",
+        "\"column-reverse\""
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "flexWrap",
+      "description": "Whether to wrap items onto multiple lines. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/flex-wrap\">MDN</a>.",
+      "type": [
+        "\"nowrap\"",
+        "\"wrap\"",
+        "\"wrap-reverse\""
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "gap",
+      "description": "The space to display between both rows and columns. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/gap\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "justifyContent",
+      "description": "The distribution of space around items along the main axis. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content\">MDN</a>.",
+      "type": [
+        "\"center\"",
+        "\"end\"",
+        "\"flex-start\"",
+        "\"flex-end\"",
+        "\"space-between\"",
+        "\"space-around\"",
+        "\"space-evenly\"",
+        "\"stretch\"",
+        "\"start\"",
+        "\"baseline\"",
+        "\"first baseline\"",
+        "\"last baseline\"",
+        "\"left\"",
+        "\"right\""
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "gridAutoColumns",
+      "description": "Defines the size of implicitly generated columns. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/grid-auto-columns\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "gridAutoRows",
+      "description": "Defines the size of implicitly generated rows. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/grid-auto-rows\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "gridTemplateAreas",
+      "description": "Defines named grid areas. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-areas\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "gridTemplateColumns",
+      "description": "Defines the sizes of each column in the grid. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-columns\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "gridTemplateRows",
+      "description": "Defines the sizes of each row in the grid. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-rows\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "justifyItems",
+      "description": "Defines the default justifySelf for all items in the grid. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/justify-items\">MDN</a>.",
+      "type": [
+        "\"center\"",
+        "\"end\"",
+        "\"stretch\"",
+        "\"start\""
+      ],
+      "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": "background",
+      "description": "The background shorthand CSS property sets all background style properties at once, such as color, image, origin and size, or repeat method. Component properties not set in the background shorthand property value declaration are set to their default values. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/background\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "backgroundColor",
+      "description": "The background-color CSS property sets the background color of an element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/background-color\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "border",
+      "description": "The border shorthand CSS property sets an element's border. It sets the values of border-width, border-style, and border-color. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/border\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "borderTop",
+      "description": "The border-top CSS property sets all the properties of an element's top border. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/border-top\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "borderBottom",
+      "description": "The border-top CSS property sets all the properties of an element's bottom border. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/border-bottom\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "borderLeft",
+      "description": "The border-top CSS property sets all the properties of an element's left border. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/border-left\">MDN</a>. Consider using start instead for RTL support.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "borderRight",
+      "description": "The border-top CSS property sets all the properties of an element's right border. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/border-right\">MDN</a>. Consider using start instead for RTL support.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "borderRadius",
+      "description": "The border-radius CSS property rounds the corners of an element's outer border edge. You can set a single radius to make circular corners, or two radii to make elliptical corners. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/border-radius\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "boxShadow",
+      "description": "The box-shadow CSS property adds shadow effects around an element's frame. You can set multiple effects separated by commas. A box shadow is described by X and Y offsets relative to the element, blur and spread radius, and color. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/box-shadow\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "padding",
+      "description": "The padding for all four sides of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/padding\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "spacing"
+    },
+    {
+      "name": "paddingBottom",
+      "description": "The padding for the bottom side of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/padding-bottom\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "spacing"
+    },
+    {
+      "name": "paddingLeft",
+      "description": "The padding for the left side of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/padding-left\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "spacing"
+    },
+    {
+      "name": "paddingRight",
+      "description": "The padding for the right side of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/padding-right\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "spacing"
+    },
+    {
+      "name": "paddingTop",
+      "description": "The padding for the top side of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/padding-top\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "spacing"
+    }
+  ],
+  "examples": [],
+  "tags": {}
+}

package/data/docs/components/charts/LegendItem.json

@@ -0,0 +1,128 @@
+{
+  "name": "LegendItem",
+  "description": "",
+  "package": "@redsift/charts",
+  "filePath": "packages/charts/src/components/LegendItem/LegendItem.tsx",
+  "props": [
+    {
+      "name": "legendDecorator",
+      "description": "Method modifying what's displayed within the legend when the variant is \"custom\".",
+      "type": "(datum: LegendItemDatum, props?: { index?: number | undefined; isSelected?: boolean | undefined; color?: string | undefined; } | undefined) => string | ReactElement<any, string | JSXElementConstructor<any>>",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "variant",
+      "description": "Variant.",
+      "type": [
+        "\"label\"",
+        "\"value\"",
+        "\"none\"",
+        "\"percent\"",
+        "\"custom\""
+      ],
+      "required": false,
+      "defaultValue": "'standard'",
+      "category": "props"
+    },
+    {
+      "name": "color",
+      "description": "Color of the DataPoint.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "data",
+      "description": "Data. Also state to which the component should end the animation, if any.",
+      "type": "LegendItemDatum",
+      "required": true,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "dataset",
+      "description": "Entire dataset in which the data point is a part of.",
+      "type": "any[]",
+      "required": true,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "id",
+      "description": "Id. Used for accessibility.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "index",
+      "description": "Position in the list of siblings. Used for placement and selection.",
+      "type": "number",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "isSelected",
+      "description": "Whether the component is selected or not. Used only if the component is selectable. Set to `undefined` to make nor selected nor unselected.",
+      "type": [
+        "false",
+        "true"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "labelDecorator",
+      "description": "Method modifying the label before displaying it.",
+      "type": "(data: LegendItemDatum, props?: { index?: number | undefined; isSelected?: boolean | undefined; color?: string | undefined; } | undefined) => string | ReactElement<any, string | JSXElementConstructor<any>>",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "onClick",
+      "description": "Method called when a click or keydown occurs on the component.",
+      "type": "(data: LegendItemDatum, dataset: any[]) => void",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "previousData",
+      "description": "State from which the component should start the animation, if any.",
+      "type": "LegendItemDatum",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "role",
+      "description": "Role. Will be set to 'button' if onClick is provided. If 'option', then the component becomes selectable.",
+      "type": [
+        "\"button\"",
+        "\"img\"",
+        "\"link\"",
+        "\"option\""
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "tooltipVariant",
+      "description": "Tooltip variant.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    }
+  ],
+  "examples": [],
+  "tags": {}
+}