Skip to content

Commit

Permalink
Small doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
bernardobelchior committed Feb 6, 2025
1 parent b2cb4f5 commit 9e53d77
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions docs/pages/x/api/charts/spark-line-chart.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@
"area": { "type": { "name": "bool" }, "default": "false" },
"color": {
"type": { "name": "union", "description": "func<br>&#124;&nbsp;string" },
"default": "rainbowSurgePalette"
"default": "rainbowSurgePalette[0]"
},
"colors": {
"type": { "name": "union", "description": "Array&lt;string&gt;<br>&#124;&nbsp;func" },
"default": "rainbowSurgePalette",
"deprecated": true,
"deprecationInfo": "use {@link color} prop instead"
"deprecationInfo": "use the <code>color</code> prop instead"
},
"dataset": { "type": { "name": "arrayOf", "description": "Array&lt;object&gt;" } },
"disableAxisListener": { "type": { "name": "bool" }, "default": "false" },
Expand Down
8 changes: 4 additions & 4 deletions packages/x-charts/src/SparkLineChart/SparkLineChart.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -111,13 +111,13 @@ export interface SparkLineChartProps
/**
* Color palette used to colorize multiple series.
* @default rainbowSurgePalette
* @deprecated use {@link color} prop instead
* @deprecated use the `color` prop instead
*/
colors?: ChartContainerProps['colors'];

/**
* Color used to colorize the sparkline.
* @default rainbowSurgePalette
* @default rainbowSurgePalette[0]
*/
color?: ChartsColor;
}
Expand Down Expand Up @@ -262,13 +262,13 @@ SparkLineChart.propTypes = {
className: PropTypes.string,
/**
* Color used to colorize the sparkline.
* @default rainbowSurgePalette
* @default rainbowSurgePalette[0]
*/
color: PropTypes.oneOfType([PropTypes.func, PropTypes.string]),
/**
* Color palette used to colorize multiple series.
* @default rainbowSurgePalette
* @deprecated use {@link color} prop instead
* @deprecated use the `color` prop instead
*/
colors: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.string), PropTypes.func]),
/**
Expand Down

0 comments on commit 9e53d77

Please sign in to comment.