nb-button-underline-expand

This is an underline expand button component for Vue.js 3+.

Loading component...

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 NbButtonUnderlineExpand or nb-button-underline-expand.

Mode 1
<template>
  <NbButtonUnderlineExpand />
</template>
Mode 2
<template>
  <nb-button-underline-expand />
</template>
Mode 3
<template>
  <nb-button-underline-expand></nb-button-underline-expand>
</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
displayString'b'Defines the display type. Accepts ib and b.
tabIndexNumber0Defines the tab index. Set this property to make the button focusable by the keyboard.
hasTabIndexEnterBooleantrueEnables the button to be activated with the Enter key when focused.
hasTabIndexSpaceBooleantrueEnables the button to be activated with the Space key when focused.
ariaLabelString'Alternate Text Button'Defines the aria-label attribute for screen readers.
ariaAttrsObject{}Allows passing custom aria attributes as an object. Keys will automatically receive the aria- prefix. Example: { 'describedby': 'help-id', 'invalid': 'false' }
themeString'light'Defines the theme. Accepts dark and light. When theme is set, uses theme-specific color props.
borderHeightNumber1.5Defines the underline height in pixels.
textAlignString'middle'Defines the text alignment. Accepts left, center, right.
widthNumber86Defines button width.
paddingXNumber1Defines button padding-left and padding-right.
paddingYNumber0.2Defines button padding-top and padding-button.
disabledBooleanfalseDefines if the button is disabled
fontFamilyString"'Lato', sans-serif"Defines the font-family
fontSizeString'1.6em'Defines the font-size
fontWeightNumber200Defines the font-weight
lightTextColorString'#333333'Defines the text color for light theme. Accepts Color name and Hex
lightTextColorHoverString'#000000'Defines the text color on hover for light theme. Accepts Color name and Hex
lightBorderColorString'#333333'Defines the underline border color for light theme. Accepts Color name and Hex
lightBorderColorHoverString'#000000'Defines the underline border color on hover for light theme. Accepts Color name and Hex
lightDisabledBgColorString'#dfdfd9'Defines the disabled background color for light theme. Accepts Color name and Hex
darkTextColorString'#ffffff'Defines the text color for dark theme. Accepts Color name and Hex
darkTextColorHoverString'#ffffff'Defines the text color on hover for dark theme. Accepts Color name and Hex
darkBorderColorString'#ffffff'Defines the underline border color for dark theme. Accepts Color name and Hex
darkBorderColorHoverString'#ffffff'Defines the underline border color on hover for dark theme. Accepts Color name and Hex
darkDisabledBgColorString'rgba(40, 42, 54, 1)'Defines the disabled background color for dark theme. Accepts Color name and Hex

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>
  <NbButtonUnderlineExpand
    :nb-id="'nb-button-underline-expand-one'"
    :display="'b'"
    theme="light"
    :borderHeight="1.5"
    textAlign="center"
    :tabIndex="0"
    :hasTabIndexEnter="true"
    :hasTabIndexSpace="true"
    ariaLabel="Botão com underline expandido"
    @clicked="logEvent()"
  >
    <template #content>
      Default Text
    </template>
  </NbButtonUnderlineExpand>
</template>

<script setup>
defineOptions({
  name: 'CompUnderlineExpand',
});

const logEvent = () => {
  console.log('clicked');
};
</script>

Example

Light Theme (default)

<template>
  <NbButtonUnderlineExpand
    nb-id="nb-button-underline-expand-light"
    display="b"
    theme="light"
    light-text-color="#1e40af"
    light-text-color-hover="#000000"
    light-border-color="#93c5fd"
    light-border-color-hover="#60a5fa"
    :border-height="1.5"
    text-align="center"
    :padding-x="1"
    :padding-y="0.2"
    @clicked="logEvent()"
  >
    <template #content>Default Text</template>
  </NbButtonUnderlineExpand>
</template>

<script setup>
defineOptions({
  name: 'CompUnderlineExpand',
});

const logEvent = () => {
  console.log('clicked');
};
</script>

Dark Theme

<template>
  <NbButtonUnderlineExpand
    nb-id="nb-button-underline-expand-dark"
    display="b"
    theme="dark"
    dark-text-color="#a78bfa"
    dark-text-color-hover="#ffffff"
    dark-border-color="#8b5cf6"
    dark-border-color-hover="#7c3aed"
    :border-height="2"
    text-align="center"
    :padding-x="1.5"
    :padding-y="0.4"
    @clicked="logEvent()"
  >
    <template #content>Default Text</template>
  </NbButtonUnderlineExpand>
</template>

<script setup>
defineOptions({
  name: 'CompUnderlineExpandDark',
});

const logEvent = () => {
  console.log('clicked');
};
</script>
Table of Contents