Skip to content

Commit

Permalink
Add undocumented props to DropZone docs (#15223)
Browse files Browse the repository at this point in the history
  • Loading branch information
nosolosw authored Apr 29, 2019
1 parent 87d7fe4 commit efd4e8a
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions packages/components/src/drop-zone/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,20 @@ const MyDropZone = withState( {

The component accepts the following props:

### className

A CSS `class` to be _appended_ after the default `components-drop-zone` class.

- Type: `String`
- Default: `undefined`

### label

A string to be shown within the drop zone area.

- Type: `String`
- Default: `Drop files to upload`

### onFilesDrop

The function is called when dropping a file into the `DropZone`. It receives two arguments: an array of dropped files and a position object which the following shape: `{ x: 'left|right', y: 'top|bottom' }`. The position object indicates whether the drop event happened closer to the top or bottom edges and left or right ones.
Expand Down

0 comments on commit efd4e8a

Please sign in to comment.