Add codemod explanation.

mui · Feb 7, 2025 · e25f08c · e25f08c
1 parent ecf0834
commit e25f08c
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/packages/x-codemod/README.md b/packages/x-codemod/README.md
@@ -256,6 +256,26 @@ Remove the `<ChartsOnAxisClickHandler />` and move the associated `onAxisClick`
  </ChartContainer>
 ```
 
+#### `rename-sparkline-colors-to-color`
+
+Renames the `colors` prop of a `SparkLineChart` to `color` and accesses its first element.
+
+```diff
+ <SparkLineChart
+-  colors={['red']}
++  color={['red'][0]}
+ />
+```
+
+If `colors` is a function, it will be wrapped in another function that returns its first element.
+
+```diff
+ <SparkLineChart
+-  colors={fn}
++  color={typeof fn === 'function' ? mode => fn(mode)[0] : fn[0]}
+ />
+```
+
 ### Data Grid codemods
 
 #### `preset-safe` for Data Grid v8.0.0