Skip to content

Commit

Permalink
Add event documentation - closes DannyFeliz#9
Browse files Browse the repository at this point in the history
  • Loading branch information
DannyFeliz committed Apr 6, 2019
1 parent e95f580 commit d2e419e
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 1 deletion.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,29 @@
</tbody>
</table>


## Events

<table>
<thead>
<tr>
<th>Event</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>show</td>
<td>When content goes from being hidden to visible</td>
</tr>
<tr>
<td>hide</td>
<td>When content goes from being visible to hidden</td>
</tr>

</tbody>
</table>

## Usage
```vue
<template>
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "vue-timed-content",
"version": "0.1.2",
"version": "0.1.3",
"main": "./dist/vue-timed-content.umd.min.js",
"files": [
"dist/vue-timed-content.umd.min.js"
Expand Down

0 comments on commit d2e419e

Please sign in to comment.