Skip to content

Commit a796a5d

Browse files
committed
[REF]: Improve readme and changelog files
1 parent 5d421a1 commit a796a5d

File tree

2 files changed

+69
-35
lines changed

2 files changed

+69
-35
lines changed

CHANGELOG.md

Lines changed: 54 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Change Log
2+
23
<a href="https://www.files-ui.com">
34
<p align="center">
45
<img src="https://user-images.githubusercontent.com/43678736/226257748-6ba2f8cf-59c5-40d1-a545-a388ddab0f68.png" width="150" height="150" alt="fui-logo"/>
@@ -10,29 +11,57 @@
1011
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
1112
Thils file also consider all dropzone-ui [releases](https://github.com/dropzone-ui/dropzone-ui-react/releases).
1213

13-
## [1.0.0](https://github.com/files-ui/files-ui-react/releases/tag/v1.0.0) (2023-03-28)
14+
## [Files-ui (1.0.0) = Dropzone-ui(7.0.0)](https://github.com/files-ui/files-ui-react/releases/tag/v1.0.0) (2023-03-28)
1415

15-
## 🧪 New features
16+
## 🧪 New features and 🐛 :hammer: Improvements
1617

17-
- \<FileMosaic/\>: Added `resultOnToolip` prop. This prop provides another hover interaction. If present or `true`, FileItem will show the file validation status and the upload status on a nice tooltip. Otherwhise, if not present, false or undefined, FileItem will display the result on the InfoLayer. Special thanks to @mateusmx, 👏 who suggested this feature🧪.
18+
- [\<FileMosaic/\>](https://www.files-ui.com/components/filemosaic): This new component replaces the old "FileItem" component.
1819

19-
- \<FileCard/\>: Added `resultOnToolip` prop. This prop provides another hover interaction. If present or `true`, FileItem will show the file validation status and the upload status on a nice tooltip. Otherwhise, if not present, false or undefined, FileItem will display the result on the InfoLayer. Special thanks to @mateusmx, 👏 who suggested this feature🧪.
20+
- Dark mode: Now this component can be adpted to a dark mode pages with the respective prop.
21+
- New icons: Icons for delete were changed.
22+
- For uploading, the loader can support to display the current progress.
2023

21-
- \<Dropzone/\>: Added `disableScroll` prop. This prop disables the css property `overflow: auto` in FileItemContainer inside Dropzone, when it displays the FileItem list inside of it. It also disables the `maxHeight` property and forces the `view` prop to be `"grid"`. The purpose of this special prop is to allow FileItemContainer to grow at the same time FileItem list increases and prevent triggering scrollbars.
24+
- [\<FileCard/\>](https://www.files-ui.com/components/filecard): This new component is an alternative version of FileMosaic. It displays the file info in a card. Receives the same props as FileMosaic plus `elevation`.
2225

23-
## 🐛 Fixes or improvements
26+
- [\<FileInputButton/\>](https://www.files-ui.com/components/dropzone): This component replaces the old "InputButton" component. The features are the same as the dropzone except the header and footer related features. That means that this component now can trigger the upload progress.
27+
Validation is optional, so non valid files can be uploaded.
2428

25-
- \<Dropzone/>: Fixed issue in FileItemContainer that made it to overflow the size of Dropzone.
29+
- [\<Avatar/\>](https://www.files-ui.com/components/avatar): This new component is designed tohandle the selection of images for changing the avatar. Can recieve as source an string url or even a File.
2630

27-
## 📚 Improved documentation.
31+
- [\<FullScreen/\>](https://www.files-ui.com/components/fullscreen): The old components "FullScreenImage" and "FullScreenVideo" have been separated into FUllScreen, ImagePreview and VideoPreview.
2832

29-
- Added documentation about this new features
33+
- FullScreen: component for display in a fullscreen backdrop other components.
34+
- [ImagePreview](https://www.files-ui.com/api/imagepreview): component is an \<img/\> tag enhanced to allow as `src` a string url or a ile object.
35+
- [VideoPreview](https://www.files-ui.com/api/videopreview): component is an \<video/\> tag enhanced to allow as `src` a string url or a ile object.
36+
37+
- [\<Dropzone/\>](https://www.files-ui.com/components/dropzone): This component has been refactored to improve the design, colors and internal components such us headeror footer.
38+
39+
- Header and footer can be handled through 2 new props: `headerConfig` and `footerConfig`
40+
- Action buttons: these are external buttons thta can trigger the default operations in dropzone.
41+
- Uploading: The upload operation now is completele handled using pure javascript without external libraries wich means `axios` is no longer a dependency.
3042

43+
- `smartImgFit`: This is a special prop for FileMosaic, FileCard and Avatar components that makes someway "smart" the components to fit the images depeding on their orientation ("landscape" or protrait). Square images are hardly afected.
44+
45+
- How it works?
46+
47+
- If false, image width will be set to 100%.
48+
If present, image will be analized and displayed according to its heigh and width. Image with height greater than its width has a "portrait" orientation. Otherwise it has a "landscape" orientation. .
49+
50+
- If value is "orientation", image will be displayed complete by giving 100% to width prop if the orientation is "landscape". When orientation is "portrait", height prop will be set to 100%. Some images will show an empty space.
51+
52+
- If value is "center", image will be centered and will not be displayed complete. This the empty space is avoided. This is achived by giving 100% to width prop if the orientation is "portrait". When orientation is "landscape", height prop will be set to 100%.
53+
54+
- [FilesUIProvider](https://www.files-ui.com/global-config): Localization and darkMode are props that can be set globally by using the React context API. Also the new feature that comes wit this improvement is that now is possible to set custom file icons for every file type.
55+
56+
- [Download Files](https://www.files-ui.com/global-config): Both FileCard and FileMosaic components are able to perform download from same origin or external resources.
57+
58+
## 📚 Improved documentation.
3159

60+
- The complete documentation can be found in files-ui [web page](https://www.files-ui.com).
3261

3362
<a name="6.4.0"></a>
3463

35-
## [6.4.0](https://github.com/dropzone-ui/dropzone-ui-react/releases/tag/v6.4.0) (2021-12-12)
64+
## [6.4.0 dropzone-ui](https://github.com/dropzone-ui/dropzone-ui-react/releases/tag/v6.4.0) (2021-12-12)
3665

3766
## 🧪 New features
3867

@@ -51,7 +80,7 @@ Thils file also consider all dropzone-ui [releases](https://github.com/dropzone-
5180

5281
<a name="6.3.6"></a>
5382

54-
## [6.3.6](https://github.com/dropzone-ui/dropzone-ui-react/releases/tag/v6.3.6) (2021-07-12)
83+
## [6.3.6 dropzone-ui](https://github.com/dropzone-ui/dropzone-ui-react/releases/tag/v6.3.6) (2021-07-12)
5584

5685
## 🧪 New features
5786

@@ -69,7 +98,7 @@ Thils file also consider all dropzone-ui [releases](https://github.com/dropzone-
6998

7099
<a name="6.2.0"></a>
71100

72-
## [6.2.0](https://github.com/dropzone-ui/dropzone-ui-react/releases/tag/v6.2.0) (2021-26-11)
101+
## [6.2.0 dropzone-ui](https://github.com/dropzone-ui/dropzone-ui-react/releases/tag/v6.2.0) (2021-26-11)
73102

74103
### New features
75104

@@ -92,15 +121,15 @@ Thils file also consider all dropzone-ui [releases](https://github.com/dropzone-
92121

93122
<a name="5.5.6"></a>
94123

95-
## [5.5.6](https://github.com/dropzone-ui/dropzone-ui-react/releases/tag/v5.3.0) (2021-26-11)
124+
## [5.5.6 dropzone-ui](https://github.com/dropzone-ui/dropzone-ui-react/releases/tag/v5.3.0) (2021-26-11)
96125

97126
- 🧪 Added Localization support for ✨ **Russian** and **Chinese** ✨.
98127
- 🐛 Fixed small bugs.
99128
- 📚 Improved documentation.
100129

101130
<a name="3.0.1"></a>
102131

103-
## [3.0.1](https://github.com/dropzone-ui/dropzone-ui/compare/v2.8.1...v3.0.1) (2021-10-11)
132+
## [3.0.1 dropzone-ui](https://github.com/dropzone-ui/dropzone-ui/compare/v2.8.1...v3.0.1) (2021-10-11)
104133

105134
### Features
106135

@@ -110,30 +139,30 @@ Thils file also consider all dropzone-ui [releases](https://github.com/dropzone-
110139

111140
<a name="3.0.1"></a>
112141

113-
## [3.0.1](https://github.com/dropzone-ui/dropzone-ui/compare/v2.8.1...v3.0.1) (2021-10-11)
142+
## [3.0.1 dropzone-ui](https://github.com/dropzone-ui/dropzone-ui/compare/v2.8.1...v3.0.1) (2021-10-11)
114143

115144
### Features
116145

117146
- Translation support for `Portuguese`.
118147
<a name="2.8.1"></a>
119148

120-
## [2.8.1](https://github.com/dropzone-ui/dropzone-ui/compare/v2.8.1...v2.1.1) (2021-10-08)
149+
## [2.8.1 dropzone-ui](https://github.com/dropzone-ui/dropzone-ui/compare/v2.8.1...v2.1.1) (2021-10-08)
121150

122151
### Features
123152

124153
- Translation support for `French`.
125154

126155
<a name="2.1.1"></a>
127156

128-
## [2.1.1](https://github.com/dropzone-ui/dropzone-ui/compare/v2.1.1...v2.0.0) (2021-10-01)
157+
## [2.1.1 dropzone-ui](https://github.com/dropzone-ui/dropzone-ui/compare/v2.1.1...v2.0.0) (2021-10-01)
129158

130159
### Features
131160

132161
- Fixed issue on tsconfig.json that affected build process
133162

134163
<a name="2.1.0"></a>
135164

136-
## [2.1.0](https://github.com/dropzone-ui/dropzone-ui/compare/v2.1.0...v2.0.0) (2021-09-28)
165+
## [2.1.0 dropzone-ui](https://github.com/dropzone-ui/dropzone-ui/compare/v2.1.0...v2.0.0) (2021-09-28)
137166

138167
### Features
139168

@@ -144,7 +173,7 @@ Thils file also consider all dropzone-ui [releases](https://github.com/dropzone-
144173

145174
<a name="2.0.0"></a>
146175

147-
## [2.0.0](https://github.com/dropzone-ui/dropzone-ui/compare/v2.0.0...v1.2.10) (2021-09-21)
176+
## [2.0.0 dropzone-ui](https://github.com/dropzone-ui/dropzone-ui/compare/v2.0.0...v1.2.10) (2021-09-21)
148177

149178
### Features
150179

@@ -154,15 +183,15 @@ Thils file also consider all dropzone-ui [releases](https://github.com/dropzone-
154183

155184
<a name="1.2.10"></a>
156185

157-
## [1.2.10](https://github.com/dropzone-ui/dropzone-ui/compare/v1.0.1...v1.0.2) (2021-09-21)
186+
## [1.2.10 dropzone-ui](https://github.com/dropzone-ui/dropzone-ui/compare/v1.0.1...v1.0.2) (2021-09-21)
158187

159188
### Features
160189

161190
- Improve Readme.md
162191
- Add quiality badge
163192
<a name="1.2.9"></a>
164193

165-
## [1.2.9](https://github.com/dropzone-ui/dropzone-ui/compare/v1.0.1...v1.0.2) (2021-09-12)
194+
## [1.2.9 dropzone-ui](https://github.com/dropzone-ui/dropzone-ui/compare/v1.0.1...v1.0.2) (2021-09-12)
166195

167196
### Features
168197

@@ -172,15 +201,15 @@ Thils file also consider all dropzone-ui [releases](https://github.com/dropzone-
172201

173202
<a name="1.1.28"></a>
174203

175-
## [1.1.28](https://github.com/dropzone-ui/dropzone-ui/compare/v1.0.1...v1.0.2) (2021-09-09)
204+
## [1.1.28 dropzone-ui](https://github.com/dropzone-ui/dropzone-ui/compare/v1.0.1...v1.0.2) (2021-09-09)
176205

177206
### Features
178207

179208
- Minor bug fixed, upload status not hiding on info open fixed
180209

181210
<a name="1.0.28"></a>
182211

183-
## [1.0.28](https://github.com/dropzone-ui/dropzone-ui/compare/v1.0.1...v1.0.2) (2021-09-08)
212+
## [1.0.28 dropzone-ui](https://github.com/dropzone-ui/dropzone-ui/compare/v1.0.1...v1.0.2) (2021-09-08)
184213

185214
### Features
186215

@@ -193,12 +222,12 @@ Thils file also consider all dropzone-ui [releases](https://github.com/dropzone-
193222

194223
<a name="1.0.1"></a>
195224

196-
## [1.0.1](https://github.com/dropzone-ui/dropzone-ui/compare/v1.0.0...v1.0.1) (2021-08-28)
225+
## [1.0.1 dropzone-ui](https://github.com/dropzone-ui/dropzone-ui/compare/v1.0.0...v1.0.1) (2021-08-28)
197226

198227
### Features
199228

200229
- README improvements
201230

202231
<a name="1.0.0"></a>
203232

204-
# [1.0.0](https://github.com/dropzone-ui/dropzone-ui/compare/v0.1.2...v1.0.0) (2021-08-28)
233+
# [1.0.0 dropzone-ui](https://github.com/dropzone-ui/dropzone-ui/compare/v0.1.2...v1.0.0) (2021-08-28)

README.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -66,28 +66,33 @@ ReactDOM.render(<App />, document.querySelector("#app"));
6666

6767
Yes, it's really all you need to get started as you can see in these live and interactive demos:
6868

69-
- [basic sample](http://localhost:3000/usage#quick-start) :cake:
70-
- [advanced sample](http://www.files-ui.com/usage#advanced-example) :hammer:
69+
- [Basic sample](http://localhost:3000/usage#quick-start) :cake:
70+
- [Advanced sample](http://www.files-ui.com/usage#advanced-example) :hammer:
7171

7272
## More Previews
7373

74-
### Image full screen preview
75-
76-
<p align="center"><img src="https://user-images.githubusercontent.com/43678736/228066199-fb7a5bd3-9c7e-4f72-b0ef-7f11d236d38e.png" alt="Image full screen preview" width="100%"/></p>
77-
78-
### Video full screen preview
74+
<details>
75+
<summary>Image full screen preview 🖼️ </summary>
76+
<p align="center"><img src="https://user-images.githubusercontent.com/43678736/228066199-fb7a5bd3-9c7e-4f72-b0ef-7f11d236d38e.png" alt="Image full screen preview" width="100%"/></p>
7977

78+
</details>
79+
<details>
80+
<summary>Video full screen preview 🎞️ </summary>
8081
<p align="center"><img src="https://user-images.githubusercontent.com/43678736/228066195-62063300-21e0-48fd-80d8-31b566562fde.png" alt="Video full screen preview" width="100%"/></p>
82+
</details>
8183

82-
### File Mosaic, FileInputButotn and Avatar preview
83-
84+
<details>
85+
<summary>FileCard, FileInputButton and Avatar preview 🎴 </summary>
8486
<p align="center"><img src="https://user-images.githubusercontent.com/43678736/228063876-5b6d00fe-f0ba-453f-a7ce-c44ba7444417.png" alt="Video full screen preview" width="100%"/></p>
8587

86-
### DarkMode
88+
</details>
8789

90+
<details>
91+
<summary>DarkMode 🌙 🌞 </summary>
8892
<p align="center"><img src="https://user-images.githubusercontent.com/43678736/228063883-569ca6f1-6959-45bc-9882-2c447162a00f.png" alt="darkmode 1 preview" width="100%"/></p>
8993

9094
<p align="center"><img src="https://user-images.githubusercontent.com/43678736/228066720-e0bb96ac-3c00-4aa6-80b9-e0b4d0c5f947.png" alt="darkmode 2 preview" width="100%"/></p>
95+
</details>
9196

9297
## License
9398

0 commit comments

Comments
 (0)