@zendeskgarden/react-colorpickers 9.0.0-next.1 → 9.0.0-next.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (33) hide show
  1. package/README.md +72 -2
  2. package/dist/index.cjs.js +283 -255
  3. package/dist/index.esm.js +284 -256
  4. package/dist/typings/elements/{Colorpicker → ColorPicker}/index.d.ts +2 -2
  5. package/dist/typings/elements/{ColorpickerDialog → ColorPickerDialog}/index.d.ts +2 -2
  6. package/dist/typings/index.d.ts +3 -3
  7. package/dist/typings/styled/{ColorpickerDialog → ColorPickerDialog}/StyledButtonPreview.d.ts +2 -2
  8. package/dist/typings/styled/ColorSwatch/StyledColorSwatch.d.ts +1 -2
  9. package/dist/typings/styled/ColorSwatch/StyledColorSwatchInput.d.ts +13 -0
  10. package/dist/typings/styled/ColorSwatch/StyledColorSwatchLabel.d.ts +16 -0
  11. package/dist/typings/styled/ColorSwatch/StyledIcon.d.ts +1 -3
  12. package/dist/typings/styled/index.d.ts +19 -18
  13. package/dist/typings/types/index.d.ts +12 -32
  14. package/package.json +10 -9
  15. package/dist/typings/styled/ColorSwatch/StyledSwatchButton.d.ts +0 -8
  16. /package/dist/typings/elements/{Colorpicker → ColorPicker}/ColorWell.d.ts +0 -0
  17. /package/dist/typings/elements/{Colorpicker → ColorPicker}/reducer.d.ts +0 -0
  18. /package/dist/typings/styled/{Colorpicker → ColorPicker}/StyledAlphaRange.d.ts +0 -0
  19. /package/dist/typings/styled/{Colorpicker → ColorPicker}/StyledColorPicker.d.ts +0 -0
  20. /package/dist/typings/styled/{Colorpicker → ColorPicker}/StyledColorWell.d.ts +0 -0
  21. /package/dist/typings/styled/{Colorpicker → ColorPicker}/StyledColorWellThumb.d.ts +0 -0
  22. /package/dist/typings/styled/{Colorpicker → ColorPicker}/StyledHexField.d.ts +0 -0
  23. /package/dist/typings/styled/{Colorpicker → ColorPicker}/StyledHueRange.d.ts +0 -0
  24. /package/dist/typings/styled/{Colorpicker → ColorPicker}/StyledInput.d.ts +0 -0
  25. /package/dist/typings/styled/{Colorpicker → ColorPicker}/StyledInputGroup.d.ts +0 -0
  26. /package/dist/typings/styled/{Colorpicker → ColorPicker}/StyledLabel.d.ts +0 -0
  27. /package/dist/typings/styled/{Colorpicker → ColorPicker}/StyledPreview.d.ts +0 -0
  28. /package/dist/typings/styled/{Colorpicker → ColorPicker}/StyledRGBAField.d.ts +0 -0
  29. /package/dist/typings/styled/{Colorpicker → ColorPicker}/StyledSliderGroup.d.ts +0 -0
  30. /package/dist/typings/styled/{Colorpicker → ColorPicker}/StyledSliders.d.ts +0 -0
  31. /package/dist/typings/styled/{ColorpickerDialog → ColorPickerDialog}/StyledButton.d.ts +0 -0
  32. /package/dist/typings/styled/{ColorpickerDialog → ColorPickerDialog}/StyledTooltipBody.d.ts +0 -0
  33. /package/dist/typings/styled/{ColorpickerDialog → ColorPickerDialog}/StyledTooltipModal.d.ts +0 -0
package/README.md CHANGED
@@ -14,15 +14,85 @@ npm install react react-dom styled-components @zendeskgarden/react-theming
14
14
 
15
15
  ## Usage
16
16
 
17
+ ### ColorPicker
18
+
17
19
  ```jsx
18
20
  import { ThemeProvider } from '@zendeskgarden/react-theming';
19
- import { Colorpicker } from '@zendeskgarden/react-colorpickers';
21
+ import { ColorPicker } from '@zendeskgarden/react-colorpickers';
20
22
 
21
23
 
22
24
  /**
23
25
  * Place a `ThemeProvider` at the root of your React application
24
26
  */
25
27
  <ThemeProvider>
26
- <Colorpicker defaultColor="#17494D">
28
+ <ColorPicker defaultColor="#17494D">
27
29
  </ThemeProvider>
28
30
  ```
31
+
32
+ ### ColorPickerDialog
33
+
34
+ ```jsx
35
+ import { ThemeProvider } from '@zendeskgarden/react-theming';
36
+ import { ColorPickerDialog } from '@zendeskgarden/react-colorpickers';
37
+
38
+ /**
39
+ * Place a `ThemeProvider` at the root of your React application
40
+ */
41
+ <ThemeProvider>
42
+ <ColorPickerDialog defaultColor="#17494D" buttonProps={{ 'aria-label': 'Example label' }} />
43
+ </ThemeProvider>;
44
+ ```
45
+
46
+ ### ColorSwatch
47
+
48
+ ```jsx
49
+ import { ThemeProvider } from '@zendeskgarden/react-theming';
50
+ import { ColorSwatch } from '@zendeskgarden/react-colorpickers';
51
+
52
+ const colors = [
53
+ [
54
+ { label: 'Green-800', value: '#0b3b29' },
55
+ { label: 'Green-700', value: '#186146' }
56
+ ],
57
+ [
58
+ { label: 'Green-600', value: '#038153' },
59
+ { label: 'Green-500', value: '#228f67' }
60
+ ]
61
+ ];
62
+
63
+ /**
64
+ * Place a `ThemeProvider` at the root of your React application
65
+ */
66
+ <ThemeProvider>
67
+ <ColorSwatch colors={colors} name="swatch" />
68
+ </ThemeProvider>;
69
+ ```
70
+
71
+ ### ColorSwatchDialog
72
+
73
+ ```jsx
74
+ import { ThemeProvider } from '@zendeskgarden/react-theming';
75
+ import { ColorSwatchDialog } from '@zendeskgarden/react-colorpickers';
76
+
77
+ const colors = [
78
+ [
79
+ { label: 'Green-800', value: '#0b3b29' },
80
+ { label: 'Green-700', value: '#186146' }
81
+ ],
82
+ [
83
+ { label: 'Green-600', value: '#038153' },
84
+ { label: 'Green-500', value: '#228f67' }
85
+ ]
86
+ ];
87
+
88
+ /**
89
+ * Place a `ThemeProvider` at the root of your React application
90
+ */
91
+ <ThemeProvider>
92
+ <ColorSwatchDialog
93
+ colors={colors}
94
+ name="swatch-dialog"
95
+ buttonProps={{ 'aria-label': 'Example label' }}
96
+ />
97
+ </ThemeProvider>;
98
+ ```