nb-button-hamburger

This is a hamburger button component for Vue.js 3+.

Look at the console to see the triggered event

Installation

Yarn
yarn add @vlalg-nimbus/nb-buttons
NPM
npm install @vlalg-nimbus/nb-buttons

Usage

Vue 3
import { createApp } from 'vue'
import App from './App.vue'

import NbButtonsComponents from '@vlalg-nimbus/nb-buttons'
import "@vlalg-nimbus/nb-buttons/dist/style.css";

const app = createApp(App)
app.use(NbButtonsComponents)
app.mount('#app')
Nuxt 3
import NbButtonsComponents from '@vlalg-nimbus/nb-buttons'
import "@vlalg-nimbus/nb-buttons/dist/style.css";

export default defineNuxtPlugin(context => {
  context.vueApp.use(NbButtonsComponents)
})

To use, simply call the component, in this case it will be NbButtonHamburger or nb-button-hamburger.

Mode 1
<template>
  <NbButtonHamburger />
</template>
Mode 2
<template>
  <nb-button-hamburger />
</template>
Mode 3
<template>
  <nb-button-hamburger></nb-button-hamburger>
</template>

Preview & Playground

Select the component you want to edit/test

Loading Sandbox...

Props

Items with an (*) mean they are required

nameValue typeDefaultDescription
nbId (*)StringSets the id attribute to differentiate from other components
statusBooleanfalseDefines the button status (clicked/unclicked)
colorString'#ffffff'Defines the icon color. Accepts Color name and Hex
colorHoverString'yellow'Defines the icon color on hover. Accepts Color name and Hex
containerColorString'#333333'Defines the background color. Accepts Color name and Hex
containerColorHoverString'red'Defines the background color on hover. Accepts Color name and Hex
paddingXNumber3Defines button padding-left and padding-right.
paddingYNumber3Defines button padding-top and padding-button.
disabledBooleanfalseDefines if the button is disabled

Events

nameReturn typeDescription
clickednothingFired when the button is clicked, returns nothing.

Slot

The component has a slot called content where the content that will be manipulated must be passed. It has a default text (Default Text) in case the content does not pass through the slot.

<template>
  <NbButtonHamburger
    :nb-id="'nb-button-hamburger-one'"
    :display="'b'"
  >
    <template #text>
      Default Text
    </template>
  </NbButtonHamburger>
</template>