Skip to content

Commit 7619d97

Browse files
committed
chore: update README to 0.4.7
1 parent 1d83920 commit 7619d97

File tree

1 file changed

+15
-16
lines changed

1 file changed

+15
-16
lines changed

README.md

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
- Fully compatible with Material-UI : theming and low level components
3838
- Styled with `styled-components`
3939
- Highly customizable ColorPicker : gradient picker, palette, input format, deferred mode
40-
- Small in size (<30kb) without any extra dependencies
40+
- Small in size (<30kb) without any direct dependencies
4141
- Use modern React hook and coding conventions
4242
- Documentation made with Storybook, using Component Story Format and MDX
4343

@@ -47,10 +47,15 @@ Full documentation is available here :
4747

4848
https://mikbry.github.io/material-ui-color/
4949

50+
### Examples availables
51+
52+
- Javascript : https://codesandbox.io/s/material-ui-color-qb4vm?file=/src/App.tsx
53+
54+
- Typescript : https://codesandbox.io/s/material-ui-color-picker-qvcg3?file=/src/App.tsx
5055

5156
## Requirements
5257
- Works on modern browsers supporting ES6+ (Not compatible with IE)
53-
- Latest React, Styled-Component and Material-UI frameworks
58+
- React, Styled-Component and Material-UI frameworks
5459

5560
## Install
5661

@@ -70,7 +75,7 @@ you need to have in your dependencies:
7075
```
7176
"@material-ui/core": "^4.9.5",
7277
"material-ui-popup-state": "^1.5.3",
73-
"prop-types": "15.7.2",
78+
"prop-types": "^15.7.2",
7479
"react": "^16.12.0",
7580
"react-dom": "^16.12.0",
7681
"styled-components": "^5.0.1"
@@ -177,25 +182,19 @@ export const Container = () => (
177182

178183
## Roadmap
179184

180-
### v0.3.0 - [Current version](https://github.com/mikbry/material-ui-color/projects/1)
181-
- add Typescript support
182-
- accessibility : keyboard and touch support
183-
- localization
184-
- disable alpha property
185-
- #30, #29, #22 resolved
186-
- WIP - better documentation: colorType explained, i18n, typescript examples
187-
188-
### v0.4.0 - WIP
189-
- optimize code
190-
- redesign inputs in ColorBox
191-
- remove `styled-components` to have less dependencies and reduce size
192-
- bugs fixes
185+
### v0.4.7 - [Current version](https://github.com/mikbry/material-ui-color/projects/3)
186+
- feat: ColorPicker when using onChange with defaultValue don't create a controlled component #100
187+
- fix: openAtStart=true wrong positionning #68
188+
- feat: ColorPicker support disable 'plain' textfield format #82
189+
- fix: Can't make localisation to work (Typescript) #84
193190

194191
### v0.5.0 - planned
195192
- rtl support
196193
- ColorInput : display alpha and size according to MUi
197194
- ColorInput : optional color box as left or right icon
198195
- ColorPicker: left or right Colorbox
196+
- redesign inputs in ColorBox
197+
- remove `styled-components` to have less dependencies and reduce size
199198
- bugs fixes
200199

201200
## Contribute

0 commit comments

Comments
 (0)