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

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

@@ -0,0 +1,269 @@
+{
+  "name": "Axis",
+  "description": "",
+  "package": "@redsift/charts",
+  "filePath": "packages/charts/src/components/Axis/Axis.tsx",
+  "props": [
+    {
+      "name": "disableAnimations",
+      "description": "Disable animations.",
+      "type": [
+        "false",
+        "true"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "format",
+      "description": "",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "grid",
+      "description": "Whether to display grid or not. The length is mandatory and should usually be the length of the other axis.",
+      "type": [
+        "false",
+        "true",
+        "{ length?: number | undefined; stroke?: string | undefined; strokeWidth?: number | undefined; strokeDasharray?: string | undefined; opacity?: number | undefined; }"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "legend",
+      "description": "",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "legendOffset",
+      "description": "",
+      "type": "number",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "legendPosition",
+      "description": "",
+      "type": [
+        "\"end\"",
+        "\"start\"",
+        "\"middle\""
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "legendX",
+      "description": "",
+      "type": "number",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "legendY",
+      "description": "",
+      "type": "number",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "legendRotation",
+      "description": "",
+      "type": "number",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "legendStyle",
+      "description": "",
+      "type": "CSSProperties",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "length",
+      "description": "Length of the axis.",
+      "type": "number",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "position",
+      "description": "Position of axis. top|bottom means this is an x axis, right|left means this is an y axis.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "scale",
+      "description": "Scale (d3.js) used to generate the axis.",
+      "type": [
+        "ScaleLog",
+        "ScaleSymlog",
+        "ScaleTime<any>",
+        "ScaleLinear<any>",
+        "ScalePoint<any>",
+        "ScaleBand<any>"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "tickFormat",
+      "description": "",
+      "type": [
+        "(d: NumericValue) => string | string[]",
+        "(d: StringValue) => string | string[]",
+        "(d: Date) => string | string[]",
+        "(d: ScaleValue) => string | string[]"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "tickPadding",
+      "description": "",
+      "type": "number",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "tickRotation",
+      "description": "",
+      "type": "number",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "tickSize",
+      "description": "",
+      "type": "number",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "tickStyle",
+      "description": "",
+      "type": "(ticks: any[]) => { strokeWidth?: number | undefined; gridStrokeWidth?: number | undefined; gridStroke?: string | undefined; }[]",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "tickValues",
+      "description": "",
+      "type": [
+        "string",
+        "number",
+        "ScaleValue[]",
+        "CountableTimeInterval"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "tickRemodelling",
+      "description": "",
+      "type": "(tickValues: any[]) => any[]",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "variant",
+      "description": "Variant.",
+      "type": [
+        "\"line\"",
+        "\"none\"",
+        "\"lineTick\"",
+        "\"tick\"",
+        "\"tickValue\"",
+        "\"default\""
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "x",
+      "description": "X position.",
+      "type": "number",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "y",
+      "description": "Y position.",
+      "type": "number",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "chartWidth",
+      "description": "Chart width, used for horizontal grid.",
+      "type": "number",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "chartHeight",
+      "description": "Chart height, used for horizontal grid.",
+      "type": "number",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "sectionHeight",
+      "description": "Section height, used for horizontal grid within a section.",
+      "type": "number",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "textColor",
+      "description": "Color used for tick values.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "tickToColor",
+      "description": "Custom method to choose which tick value to color if not all.",
+      "type": "(tick?: { textX: number; textY: number; lineX: number; lineY: number; x: number; y: number; key: string; value: ScaleValue; } | undefined, index?: number | undefined) => boolean",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    }
+  ],
+  "examples": [],
+  "tags": {}
+}

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

@@ -0,0 +1,236 @@
+{
+  "name": "Bar",
+  "description": "",
+  "package": "@redsift/charts",
+  "filePath": "packages/charts/src/components/Bar/Bar.tsx",
+  "props": [
+    {
+      "name": "gap",
+      "description": "Gap between two siblings.",
+      "type": "number",
+      "required": false,
+      "defaultValue": "5",
+      "category": "props"
+    },
+    {
+      "name": "height",
+      "description": "Height of the bar in horizontal orientation.",
+      "type": "number",
+      "required": false,
+      "defaultValue": "40",
+      "category": "props"
+    },
+    {
+      "name": "maxHeight",
+      "description": "Maximum height of the bar.",
+      "type": "number",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "orientation",
+      "description": "Orientation of the bar.",
+      "type": "string",
+      "required": false,
+      "defaultValue": "'vertical'",
+      "category": "props"
+    },
+    {
+      "name": "direction",
+      "description": "Direction of the bar, works only with vertical orientation.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "scale",
+      "description": "A linear continuous scale defined over a numeric domain used to determine the width or height of the bar (depending on the orientation).",
+      "type": "ScaleLinear<number, number, never>",
+      "required": true,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "scalePosition",
+      "description": "A scale defined over a numeric/time/ordinal domain used to determine the position of the bar.",
+      "type": [
+        "ScaleLinear<number, number, never>",
+        "ScaleTime<number, number, never>",
+        "ScalePoint<string>"
+      ],
+      "required": true,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "width",
+      "description": "Width of the bar in vertical orientation.",
+      "type": "number",
+      "required": false,
+      "defaultValue": "40",
+      "category": "props"
+    },
+    {
+      "name": "minWidth",
+      "description": "Min width of the bar in vertical orientation.",
+      "type": "number",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "anchorProps",
+      "description": "Anchor props to use when the component is a navigation link.",
+      "type": "AnchorProps",
+      "required": false,
+      "defaultValue": null,
+      "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": "BarDatum",
+      "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": "disableAnimations",
+      "description": "Disable animations.",
+      "type": [
+        "false",
+        "true"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "groupedData",
+      "description": "Group of data in which the data point is a part of.",
+      "type": "any[]",
+      "required": false,
+      "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: BarDatum, 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: BarDatum, dataset: any[]) => void",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "previousData",
+      "description": "State from which the component should start the animation, if any.",
+      "type": "BarDatum",
+      "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": "theme",
+      "description": "Theme.",
+      "type": [
+        "\"light\"",
+        "\"dark\""
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "tooltipVariant",
+      "description": "Tooltip variant.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "tooltipDecorator",
+      "description": "Method modifying what's displayed within the tooltip when the tooltipVariant is \"custom\".",
+      "type": "(data: BarDatum, props?: { index?: number | undefined; isSelected?: boolean | undefined; color?: string | undefined; } | undefined, dataset?: any[] | undefined, groupedData?: any[] | undefined) => string | ReactElement<any, string | JSXElementConstructor<any>>",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "tooltipProps",
+      "description": "Default placement of the tooltip.",
+      "type": "Partial<Omit<TooltipProps, \"ref\">>",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    }
+  ],
+  "examples": [],
+  "tags": {}
+}