Skip to content

Commit 4759ed5

Browse files
committed
[REF]: improve readme
1 parent 914d70b commit 4759ed5

76 files changed

Lines changed: 15 additions & 959 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,11 @@
1313
[![Total alerts](https://img.shields.io/lgtm/alerts/g/dropzone-ui/dropzone-ui.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/dropzone-ui/dropzone-ui/alerts/)
1414
[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/dropzone-ui/dropzone-ui.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/dropzone-ui/dropzone-ui/context:javascript)
1515
[![Known Vulnerabilities](https://snyk.io/test/github/dropzone-ui/dropzone-ui/badge.svg)](https://snyk.io/test/github/dropzone-ui/dropzone-ui)
16-
[![](https://data.jsdelivr.com/v1/package/npm/dropzone-ui/badge)](https://www.jsdelivr.com/package/npm/dropzone-ui)
1716
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
1817

1918
## Description
2019

21-
Dropzone UI is a mini set of [React](https://reactjs.org/) components for managing file uploads, image previews and all with **little** code needed. Components were made inspired on other existing libraries like [react-dropzone](https://www.npmjs.com/package/react-dropzone) and [dropzonejs](https://www.npmjs.com/package/dropzone) (however, both are **not** dependencies in order avoid increasing the package size and the idea is to **create** something **new** having many good existing libraries only as **reference**). Also, some componetes follows some of the good google's Material design principles. Actually, all the icons involved are google material design icons.
20+
Dropzone UI is a mini set of [React](https://reactjs.org/) components for managing file uploads, image previews and all with **little** code needed. Components were made inspired on other existing libraries (however, those are **not** dependencies in order avoid increasing the package size and the idea is to **create** something **new** having many good existing libraries only as **reference**). Also, some componetes follows some of the good google's Material design principles. Indeed, all the icons involved are google material design icons.
2221

2322
## Sample result:
2423

@@ -71,11 +70,13 @@ ReactDOM.render(<App />, document.querySelector("#app"));
7170
```
7271

7372
Yes, it's really all you need to get started as you can see in these live and interactive demos:
74-
| Name | Go |
73+
| Name | Codesandbox |
7574
|-|-|
76-
|Basic example|[![Edit Button](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/basic-3j01v?file=/src/index.js)|
77-
|Complete example|[![Edit Button](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/complete-946hz?file=/src/index.js)|
75+
|Dropzone Basic example|[![Edit Button](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/basic-3j01v?file=/src/index.js)|
76+
|Dropzone Complete example|[![Edit Button](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/complete-946hz?file=/src/index.js)|
7877
|File item props|[![Edit Button](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/fileitem-props-o0w5x)|
78+
|No preview FileItem|[![Edit Button](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/no-preview-14i2m) |
79+
|InputFileButton|[![Edit Button](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/inputbutton-example-poqsn?file=/src/App.js)|
7980
|Server side upload file | https://github.com/dropzone-ui/file-upload-server-side/tree/main/expressjs |
8081

8182
# Dropzone UI Components API

build/components/dropzone/components/Dropzone/Dropzone.d.ts

Lines changed: 0 additions & 5 deletions
This file was deleted.

build/components/dropzone/components/Dropzone/DropzoneProps.d.ts

Lines changed: 0 additions & 143 deletions
This file was deleted.

build/components/dropzone/components/DropzoneFooter.tsx/DropzoneFooter.d.ts

Lines changed: 0 additions & 4 deletions
This file was deleted.

build/components/dropzone/components/DropzoneFooter.tsx/DropzoneFooterProps.d.ts

Lines changed: 0 additions & 4 deletions
This file was deleted.

build/components/dropzone/components/DropzoneHeader/DropzoneHeader.d.ts

Lines changed: 0 additions & 15 deletions
This file was deleted.

build/components/dropzone/components/DropzoneLabel/DropzoneLabel.d.ts

Lines changed: 0 additions & 6 deletions
This file was deleted.

build/components/dropzone/components/DropzoneUI/DropzoneUI.d.ts

Lines changed: 0 additions & 4 deletions
This file was deleted.

build/components/dropzone/components/DropzoneUI/DropzoneUIProps.d.ts

Lines changed: 0 additions & 5 deletions
This file was deleted.

build/components/dropzone/components/hooks/useDropzoneStyles.d.ts

Lines changed: 0 additions & 9 deletions
This file was deleted.

0 commit comments

Comments
 (0)