Button

import { WuiButton } from "@wui/wui-vue/lib/button";

Description

Use WUI's custom wui-button component for actions in forms, dialogs, and more. Includes support for a handful of contextual variations, sizes, states, and more.

Overview

WuiVue's <wui-button> component generates either a <button> element, <a> element, or <router-link> component with the styling of a button.

<div>
  <wui-button>Button</wui-button>
  <wui-button variant="danger">Button</wui-button>
  <wui-button variant="success">Button</wui-button>
  <wui-button variant="primary" :outline="true">Button</wui-button>
</div>

<!-- wui-button.vue -->

Element type

The <wui-button> component generally renders a <button> element. However, you can also render an <a> element by providing an href prop value. You may also generate vue-router <router-link> when providing a value for the to prop (vue-router is required).

<div>
  <wui-button>I am a Button</wui-button>
  <wui-button href="#">I am a Link</wui-button>
</div>

<!-- wui-button-types.vue -->

Type

You can specify the button's type by setting the prop type to 'button', 'submit' or 'reset'. The default type is 'button'.

Note the type prop has no effect when either href or to props are set.

Sizing

Fancy larger or smaller buttons? Specify lg or sm via the size prop.

<wui-row>
  <wui-col lg="4" class="p-b-15"
    ><wui-button size="sm">Small Button</wui-button></wui-col
  >
  <wui-col lg="4" class="p-b-15"
    ><wui-button>Default Button</wui-button></wui-col
  >
  <wui-col lg="4" class="p-b-15"
    ><wui-button size="lg">Large Button</wui-button></wui-col
  >
</wui-row>

<!-- wui-button-sizes.vue -->

Contextual variants

Use the variant prop to generate the various WUI contextual button variants.

By default <wui-button> will render with the secondary variant.

Solid color variants

default, primary, secondary, success, danger, warning, info, light and dark.

<div>
  <wui-button variant="default">Default</wui-button>
  <wui-button variant="primary">Primary</wui-button>
  <wui-button variant="secondary">Secondary</wui-button>
  <wui-button variant="success">Success</wui-button>
  <wui-button variant="danger">Danger</wui-button>
  <wui-button variant="warning">Warning</wui-button>
  <wui-button variant="info">Info</wui-button>
  <wui-button variant="light">Light</wui-button>
  <wui-button variant="dark">Dark</wui-button>
</div>

<!-- wui-button-solid.vue -->

Outline color variants

In need of a button, but not the hefty background colors they bring? Use the outline prop to remove all background images and colors on any <wui-button>:

<div>
  <wui-button variant="default" :outline="true">Default</wui-button>
  <wui-button variant="primary" :outline="true">Primary</wui-button>
  <wui-button variant="secondary" :outline="true">Secondary</wui-button>
  <wui-button variant="success" :outline="true">Success</wui-button>
  <wui-button variant="danger" :outline="true">Danger</wui-button>
  <wui-button variant="warning" :outline="true">Warning</wui-button>
  <wui-button variant="info" :outline="true">Info</wui-button>
  <wui-button variant="light" :outline="true">Light</wui-button>
  <wui-button variant="dark" :outline="true">Dark</wui-button>
</div>

<!-- wui-button-outline.vue -->

Link variant

Variant link will render a button with the appearance of a link while maintaining the default padding and size of a button.

<div>
  <wui-button variant="link">Link</wui-button>
</div>

<!-- wui-button-link.vue -->

Tip: remove the hover underline from a link variant button by adding the WUI utility class text-decoration-none to <wui-button>.

Block level buttons

Create block level buttons — those that span the full width of a parent — by setting the block prop.

<div>
  <wui-button block variant="primary">Block Level Button</wui-button>
</div>

<!-- wui-button-block.vue -->

Disabled state

Set the disabled prop to disable button default functionality. disabled also works with buttons rendered as <a> elements and <router-link> (i.e. with the href or to prop set).

<div>
  <wui-button disabled size="lg" variant="primary">Disabled</wui-button>
  <wui-button disabled size="lg">Also Disabled</wui-button>
</div>

<!-- wui-button-disabled.vue -->

Pressed state and toggling

Buttons will appear pressed (with a darker background, darker border, and inset shadow) when the prop pressed is set to true.

The pressed prop can be set to one of three values:

• true: Sets the .active class and adds the attribute aria-pressed="true".
• false: Clears the .active class and adds the attribute aria-pressed="false".
• null: (default) Neither the class .active nor the attribute aria-pressed will be set.

To create a button that can be toggled between active and non-active states, use the .sync prop modifier (available in Vue 2.3+) on the pressed property

<template>
  <div>
    <h5>Pressed and un-pressed state</h5>
    <wui-button :pressed="true" variant="success">Always Pressed</wui-button>
    <wui-button :pressed="false" variant="success">Not Pressed</wui-button>

    <h5 class="m-t-20">Toggleable Button</h5>
    <wui-button :pressed.sync="myToggle" variant="primary"
      >Toggle Me</wui-button
    >
    <!-- TODO -->
    <p>Pressed State: <strong>{ myToggle }</strong></p>

    <h5>In a button group</h5>
    <wui-button-group size="sm">
      <wui-button
        v-for="(btn, idx) in buttons"
        :key="idx"
        :pressed.sync="btn.state"
        variant="primary"
      >
        { btn.caption }
      </wui-button>
    </wui-button-group>
    <p>Pressed States: <strong>{ btnStates }</strong></p>
  </div>
</template>

<script>
  export default {
    data() {
      return {
        myToggle: false,
        buttons: [
          { caption: "Toggle 1", state: true },
          { caption: "Toggle 2", state: false },
          { caption: "Toggle 3", state: true },
          { caption: "Toggle 4", state: false },
        ],
      };
    },
    computed: {
      btnStates() {
        return this.buttons.map((btn) => btn.state);
      },
    },
  };
</script>

<!-- wui-button-toggles.vue -->

If using toggle button style for a radio or checkbox style interface, it is best to use the built-in button style support of <wui-form-radio-group> and <wui-form-checkbox-group>.

Router link support

Refer to the Router support reference docs for the various supported <router-link> related props.

Accessibility

When the href prop is set to '#', <wui-button> will render a link (<a>) element with attribute role="button" set and appropriate keydown listeners (Enter and Space) so that the link acts like a native HTML <button> for screen reader and keyboard-only users. When disabled, the aria-disabled="true" attribute will be set on the <a> element.

When the href is set to any other value (or the to prop is used), role="button" will not be added, nor will the keyboard event listeners be enabled.

See also

• <wui-link>

Component reference

<wui-button>

Component aliases

<wui-button> can also be used via the following aliases:

• <wui-btn>

Properties

Slots

Events

<wui-button-close>

Component aliases

<wui-button> can also be used via the following aliases:

• <wui-btn-close>

Properties

Slots

Events

Importing individual components

You can import individual components into your project via the following named exports:

Example

import { WuiButton } from "@wui/wui-vue/lib/button";
Vue.component("wui-button", WuiButton);

Importing as a Vue.js plugin

This plugin includes all of the above listed individual components. Plugins also include any component aliases.

Example

import { ButtonPlugin } from "@wui/wui-vue/lib/button";
Vue.use(ButtonPlugin);