[charts][docs] Avoid use of shorthand (#12000)

mui · Feb 9, 2024 · b330095 · b330095
1 parent 385aa21
commit b330095
Show file tree

Hide file tree

Showing 7 changed files with 15 additions and 15 deletions.
diff --git a/docs/data/charts/lines/LineDataset.js b/docs/data/charts/lines/LineDataset.js
@@ -541,7 +541,7 @@ export default function LineDataset() {
       xAxis={[
         {
           dataKey: 'year',
-          valueFormatter: (v) => v.toString(),
+          valueFormatter: (value) => value.toString(),
           min: 1985,
           max: 2022,
         },

diff --git a/docs/data/charts/lines/LineDataset.tsx b/docs/data/charts/lines/LineDataset.tsx
@@ -542,7 +542,7 @@ export default function LineDataset() {
       xAxis={[
         {
           dataKey: 'year',
-          valueFormatter: (v) => v.toString(),
+          valueFormatter: (value) => value.toString(),
           min: 1985,
           max: 2022,
         },

diff --git a/docs/data/charts/tooltip/Formatting.js b/docs/data/charts/tooltip/Formatting.js
@@ -86,9 +86,9 @@ export default function Formatting() {
   return (
     <LineChart
       {...lineChartsParams}
-      xAxis={[{ data: years, scaleType: 'time', valueFormatter: yearFormater }]}
-      series={lineChartsParams.series.map((s) => ({
-        ...s,
+      xAxis={[{ data: years, scaleType: 'time', valueFormatter: yearFormatter }]}
+      series={lineChartsParams.series.map((serie) => ({
+        ...serie,
         valueFormatter: currencyFormatter,
       }))}
     />

diff --git a/docs/data/charts/tooltip/Formatting.tsx b/docs/data/charts/tooltip/Formatting.tsx
@@ -86,9 +86,9 @@ export default function Formatting() {
   return (
     <LineChart
       {...lineChartsParams}
-      xAxis={[{ data: years, scaleType: 'time', valueFormatter: yearFormater }]}
-      series={lineChartsParams.series.map((s) => ({
-        ...s,
+      xAxis={[{ data: years, scaleType: 'time', valueFormatter: yearFormatter }]}
+      series={lineChartsParams.series.map((serie) => ({
+        ...serie,
         valueFormatter: currencyFormatter,
       }))}
     />

diff --git a/docs/data/charts/tooltip/Formatting.tsx.preview b/docs/data/charts/tooltip/Formatting.tsx.preview
@@ -1,8 +1,8 @@
 <LineChart
   {...lineChartsParams}
-  xAxis={[{ data: years, scaleType: 'time', valueFormatter: yearFormater }]}
-  series={lineChartsParams.series.map((s) => ({
-    ...s,
+  xAxis={[{ data: years, scaleType: 'time', valueFormatter: yearFormatter }]}
+  series={lineChartsParams.series.map((serie) => ({
+    ...serie,
     valueFormatter: currencyFormatter,
   }))}
 />
diff --git a/docs/pages/x/api/charts/spark-line-chart.json b/docs/pages/x/api/charts/spark-line-chart.json
@@ -33,7 +33,7 @@
     },
     "valueFormatter": {
       "type": { "name": "func" },
-      "default": "(v: number) => v.toString()",
+      "default": "(value: number | null) => (value === null ? '' : value.toString())",
       "signature": {
         "type": "function(value: number) => string",
         "describedArgs": ["value"],

diff --git a/packages/x-charts/src/SparkLineChart/SparkLineChart.tsx b/packages/x-charts/src/SparkLineChart/SparkLineChart.tsx
@@ -64,7 +64,7 @@ export interface SparkLineChartProps
    * Formatter used by the tooltip.
    * @param {number} value The value to format.
    * @returns {string} the formatted value.
-   * @default (v: number) => v.toString()
+   * @default (value: number | null) => (value === null ? '' : value.toString())
    */
   valueFormatter?: (value: number) => string;
   /**
@@ -146,7 +146,7 @@ const SparkLineChart = React.forwardRef(function SparkLineChart(props: SparkLine
     slotProps,
     data,
     plotType = 'line',
-    valueFormatter = (v: number) => v.toString(),
+    valueFormatter = (value: number | null) => (value === null ? '' : value.toString()),
     area,
     curve = 'linear',
   } = props;
@@ -326,7 +326,7 @@ SparkLineChart.propTypes = {
    * Formatter used by the tooltip.
    * @param {number} value The value to format.
    * @returns {string} the formatted value.
-   * @default (v: number) => v.toString()
+   * @default (value: number | null) => (value === null ? '' : value.toString())
    */
   valueFormatter: PropTypes.func,
   viewBox: PropTypes.shape({