From 7ca9271b992e425855f56c216df6cc34af97a373 Mon Sep 17 00:00:00 2001 From: OrangeXC <842012622@qq.com> Date: Thu, 17 May 2018 13:24:48 +0800 Subject: [PATCH] Add event README --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7becb6e..8aaf116 100644 --- a/README.md +++ b/README.md @@ -38,9 +38,10 @@ Vue.component('coverflow', coverflow) ### Options +#### Attributes You can set them to your data function -| protype | type | description | example | +| Attribute | Type | Description | Example | | :------------- |:-------------|:---------------| :------ | | coverList | Array | Each object contains two elements, cover is image's url, title will be showed on the bottom of cover(required: true) | [{ cover: '', title: ''}] | | width | Number | width of coverflow(default: 980) | | @@ -52,6 +53,12 @@ You can set them to your data function | coverShadow | Boolean | reflection effect, total height will be changed to two times (default: false) | | | coverFalt | Boolean | disable 3D rotation(default: false) | | +#### Events + +| Event Name | description | Parameters | +| :------------- |:---------------| :--------- | +| change | triggers when the selected cover changes | the index of the curent cover | + ### Develop ```bash