Skip to content

Commit

Permalink
Updating README
Browse files Browse the repository at this point in the history
  • Loading branch information
@johndatserakis
johndatserakis committed Jul 20, 2020
1 parent 536a21e commit b692328
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 16 deletions.
4 changes: 2 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ Sometimes you may want your links to perform an action instead of following a li
| elementId | String | no | A generated uuid | | This value will be set as the `id` of the instance |
| isUsingVueRouter | Boolean | no | false | | If you want to use vue-router, set this to true and all links will automatically be `<router-link></router-link>` |
| mobileBreakpoint | Number | no | 992 | | Width at which the navbar turns into the mobile version |
| brandImagePath | String or Object | no | '/' | | The path for your `brand-image`. If you have `isUsingVueRouter === true`, then this needs to be an `Object` with a `name` property. Otherwise, just provide a `String`. link |
| brandImagePath | String or Object | no | '/' | | Link path of menu-option. If you have `isUsingVueRouter === true`, then this needs to be an `Object` with a `name` property or just a `String` of your path. Otherwise, just provide a `String`. link |
| brandImage | Image | no | | | `require()` your image here to use your brand image |
| brandImageAltText | String | no | 'brand-image' | | The `alt` tag text for your brand image |
| collapseButtonImageOpen | Image | no | A hamburger icon | | `require()` your image here |
Expand All @@ -261,7 +261,7 @@ Sometimes you may want your links to perform an action instead of following a li
| menuOptionsLeft | Object | no | {} | | Menu options that will be _pulled_ to the left towards the `brand-image` |
| menuOptionsLeft.type | String | yes | | 'link', 'button', 'spacer', 'dropdown' | What type of link will this menu-option be? `link` will be a link, `button` will be a button, `spacer` will be a spacer with a width of `30px` , `dropdown` will create a dropdown on desktop and a `ul/li` list on mobile. `dropdown` only works on menuOptions, not subMenuOptions. |
| menuOptionsLeft.text | String | yes | | | Text of menu-option |
| menuOptionsLeft.path | String or Object | yes | | | Link path of menu-option. If you have `isUsingVueRouter === true`, then this needs to be an `Object` with a `name` property. Otherwise, just provide a `String`. Not applicable to `dropdown` menuOption types. |
| menuOptionsLeft.path | String or Object | yes | | | Link path of menu-option. If you have `isUsingVueRouter === true`, then this needs to be an `Object` with a `name` property or just a `String` of your path. Otherwise, just provide a `String`. Not applicable to `dropdown` menuOption types |
| menuOptionsLeft.arrowColor | String | no | | | CSS hex - `#FFF`. This styles the little chevron icon. |
| menuOptionsLeft.class | String | no | | | Only for `menuOptionsLeft.type === 'button'` - provide a class name so you can style your buttons |
| menuOptionsLeft.isLinkAction | Boolean | no | false | | When `true` , the `path` option of the `menuOption` will not fire - instead, you'll be able to register for the `@vnb-item-clicked` event which will spit you out the `text` value of your `menuOption` . That way, you can do an action you may want to trigger. |
Expand Down
28 changes: 14 additions & 14 deletions dist/vue-navigation-bar.css
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit b692328

Please sign in to comment.