|
| 1 | +<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"> |
| 3 | + |
| 4 | +<h1 align="center"> Dropzone</h1> |
| 5 | + |
| 6 | + |
| 7 | +[](https://packagephobia.com/result?p=@unlimited-react-components/react-highlight) |
| 8 | +[](https://david-dm.org/unlimited-react-components/react-highlight) |
| 9 | +[](https://coveralls.io/github/unlimited-react-components/react-highlight?branch=master) |
| 10 | +[](https://travis-ci.org/unlimited-react-components/react-highlight) |
| 11 | +[](https://snyk.io/test/github/unlimited-react-components/react-highlight) |
| 12 | +[](https://lgtm.com/projects/g/unlimited-react-components/react-highlight/alerts/) |
| 13 | +[](https://lgtm.com/projects/g/unlimited-react-components/react-highlight/context:javascript) |
| 14 | + |
| 15 | +</p> |
| 16 | + |
| 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. |
| 18 | + |
| 19 | +## Description |
| 20 | + |
| 21 | +Highlight your JSX code with a react Highlight component. |
| 22 | + |
| 23 | +Sample result: |
| 24 | + |
| 25 | +<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 | +</p> |
| 28 | + |
| 29 | +## Installation |
| 30 | + |
| 31 | +react-highlight is available as an [npm package](https://www.npmjs.com/package/@unlimited-react-components/react-highlight). |
| 32 | + |
| 33 | +```sh |
| 34 | +// with npm |
| 35 | +npm i @unlimited-react-components/react-highlight |
| 36 | +``` |
| 37 | + |
| 38 | +## Usage and examples |
| 39 | + |
| 40 | +Here is a quick example to get you started, **it's all you need**: |
| 41 | + |
| 42 | +[](https://codesandbox.io/s/react-highlight-demo-7o9pq) |
| 43 | + |
| 44 | +# DropZone Components API |
| 45 | + |
| 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 />]() |
| 53 | + |
| 54 | +## DropZone API |
| 55 | + |
| 56 | +### Props |
| 57 | + |
| 58 | +## DropZoneContainer API |
| 59 | + |
| 60 | +### Props |
| 61 | + |
| 62 | +## DropZoneFooter API |
| 63 | + |
| 64 | +### Props |
| 65 | + |
| 66 | +## DropZoneHeader API |
| 67 | + |
| 68 | +### Props |
| 69 | + |
| 70 | +## DropZoneLayer API |
| 71 | + |
| 72 | +### Props |
| 73 | + |
| 74 | +## DropZoneLayer API |
| 75 | + |
| 76 | +### Props and Methods |
| 77 | + |
| 78 | +| Name | Type | Default | Description | |
| 79 | +| ----------- | -------- | -------- | ----------------------------------------------------------------------------- | |
| 80 | +| closeIcon | bool | true | The icon to display in place of the default close icon. | |
| 81 | +| disabled | bool | false | If true, the Dropzone input will be disabled. | |
| 82 | +| fullWidth | bool | false | If true, the Dropzone container will take up the full width of its container. | |
| 83 | +| multiple | bool | false | If true, value must be an array and the Dropzone will support multiple files. | |
| 84 | +| size | 'small' | 'medium' | The size of the Dropzone. | |
| 85 | +| | 'medium' | - | - | |
| 86 | +| | 'large' | - | - | |
| 87 | +| accept | - | - | - | |
| 88 | +| onDragEnter | - | - | - | |
| 89 | +| onDragLeave | - | - | - | |
| 90 | +| onDragOver | - | - | - | |
| 91 | +| onDrop | - | - | - | |
| 92 | +| method | - | - | - | |
| 93 | + |
| 94 | +## License |
| 95 | + |
| 96 | +This project is licensed under the terms of the |
| 97 | +[MIT license](/LICENSE). |
0 commit comments