Skip to content

Commit

Permalink
v1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
mbj36 committed Sep 4, 2018
1 parent c61d009 commit 551ec2c
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 1 deletion.
39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,45 @@ ATTENTION - the below animations are in WIP
* elastic
* bubble

### Properties

Some animation require certain other elements on your page

* Page wrapper - an element wrapping the rest of the content on yur page, placed after the menu component

```javascript
<Menu/>

<main id="page-wrap">

</main>

```

* Outer container called `app` - an element containing everything including the menu component

```javascript
<div id="app">

<Menu/>
<main id="page-wrap">
.
.
.
</main>
```

Check this table to see which animations require these elements:

Animation | `pageWrapId` | `appId`
--- | :---: | :---:
`slide` | |
`push` | &#x2713; | &#x2713;
`pushRotate` | &#x2713; | &#x2713;
`scaleDown` | &#x2713; | &#x2713;
`scaleRotate` | &#x2713; | &#x2713;
`reveal` | &#x2713; | &#x2713;

### Position

The menu opens from left by default. To have it open from the right, use the `right` prop. It's just a boolean so you don't need to specify a value.
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-burger-menu",
"version": "0.0.9",
"version": "1.0.0",
"private": false,
"scripts": {
"serve": "vue-cli-service serve",
Expand Down
3 changes: 3 additions & 0 deletions src/components/Menu.vue
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,9 @@
</script>

<style>
html {
height: 100%;
}
.bm-burger-button {
position: fixed;
width: 36px;
Expand Down

0 comments on commit 551ec2c

Please sign in to comment.