Skip to content

Commit b2c1aab

Browse files
fourcelsfourcels
committed
update readme
1 parent f24aab5 commit b2c1aab

File tree

7 files changed

+33
-24
lines changed

7 files changed

+33
-24
lines changed

‎README.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,7 @@
44

55
A image upload component for React
66

7-
## Documentation
8-
9-
Visit [https://github.com/fourcels/react-image-upload](https://github.com/fourcels/react-image-upload) to view the full documentation.
7+
Visit [react-image-upload](https://fourcels.github.io/react-image-upload/) to view the documentation and examples.
108

119
## Getting Started
1210

‎docs/CHANGELOG.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# docs
22

3+
## 0.0.7
4+
5+
### Patch Changes
6+
7+
- Updated dependencies
8+
- @fourcels/react-image-upload@0.5.10
9+
310
## 0.0.6
411

512
### Patch Changes

‎docs/docs/api.mdx‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,21 @@ sidebar_position: 2
55

66
## ImageUploadProps
77

8-
| Name | Type | Default |
9-
| ------------------ | ---------------------------------------------------- | ----------------------------------------- |
10-
| children | React.ReactNode | |
11-
| width | `number` | 100 |
12-
| height | `number` | `width` |
13-
| value | `string` \| `ValueItem` \| `(string \| ValueItem)[]` | [] |
14-
| onChange | (value: `ImageItem[]`) => void | |
15-
| onUpload | (file: `File`) => `string` \| `Promise<string>` | (file: File) => URL.createObjectURL(file) |
16-
| max | `number` | Infinity |
17-
| readonly | `boolean` | |
18-
| className | `string` | |
19-
| itemClassName | `string` | |
20-
| dropzoneClassName | `string` | |
21-
| dropzoneOptions | DropzoneOptions | |
22-
| photoProviderProps | Omit\<PhotoProviderProps, "children"\> | |
8+
| Name | Description | Type | Default |
9+
| ------------------ | --------------------------------------- | ---------------------------------------------------- | ----------------------------------------- |
10+
| children | custom upload zone | React.ReactNode | |
11+
| width | image width | `number` | 100 |
12+
| height | image height | `number` | `width` |
13+
| value | default images | `string` \| `ValueItem` \| `(string \| ValueItem)[]` | [] |
14+
| onChange | callback for when the images changes | (value: `ImageItem[]`) => void | |
15+
| onUpload | callback for when the drop event occurs | (file: `File`) => `string` \| `Promise<string>` | (file: File) => URL.createObjectURL(file) |
16+
| max | max image number | `number` | Infinity |
17+
| readonly | for preview | `boolean` | |
18+
| className | root className | `string` | |
19+
| itemClassName | image className | `string` | |
20+
| dropzoneClassName | dropzone className | `string` | |
21+
| dropzoneOptions | | DropzoneOptions | |
22+
| photoProviderProps | | Omit\<PhotoProviderProps, "children"\> | |
2323

2424
### Types
2525

‎docs/package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "docs",
3-
"version": "0.0.6",
3+
"version": "0.0.7",
44
"private": true,
55
"scripts": {
66
"docusaurus": "docusaurus",

‎packages/react-image-upload/CHANGELOG.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# @fourcels/react-image-upload
22

3+
## 0.5.10
4+
5+
### Patch Changes
6+
7+
- update readme
8+
39
## 0.5.9
410

511
### Patch Changes

‎packages/react-image-upload/README.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,9 @@
22

33
[![NPM version][npm-image]][npm-url]
44

5-
A image upload component for React base on
5+
A image upload component for React
66

7-
## Documentation
8-
9-
Visit [https://github.com/fourcels/react-image-upload](https://github.com/fourcels/react-image-upload) to view the full documentation.
7+
Visit [react-image-upload](https://fourcels.github.io/react-image-upload/) to view the documentation and examples.
108

119
## Getting Started
1210

‎packages/react-image-upload/package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@fourcels/react-image-upload",
3-
"version": "0.5.9",
3+
"version": "0.5.10",
44
"type": "module",
55
"description": "A image upload component for React",
66
"main": "./dist/index.js",

0 commit comments

Comments
 (0)