Skip to content
This repository has been archived by the owner on Jan 29, 2019. It is now read-only.

Commit

Permalink
feat(docs): quick slots explanation
Browse files Browse the repository at this point in the history
  • Loading branch information
alexsasharegan committed Sep 16, 2017
1 parent 169d6e6 commit 1947dd1
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,28 @@ Also, a special File class has been written (`VTransmitFile`) to add useful info
|`max-files-reached`| `VTransmitFile[]` | Fired when the total accepted files on the instance exceeds the max files prop. |
|`queue-complete`| `VTransmitFile` | Fired once all added files have uploaded and the queue has been flushed. |

## Slots

### Default (`$slots.default`)

The default slot should contain your markup for getting an upload started. This could be a file uploader button and/or a dropzone.

### Files (Scoped, `$slots.files`)

This slot receives a number of props:

```ts
{
files: VTransmitFile[],
acceptedFiles: VTransmitFile[],
rejectedFiles: VTransmitFile[],
addedFiles: VTransmitFile[],
queuedFiles: VTransmitFile[],
uploadingFiles: VTransmitFile[],
activeFiles: VTransmitFile[]
}
```

## `VTransmitFile`

```json
Expand Down

0 comments on commit 1947dd1

Please sign in to comment.