Skip to content

Commit df18d59

Browse files
committed
[REFACTOR]: Improve Readme.md and add some dummy unit tests
1 parent 802b319 commit df18d59

30 files changed

Lines changed: 310 additions & 119 deletions

File tree

README.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,30 @@
11
<p align="center">
2-
<img align="center" height="150" src="https://user-images.githubusercontent.com/43678736/118854376-49f1f480-b89a-11eb-91f6-a0f59c30c6c4.png" alt="Unlimited React components logologo">
2+
<img align="center" height="150" src="https://user-images.githubusercontent.com/43678736/132112022-0ca409ae-cca2-43c8-be89-110376260a3f.png" alt="dropone-ui-logo">
33

4-
<h1 align="center"> Dropzone</h1>
5-
6-
![npm latest package](https://img.shields.io/badge/npm%40last-1.3.1-cyan)
7-
[![install size](https://packagephobia.com/badge?p=@unlimited-react-components/react-highlight)](https://packagephobia.com/result?p=@unlimited-react-components/react-highlight)
8-
[![dependencies Status](https://status.david-dm.org/gh/unlimited-react-components/react-highlight.svg)](https://david-dm.org/unlimited-react-components/react-highlight)
9-
[![Coverage Status](https://coveralls.io/repos/github/unlimited-react-components/react-highlight/badge.svg?branch=master)](https://coveralls.io/github/unlimited-react-components/react-highlight?branch=master)
10-
[![Build Status](https://travis-ci.org/unlimited-react-components/react-highlight.svg?branch=master)](https://travis-ci.org/unlimited-react-components/react-highlight)
11-
[![Known Vulnerabilities](https://snyk.io/test/github/unlimited-react-components/react-highlight/badge.svg)](https://snyk.io/test/github/unlimited-react-components/react-highlight)
12-
[![Total alerts](https://img.shields.io/lgtm/alerts/g/unlimited-react-components/react-highlight.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/unlimited-react-components/react-highlight/alerts/)
13-
[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/unlimited-react-components/react-highlight.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/unlimited-react-components/react-highlight/context:javascript)
4+
<h1 align="center"> Dropzone UI </h1>
145

156
</p>
167

17-
If you have any issue or suggestion, or wanna improve the repo adding other languages highlights, let me know it on the github section: "[issues](https://github.com/unlimited-react-components/react-highlight/issues)", or make a pull request.
8+
[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/dropzone-ui/dropzone-ui/blob/HEAD/LICENSE)
9+
[![npm latest package](https://img.shields.io/npm/v/dropzone-ui.svg?logo=npm&logoColor=fff&label=NPM+package&color=limegreen)](https://www.npmjs.com/package/dropzone-ui)
10+
[![npm latest package](https://img.shields.io/badge/npm%40LTS-1.0.5-magenta)](https://www.npmjs.com/package/dropzone-ui)
11+
[![dependencies Status](https://status.david-dm.org/gh/dropzone-ui/dropzone-ui.svg)](https://david-dm.org/dropzone-ui/dropzone-ui)
12+
[![Build Status](https://www.travis-ci.com/dropzone-ui/dropzone-ui.svg?branch=master)](https://www.travis-ci.com/dropzone-ui/dropzone-ui)
13+
[![install size](https://packagephobia.com/badge?p=dropzone-ui)](https://packagephobia.com/result?p=@unlimited-react-components/material-button)
14+
[![Coverage Status](https://coveralls.io/repos/github/dropzone-ui/dropzone-ui/badge.svg?branch=master)](https://coveralls.io/github/unlimited-react-components/material-button?branch=master)
15+
[![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/)
16+
[![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)
17+
[![Known Vulnerabilities](https://snyk.io/test/github/dropzone-ui/dropzone-ui/badge.svg)](https://snyk.io/test/github/unlimited-react-components/material-button)
18+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
1819

1920
## Description
2021

21-
Highlight your JSX code with a react Highlight component.
22+
Dropzone components for mamanging file uploads. Components were made folllowing some of google's Material design principles.
2223

2324
Sample result:
2425

2526
<p align="center">
26-
<img align="center" width="65%" src="https://user-images.githubusercontent.com/43678736/119084603-b74f7380-b9c7-11eb-8ea3-752cf72098e5.png" alt="Sample result image">
27+
<!-- <img align="center" width="65%" src="https://user-images.githubusercontent.com/43678736/119084603-b74f7380-b9c7-11eb-8ea3-752cf72098e5.png" alt="dropzone-uisamle-screenshot"> -->
2728
</p>
2829

2930
## Installation
@@ -43,35 +44,34 @@ Here is a quick example to get you started, **it's all you need**:
4344

4445
# DropZone Components API
4546

46-
- [\<Dropzone />](#dropzone-api)
47-
- [\<DropzoneBody />](#dropzonecontainer-api)
48-
- [\<DropzoneContainer />](#dropzonecontainer-api)
49-
- [\<DropZoneFooter />](#dropzonefooter-api)
50-
- [\<DropZoneLayer />](#dropzonelayer-api)
51-
- [\<DropZoneHeader />](#dropzoneheader-api)
52-
- [\<TablePagination />]()
47+
- [\<DropzoneUI />](#dropzoneui-api)
48+
- [\<DropzoneLabel />](#dropzonelabel-api)
49+
- [\<FileItem />](#fileitem-api)
50+
- [\<FileList />](#filelist-api)
51+
- [\<ImageFullScreen />](#imagefullscreen-api)
52+
- [\<InputButton />](#inputbutton-api)
5353

54-
## DropZone API
54+
## DropzoneUI API
5555

5656
### Props
5757

58-
## DropZoneContainer API
58+
## DropzoneLabel API
5959

6060
### Props
6161

62-
## DropZoneFooter API
62+
## FileItem API
6363

6464
### Props
6565

66-
## DropZoneHeader API
66+
## FileList API
6767

6868
### Props
6969

70-
## DropZoneLayer API
70+
## ImageFullScreen API
7171

7272
### Props
7373

74-
## DropZoneLayer API
74+
## InputButton API
7575

7676
### Props and Methods
7777

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,5 +100,13 @@ export interface DropzoneProps extends OverridableProps {
100100
* "1rem"
101101
*/
102102
maxHeight?: string;
103+
/**
104+
* if true, shows the dropzone footer
105+
*/
106+
footer?: boolean;
107+
/**
108+
* if true, shows the dropzone footer
109+
*/
110+
header?: boolean;
103111
}
104112
export declare const DropzonePropsDefault: DropzoneProps;
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
import { FC } from "react";
21
import "./FileList.scss";
2+
import { FC } from "react";
33
import { FileListProps } from "./FileListProps";
44
declare const FileList: FC<FileListProps>;
55
export default FileList;

build/index.d.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,5 @@ export { default as FileList } from "./components/file-item/components/FileList/
88
export * from "./components/file-item/components/FileList/FileList";
99
export { default as ImageFullScreen } from "./components/image-preview/ImageFullScreen";
1010
export * from "./components/image-preview/ImageFullScreen";
11+
export { default as InputButton } from "./components/input-button/InputButton";
12+
export * from "./components/input-button/InputButton";

build/index.es.js

Lines changed: 33 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

build/index.es.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

build/index.js

Lines changed: 33 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

build/index.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

jest.config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
module.exports = {
2-
roots: ["<rootDir>/src/tests"],
2+
roots: ["<rootDir>/tests"],
33
transform: {
44
"^.+\\.tsx?$": "ts-jest",
55
},

package-lock.json

Lines changed: 9 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)