v2.0.0-beta

Author: lian-yue

README.md

@@ -8,8 +8,9 @@
 ## Install
 
 ``` bash
-    npm install vue-upload-component --save
+    npm install vue-upload-component@next --save
 ```
+
 ### CommonJS
 ```js
     var FileUpload = require('vue-upload-component');
@@ -73,93 +74,119 @@ npm run build
 ```
 
 
-## $dispatch, methods
-    addFileUpload
 
-    removeFileUpload
+# Setting
 
-    fileUploadProgress
 
-    beforeFileUpload
+## Props
+``` html
+<file-upload
+    title="Add upload files"
 
-    afterFileUpload
+    name="post file name"
 
+    drop="Boolean (true = $parent) or Element or Css Selector"
 
+    extensions="Array or String or Regular"
 
+    post-action="./post.method"
 
-## Setting
+    put-action="./put.method"
 
-### Data
-``` js
-    {
-        files: [
-            {
-                id: 'String', // Read only
-                name: 'filename String',
-                size: 'filesize   Number',
-                progress: 'progress String', // Read only
-                speed: "Speed Number", // Read only
-                active: 'active Boolean',
-                error: 'error String',
-                errno: 'errno String',
-                success: 'success Boolean', // Read only
-                data: 'Response data Object or String', // Read only
-                request: {
-                    headers: {
-                        "X-Csrf-Token": "xxxx",
-                    },
-                    data: {
-                        "_csrf_token": "xxxxxx",
-                    },
-                },
-            }
-        ],
+    accept="accept"
 
+    multiple="true or false"
 
-        // Global
-        request: {
-            headers: {
-                "X-Csrf-Token": "xxxx",
-            },
-            data: {
-                "_csrf_token": "xxxxxx",
-            },
-        },
+    size="max Size"
 
+    timeout="3600000"
 
-        active: false,
+    events="Object"
 
-        uploaded: true,  // Read only
+    headers="Request headers object"
 
-        dropActive: false,  // Read only
-    }
+    data="Request data object"
+
+    files="Upload files"
+    >
+</file-upload>
 ```
 
 
-### Props
-``` html
-    <file-upload :title="Add upload files" :name="file" :drop="Boolean (true = $parent) or Element or Css Selector" :extensions="Array or String or Regular" :post-action="./post.method" :put-action="./put.method" :accept="accept"  :multiple="true" :size="size" :timeout="3600000"></file-upload>
-```
 
+
+### Props events
+``` js
+    events: {
+        add(file, component) {
+            console.log('add');
+            if (this.auto) {
+                component.active = true;
+            }
+            file.headers['X-Filename'] = encodeURIComponent(file.name)
+            file.data.finename = file.name
+
+            // file.putAction = 'xxx'
+            // file.postAction = 'xxx'
+        },
+        progress(file, component) {
+            console.log('progress ' + file.progress);
+        },
+        after(file, component) {
+            console.log('after');
+        },
+        before(file, component) {
+            console.log('before');
+        }
+    }
 ```
-    title="Add upload files"
 
-    name="post file name"
 
-    drop="Boolean (true = $parent) or Element or Css Selector"
 
-    extensions="Array or String or Regular" :post-action="./post.method"
+### Props files
+``` js
+    [
+        {
+            id: 'String', // Read only
+            name: 'filename String',
+            size: 'filesize   Number',   // -1  = html4
+            progress: 'progress String', // Read only
+            speed: "Speed Number", // Read only
+            active: 'active Boolean',   // set active = fasle  abort upload
+            error: 'error String',  // Read only
+            success: 'success Boolean', // Read only
+            data: 'Response data Object or String', // Read only
+            putAction: 'String uri',
+            postAction: 'String uri',
+            timeout: "Number",
+            headers: {
+                "X-Csrf-Token": "xxxx",
+            },
+            data: {
+                "_csrf_token": "xxxxxx",
+            },
+
+            xhr: "False or XMLHttpRequest object",             // html5
+            iframe: "False or Element object",  // html4
+            file: "undefined or File object"               // html5
+            el: "undefined or Input object"
+        }
+    ]
+```
 
-    post-action="./post.method"
 
-    put-action="./put.method"
 
-    accept="accept"
 
-    multiple="true or false"
 
-    size="max Size"
+## data
+``` js
+    {
+        mode: 'html5',  // html5 or html4
 
-    timeout="3600000"
+        active: false,   // set active = fasle  abort upload
 
+        uploaded: true,  // Read only
+
+        dropActive: false,  // Read only
+    }
 ```