Skip to content

Commit

Permalink
Merge pull request #14 from OrangeXC/dev
Browse files Browse the repository at this point in the history
Add event README
  • Loading branch information
OrangeXC authored May 17, 2018
2 parents 53a73b5 + 7ca9271 commit 3554419
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) | |
Expand All @@ -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
Expand Down

0 comments on commit 3554419

Please sign in to comment.