-
Notifications
You must be signed in to change notification settings - Fork 2.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(react-color-picker): Updated documentation for the ColorPicker (#…
…33346) Co-authored-by: Dmytro Kirpa <[email protected]>
- Loading branch information
1 parent
805932b
commit 3626d0a
Showing
3 changed files
with
178 additions
and
156 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
80 changes: 80 additions & 0 deletions
80
packages/react-components/react-color-picker-preview/library/docs/MIGRATION.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
## ColorPicker Migration | ||
|
||
## ColorPicker component | ||
|
||
### Fabric (v8) property mapping | ||
|
||
#### New props | ||
|
||
- `shape` | ||
|
||
#### Supported Props | ||
|
||
- `color` | ||
- `onChange` | ||
|
||
#### Props no longer supported with an equivalent functionality in ColorPicker V9: | ||
|
||
- `className` => Slot system supports it by default. We don't need to provide it explicitly. | ||
- `styles` => Use style customization through `className` instead. | ||
- `theme` | ||
|
||
#### Props no longer supported | ||
|
||
- `alphaType` | ||
- `componentRef` | ||
- `showPreview` | ||
- `strings` | ||
- `tooltipProps` | ||
|
||
#### ColorArea component | ||
|
||
#### New props | ||
|
||
- `defaultColor` | ||
- `shape` | ||
- `onChange` | ||
|
||
#### Props supported | ||
|
||
- `color` | ||
|
||
#### ColorSlider component | ||
|
||
#### New props | ||
|
||
- `defaultColor` | ||
- `shape` | ||
- `orient` | ||
|
||
#### Props supported | ||
|
||
- `onChange` | ||
|
||
#### Props no longer supported with an equivalent functionality in ColorPicker V9: | ||
|
||
- `value` => Use `color` instead | ||
- `type` => in case of support channels it'll be `channel` instead | ||
- `isAlpha` => use `AlphaSlider` component instead | ||
- `overlayColor` => part of `AlphaSlider` component | ||
- `thumbColor` => is calculated automatically or can be customized via CSS | ||
|
||
#### Props no longer supported | ||
|
||
- `minValue` | ||
- `maxValue` | ||
|
||
#### Property Mapping | ||
|
||
| v8 `ColorPicker` | v9 `ColorPicker` | | ||
| ---------------- | -------------------------- | | ||
| `value` | `color` | | ||
| `onChange` | `onChange` | | ||
| `maxValue` | | | ||
| `minValue` | | | ||
| `shape ` | | | ||
| `type` | | | ||
| `isAlpha` | `AlphaSlider` component | | ||
| `overlayColor` | In `AlphaSlider` component | | ||
| `thumbColor` | | | ||
| | `shape` | |
Oops, something went wrong.