From 54bf33da4ad83a27ab089ae6e5fd6f717ca93293 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jose=CC=81=20Ca=CC=81mara?= Date: Thu, 25 Jan 2018 10:27:00 +0100 Subject: [PATCH] * Some changes in the documentation --- docs/docs/en.md | 34 ++++++++++++++++------------------ 1 file changed, 16 insertions(+), 18 deletions(-) diff --git a/docs/docs/en.md b/docs/docs/en.md index f147acd..889ae6c 100644 --- a/docs/docs/en.md +++ b/docs/docs/en.md @@ -143,13 +143,13 @@ This is the first phase of the process. We'll tell the backend that we are going Use the option `startBody` to add more parameters to the body of this request. -The backend will provide a `session_id` (to identify the upload) and a `end_offset` which is the size of every chunk +The backend should provide a `session_id` (to identify the upload) and a `end_offset` which is the size of every chunk #### upload In this phase we'll upload every chunk until all of them are uploaded. This step allows some failures in the backend, and will retry up to `maxRetries` times. -We'll send the `session_id`, `start_chunk` and `chunk` (the sliced blob - part of file we are uploading). We expect the backend to return `status = 'success'`, we'll retry otherwise. +We'll send the `session_id`, `start_chunk` and `chunk` (the sliced blob - part of file we are uploading). We expect the backend to return `{ status: 'success' }`, we'll retry otherwise. Use the option `uploadBody` to add more parameters to the body of this request. @@ -161,6 +161,8 @@ Use the option `finishBody` to add more parameters to the body of this request. #### Example +In the following example we are going to add `Chunk Upload Functionality`. This component will use `Chunk Upload` when the size of the file is > `1MB`, it will behave as the `Simple example` when the size of the file is lower. + ```html ``` - ### chunk-enabled Whether chunk uploads is enabled or not @@ -594,6 +582,8 @@ Whether chunk uploads is enabled or not * **Default:** `false` +* **Browser:** `> IE9` + * **Usage:** ```html @@ -623,6 +613,14 @@ All the options to handle chunk uploads } ``` +* **Browser:** `> IE9` + +* **Usage:** + ```html + + + ``` + ### drop Drag and drop upload @@ -1444,4 +1442,4 @@ Per second upload speed * **Default:** `undefined` -* **Browser:** `= IE9` +* **Browser:** `= IE9` \ No newline at end of file