@jurajkavka/vue-hamburger-button

1.0.6 • Public • Published

🍔 vue-hamburger-button 🍔

Yes, it is just the hamburger button, taken from W3C article How TO - Menu Icon. This is its animated version.

Preview

If You want to see button in action, check the mentioned W3C tutorial, or install this project locally. It's as simple as to run these commands:

git clone https://github.com/JurajKavka/vue-hamburger-button.git
cd vue-hamburger-button
npm install
npm run serve

There are another commands for developers (please, inspect package.json too):

npm run lint
npm run test
npm run build

Installation and usage

You can install this component from npm with npm or yarn.

npm install @jurajkavka/vue-hamburger-button

or

yarn add @jurajkavka/vue-hamburger-button

Example app

This is very simple example of using HamburgerButton. Please, inspect the source code of the component and styles, to see its props, how to styles are composed and how they can be customized.

NOTE: Even the default-theme has to be imported manually.

<template>
  <div id="app">
    <HamburgerButton
      :is-hamburger="true"
      theme="my-custom-theme"
      @click="onClick($event)"
    />
    {{ isHamburger ? 'Hamburger' : 'Cross' }}
  </div>
</template>

<script>
import HamburgerButton from 'vue-hamburger-button'

export default {
  name: 'app',
  components: {
    HamburgerButton
  },
  data () {
    return {
      isHamburger: true
    }
  },
  methods: {
    onClick(isInHamburgerState){
      this.isHamburger = isInHamburgerState
    }
  }
}
</script>

<style lang="scss">
/* Styles (themes) are not bundled within component itself. They must be specified 
manually, even the 'default-theme', which is part of npm package. */
@import 'vue-hamburger-button/src/scss/default-theme.scss';

/* This example of customization extends default-theme. You can also copy whole
default-theme to new file and customize size of the button, thickness of the bars etc. */
.my-custom-theme {
  @extend .default-theme;

  .bar1, .bar2, .bar3 {
    background-color: red;
  }
}
</style>

Component props

  • isHamburger: true, if initial state of the button is hamburger, or false if the initial state is cross. Default is true.
  • theme: Name of the root class of your customized style. Default value is default-theme.

Component events

  • onClick(isInHamburgerState): event on mouse click, with argument, if the button is in hamburger or in cross state.

Component customization

See the example app how to customize styles, but basically, it is about to have one root class, that will be passed to theme parameter of component. For example, you can copy whole src/scss/default-theme.scss to a new file, rename root class .default-theme and make needed customization there. But do not change the names of the subclasses! For another example, check src/scss/big-red-hamburger.scss file.

NOTE: If You change height (thickness) of the bars, animation will not play very well. You will need to customize translate attribute of the transform property. I don't have exact recepie, how to set those values. I'm doing it just simple with try and error method and it works well.

TODO

  • technically this is a clickable div and no button. I'm not very happy with it.

Package Sidebar

Install

npm i @jurajkavka/vue-hamburger-button

Weekly Downloads

57

Version

1.0.6

License

MIT

Unpacked Size

20.8 kB

Total Files

8

Last publish

Collaborators

  • juray