Button

Default

Documentation Vuesax Alpha

These docs refer to the Vue 3 support, to see the documents of the previous versions you can do it here 👉 Vuesax (4.0+)

The buttons are a fundamental part of any project, with vuesax you can add a great button with a single line of code

the buttons have all the states as active, focus, hover, to make its implementation simpler and speed up the work

Code Copied

• Template
• Script
• All

<template>
  <div class="center">
    <vs-button :active="active == 0" @click="active = 0"> Active </vs-button>
    <vs-button :active="active == 1" @click="active = 1"> Default </vs-button>
    <vs-button disabled>Disabled</vs-button>
  </div>
</template>

Flat

You can change the full style towards flat of a button with the flat property that its value is a boolean, so just adding it will change the styles

Code Copied

• Template
• Script
• All

<template>
  <div class="center">
    <vs-button type="flat" :active="active == 0" @click="active = 0">
      Active
    </vs-button>
    <vs-button type="flat" :active="active == 1" @click="active = 1">
      Default
    </vs-button>
    <vs-button type="flat" disabled> Disabled </vs-button>
  </div>
</template>

<script setup lang="ts">
import { ref } from 'vue'

const active = ref<number>(0)
</script>

Border

You can change the full style towards border of a button with the border property that its value is a boolean so just adding it will change the styles

Code Copied

• Template
• Script
• All

<template>
  <div class="center">
    <vs-button type="border" :active="active == 0" @click="active = 0">
      Active
    </vs-button>
    <vs-button type="border" :active="active == 1" @click="active = 1">
      Default
    </vs-button>
    <vs-button type="border" disabled> Disabled </vs-button>
  </div>
</template>

<script setup lang="ts">
import { ref } from 'vue'

const active = ref<number>(0)
</script>

<style lang="scss">
* {
  box-sizing: border-box !important;
}
</style>

Gradient

You can change the full style towards Gradient of a button with the gradient property that its value is a boolean, so just adding it will change the styles

Gradient Auto Color

Gradient colors are automatically generated by the color property which in this example is the primary color

Code Copied

• Template
• Script
• All

<template>
  <div class="center">
    <vs-button type="gradient" :active="active == 0" @click="active = 0">
      Active
    </vs-button>
    <vs-button type="gradient" :active="active == 1" @click="active = 1">
      Default
    </vs-button>
    <vs-button type="gradient" disabled> Disabled </vs-button>
  </div>
</template>

<script lang="ts" setup>
import { ref } from 'vue'

const active = ref<number>(0)
</script>

Relief

Change the style of the button to a relief aspect with the relief property, the property is a boolean so you can add it without any value.

Code Copied

• Template
• Script
• All

<template>
  <div class="center">
    <vs-button type="relief" :active="active == 0" @click="active = 0">
      Active
    </vs-button>
    <vs-button type="relief" :active="active == 1" @click="active = 1">
      Default
    </vs-button>
    <vs-button type="relief" disabled> Disabled </vs-button>
  </div>
</template>

<script setup lang="ts">
import { ref } from 'vue'

const active = ref<number>(0)
</script>

Transparent

Change the style of the button with the transparent property, the property is a boolean so you can add it without any value.

Code Copied

• Template
• Script
• All

<template>
  <div class="center">
    <vs-button type="transparent" :active="active == 0" @click="active = 0">
      Active
    </vs-button>
    <vs-button type="transparent" :active="active == 1" @click="active = 1">
      Default
    </vs-button>
    <vs-button type="transparent" disabled> Disabled </vs-button>
  </div>
</template>

<script setup lang="ts">
import { ref } from 'vue'

const active = ref<number>(0)
</script>

Shadow

Change the style of the button with the shadow property, the property is a boolean so you can add it without any value.

Code Copied

• Template
• Script
• All

<template>
  <div class="center">
    <vs-button type="shadow" :active="active == 0" @click="active = 0">
      Active
    </vs-button>
    <vs-button type="shadow" :active="active == 1" @click="active = 1">
      Default
    </vs-button>
    <vs-button type="shadow" disabled> Disabled </vs-button>
  </div>
</template>

<script setup lang="ts">
import { ref } from 'vue'

const active = ref<number>(0)
</script>

Color

Change the color of the Button component with the color property and the color value for example (#fff, rgba (100,10,5) or the main colors of vuesax), this will only affect the component and its value can be dynamic

Valor Permitido

La propiedad color permite los colores principales de vuesax ( Primary(default), Success, danger, warn, dark )
Tambien estan permitidos los colores (RGB y HEX)

Colores Boolean (Opcional)

Ahora puedes usar los colores principales directamente en el componente como un valor Boolean
si quieres que el componente sea de color warn con agregar la propiedad warn al componente ya se cambiara el color

Code Copied

• Template
• Script
• All

<template>
  <div class="center">
    <vs-button :active="active == 0" @click="active = 0"> Default </vs-button>
    <vs-button
      color="success"
      type="flat"
      :active="active == 1"
      @click="active = 1"
    >
      Success
    </vs-button>
    <vs-button
      color="danger"
      type="border"
      :active="active == 2"
      @click="active = 2"
    >
      Danger
    </vs-button>
    <vs-button
      color="warn"
      type="gradient"
      :active="active == 3"
      @click="active = 3"
    >
      Warn
    </vs-button>
    <vs-button
      color="dark"
      type="shadow"
      :active="active == 4"
      @click="active = 4"
    >
      Dark
    </vs-button>
    <vs-button
      color="#7d33ff"
      type="relief"
      :active="active == 5"
      @click="active = 5"
    >
      HEX
    </vs-button>
    <vs-button
      color="rgb(59,222,200)"
      type="gradient"
      :active="active == 6"
      @click="active = 6"
    >
      RGB
    </vs-button>
  </div>
</template>

<script setup lang="ts">
import { ref } from 'vue'

const active = ref<number>(0)

Icon

If you need an icon-only button use the icon property, the property is a boolean so you can add it without any value.

This property makes the button have a specific size making it the same width and height, do not use when it is icon and text

Default Icons

Vuesax does not use any default library or icon source, with this we give you the freedom to use the one you prefer All the components that use a default icon somewhere like the close icon in an Alert or Popup will be an svg for not having to install any type of external font, and it can be replaced with a slot="icon" by the icon of your choice

Vuesax Docs Icons

These documents and examples use the boxicons component library, it is not mandatory or necessary for the use of Vuesax but we recommend it for its wide range of icons and how they visually complement the framework

Code Copied

• Template
• Script
• All

<template>
  <div class="center">
    <vs-button icon :active="active == 0" @click="active = 0">
      <i class="bx bx-home-alt" />
    </vs-button>

    <vs-button
      icon
      color="success"
      type="flat"
      :active="active == 1"
      @click="active = 1"
    >
      <i class="bx bxs-phone-call" />
    </vs-button>

    <vs-button
      icon
      color="danger"
      type="border"
      :active="active == 2"
      @click="active = 2"
    >
      <i class="bx bxs-heart" />>
    </vs-button>

    <vs-button
      icon
      color="warn"
      type="gradient"
      :active="active == 3"
      @click="active = 3"
    >
      <i class="bx bxs-bell-ring" />
    </vs-button>

    <vs-button
      icon
      color="#7d33ff"
      type="relief"
      :active="active == 5"
      @click="active = 5"
    >
      <i class="bx bxs-paper-plane" />
    </vs-button>

    <vs-button
      icon
      color="rgb(59,222,200)"
      type="gradient"
      :active="active == 6"
      @click="active = 6"
    >
      <i class="bx bxs-purchase-tag" />
    </vs-button>
  </div>
</template>

<script setup lang="ts">
import { ref } from 'vue'

Icon - Text

If you need a button with text and icon you can do them by adding them in the slot default.

Code Copied

• Template
• Script
• All

<template>
  <div class="center">
    <vs-button :active="active == 0" @click="active = 0">
      <i class="bx bx-home-alt" /> Home
    </vs-button>

    <vs-button
      color="success"
      type="flat"
      :active="active == 1"
      @click="active = 1"
    >
      <i class="bx bxs-phone-call" /> Call
    </vs-button>

    <vs-button
      color="danger"
      type="border"
      :active="active == 2"
      @click="active = 2"
    >
      <i class="bx bxs-heart" /> Like
    </vs-button>

    <vs-button
      color="warn"
      type="gradient"
      :active="active == 3"
      @click="active = 3"
    >
      <i class="bx bxs-bell-ring" /> Notifications
    </vs-button>

    <vs-button
      color="#7d33ff"
      type="relief"
      :active="active == 5"
      @click="active = 5"
    >
      <i class="bx bxs-paper-plane" /> Send
    </vs-button>

    <vs-button
      color="rgb(59,222,200)"
      type="gradient"
      :active="active == 6"
      @click="active = 6"
    >
      <i class="bx bxs-purchase-tag" /> Save
    </vs-button>
  </div>
</template>

<script setup lang="ts">
import { ref } from 'vue'

Circle

You can completely round the corners with the circle property, the property is a boolean so you can add it without any value.

Code Copied

• Template
• Script
• All

<template>
  <div class="center">
    <vs-button shape="circle" :active="active == 0" @click="active = 0">
      Home
    </vs-button>

    <vs-button
      shape="circle"
      icon
      color="success"
      type="flat"
      :active="active == 1"
      @click="active = 1"
    >
      <i class="bx bxs-phone-call" />
    </vs-button>

    <vs-button
      shape="circle"
      color="danger"
      type="border"
      :active="active == 2"
      @click="active = 2"
    >
      <i class="bx bxs-heart" /> Like
    </vs-button>

    <vs-button
      shape="circle"
      color="warn"
      type="gradient"
      :active="active == 3"
      @click="active = 3"
    >
      Notifications <i class="bx bxs-bell-ring" />
    </vs-button>

    <vs-button
      shape="circle"
      icon
      color="#7d33ff"
      type="relief"
      :active="active == 5"
      @click="active = 5"
    >
      <i class="bx bxs-paper-plane" />
    </vs-button>

    <vs-button
      shape="circle"
      icon
      color="rgb(59,222,200)"
      type="gradient"
      :active="active == 6"
      @click="active = 6"
    >
      <i class="bx bxs-purchase-tag" />
    </vs-button>
  </div>
</template>

<script setup lang="ts">
import { ref } from 'vue'

Square

You can make all the corners completely straight with the Square property, the property is a boolean so you can add it without any value.

Code Copied

• Template
• Script
• All

<template>
  <div class="center">
    <vs-button shape="square" :active="active == 0" @click="active = 0">
      Home
    </vs-button>

    <vs-button
      shape="square"
      icon
      color="success"
      type="flat"
      :active="active == 1"
      @click="active = 1"
    >
      <i class="bx bxs-phone-call" />
    </vs-button>

    <vs-button
      shape="square"
      color="danger"
      type="border"
      :active="active == 2"
      @click="active = 2"
    >
      <i class="bx bxs-heart" /> Like
    </vs-button>

    <vs-button
      shape="square"
      color="warn"
      type="gradient"
      :active="active == 3"
      @click="active = 3"
    >
      Notifications <i class="bx bxs-bell-ring" />
    </vs-button>
    <vs-button
      shape="square"
      icon
      color="#7d33ff"
      type="relief"
      :active="active == 5"
      @click="active = 5"
    >
      <i class="bx bxs-paper-plane" />
    </vs-button>
    <vs-button
      shape="square"
      icon
      color="rgb(59,222,200)"
      type="gradient"
      :active="active == 6"
      @click="active = 6"
    >
      <i class="bx bxs-purchase-tag" />
    </vs-button>
  </div>
</template>

<script setup lang="ts">
import { ref } from 'vue'

Size

Change the size of the entire button including padding, font-size and border with the size property

values:

• xl
• l
• default
• small
• mini

Code Copied

• Template
• Script
• All

<template>
  <div class="center">
    <vs-button size="xl" :active="active == 0" @click="active = 0">
      XLarge
    </vs-button>
    <vs-button size="large" :active="active == 1" @click="active = 1">
      Large
    </vs-button>
    <vs-button :active="active == 2" @click="active = 2"> Default </vs-button>
    <vs-button size="small" :active="active == 3" @click="active = 3">
      Small
    </vs-button>
    <vs-button size="mini" :active="active == 4" @click="active = 4">
      Mini
    </vs-button>
  </div>
</template>

<script setup lang="ts">
import { ref } from 'vue'

const active = ref<number>(0)
</script>

Loading

Now you can add a loading status with the loading property, the property is a boolean so you can add it without any value.

Code Copied

• Template
• Script
• All

<template>
  <div class="center">
    <vs-button loading :active="active == 0" @click="active = 0">
      Home
    </vs-button>

    <vs-button
      loading
      icon
      color="success"
      type="flat"
      :active="active == 1"
      @click="active = 1"
    >
      <i class="bx bxs-phone-call" />
    </vs-button>

    <vs-button
      loading
      color="danger"
      type="border"
      :active="active == 2"
      @click="active = 2"
    >
      <i class="bx bxs-heart" /> Like
    </vs-button>

    <vs-button
      loading
      color="warn"
      type="gradient"
      :active="active == 3"
      @click="active = 3"
    >
      Notifications <i class="bx bxs-bell-ring" />
    </vs-button>

    <vs-button
      loading
      icon
      color="#7d33ff"
      type="relief"
      :active="active == 5"
      @click="active = 5"
    >
      <i class="bx bxs-paper-plane" />
    </vs-button>
    <vs-button
      loading
      icon
      color="rgb(59,222,200)"
      type="gradient"
      :active="active == 6"
      @click="active = 6"
    >
      <i class="bx bxs-purchase-tag" />
    </vs-button>
  </div>
</template>

<script setup lang="ts">
import { ref } from 'vue'

Upload

Now you can add a status of sending or uploading data to the server with the upload property, the property is a boolean so you can add it without any value.

Code Copied

• Template
• Script
• All

<template>
  <div class="center">
    <vs-button upload :active="active == 0" @click="active = 0">
      Home
    </vs-button>

    <vs-button
      upload
      icon
      color="success"
      type="flat"
      :active="active == 1"
      @click="active = 1"
    >
      <i class="bx bxs-phone-call" />
    </vs-button>

    <vs-button
      upload
      color="danger"
      type="border"
      :active="active == 2"
      @click="active = 2"
    >
      <i class="bx bxs-heart" /> Like
    </vs-button>

    <vs-button
      upload
      color="warn"
      type="gradient"
      :active="active == 3"
      @click="active = 3"
    >
      Notifications <i class="bx bxs-bell-ring" />
    </vs-button>

    <vs-button
      upload
      color="dark"
      type="transparent"
      :active="active == 5"
      @click="active = 5"
    >
      Dark
    </vs-button>

    <vs-button
      upload
      icon
      color="#7d33ff"
      type="relief"
      :active="active == 5"
      @click="active = 5"
    >
      <i class="bx bxs-paper-plane" />
    </vs-button>

    <vs-button
      upload
      icon
      color="rgb(59,222,200)"
      type="gradient"
      :active="active == 6"
      @click="active = 6"
    >
      <i class="bx bxs-purchase-tag" />
    </vs-button>
  </div>
</template>

<script setup lang="ts">
import { ref } from 'vue'

Block

You can make the button have the full width allowed with the block property, the property is a boolean so you can add it without any value.

Code Copied

• Template

<template>
  <div class="center">
    <vs-button block>
      <i class="bx bxs-paint-roll" />
      Edit Theme
    </vs-button>
  </div>
</template>

Animate

You can create an animation to the component by adding template ``#animate `and the content will be the one that appears when the component is animated

You can also change the type of animation with the animation-type property and the allowed values ​​are ( vertical, scale, rotate)

Code Copied

• Template

<template>
  <div class="center">
    <vs-button>
      Home
      <template #animate>
        <i class="bx bx-home-alt" />
      </template>
    </vs-button>

    <vs-button type="flat" color="success" animation-type="vertical">
      Message
      <template #animate> <i class="bx bx-mail-send" /> Send </template>
    </vs-button>

    <vs-button
      type="gradient"
      style="min-width: 60px"
      color="warn"
      animation-type="scale"
    >
      <i class="bx bxs-shopping-bag" />
      <template #animate> Store </template>
    </vs-button>

    <vs-button icon type="relief" color="danger" animation-type="rotate">
      <i class="bx bx-like" />
      <template #animate>
        <i class="bx bxs-like" />
      </template>
    </vs-button>
  </div>
</template>

<style lang="scss" scoped>
.center {
  max-width: 400px;
  margin: auto;
}
</style>

Social

Using the colors of social networks is very common in a project either a login button or a share button so Vuesax makes it easy for you to search for each color and just by putting the name of the network you already change the whole style of the component

Supported colors: (facebook, twitter, youtube, pinterest, linkedin, snapchat, whatsapp, tumblr, reddit, spotify, amazon, medium, vimeo, skype, dribbble, slack, yahoo, twitch, discord, telegram, google-plus, messenger)

Code Copied

• Template

<template>
  <div class="center">
    <vs-button icon color="facebook">
      <i class="bx bxl-facebook-square" />
    </vs-button>

    <vs-button icon color="twitter">
      <i class="bx bxl-twitter" />
    </vs-button>

    <vs-button icon color="youtube">
      <i class="bx bxl-youtube" />
    </vs-button>

    <vs-button icon color="linkedin">
      <i class="bx bxl-linkedin" />
    </vs-button>

    <vs-button icon color="whatsapp">
      <i class="bx bxl-whatsapp" />
    </vs-button>

    <vs-button icon color="twitch">
      <i class="bx bxl-twitch" />
    </vs-button>

    <vs-button icon color="medium">
      <i class="bx bxl-medium" />
    </vs-button>

    <vs-button icon color="skype">
      <i class="bx bxl-skype" />
    </vs-button>

    <vs-button icon color="slack">
      <i class="bx bxl-slack-old" />
    </vs-button>

    <vs-button icon color="messenger">
      <i class="bx bxl-messenger" />
    </vs-button>

    <vs-button icon color="tumblr">
      <i class="bx bxl-tumblr" />
    </vs-button>

    <vs-button icon color="dribbble">
      <i class="bx bxl-dribbble" />
    </vs-button>

    <vs-button icon color="google-plus">
      <i class="bx bxl-google-plus" />
    </vs-button>

    <vs-button icon color="vimeo">
      <i class="bx bxl-vimeo" />
    </vs-button>

    <vs-button icon color="pinterest">
      <i class="bx bxl-pinterest" />
    </vs-button>

    <vs-button icon color="spotify">
      <i class="bx bxl-spotify" />
    </vs-button>

    <vs-button icon color="discord">
      <i class="bx bxl-discord" />
    </vs-button>

    <vs-button icon color="amazon">
      <i class="bx bxl-amazon" />
    </vs-button>

    <vs-button icon color="reddit">
      <i class="bx bxl-reddit" />
    </vs-button>
  </div>
</template>

<style lang="scss" scoped>
.center {
  flex-wrap: wrap;
  padding: 20px;
  max-width: 400px;
  margin: auto;
}
</style>

Floating

You can make a float style button easily with the Floating property, the property is a boolean so you can add it without any value.

these buttons usually do an important action in specific and go with a fixed position in the lower corner

Code Copied

• Template

<template>
  <div class="center">
    <vs-button shape="circle" icon type="floating">
      <i class="bx bx-plus" />
    </vs-button>

    <vs-button color="whatsapp" shape="circle" icon type="floating">
      <i class="bx bxl-whatsapp" />
    </vs-button>

    <vs-button color="#ff3e4e" shape="circle" icon type="floating">
      <i class="bx bx-up-arrow-alt" />
    </vs-button>

    <vs-button shape="circle" icon disabled type="floating">
      <i class="bx bxs-chat" />
    </vs-button>
  </div>
</template>

Group

If you need to make a group of buttons you can use the sub-component <vs-button-group> </vs-button-group> and inside the default slot put the buttons you want to group

Code Copied

• Template

<template>
  <div class="center">
    <vs-button-group>
      <vs-button> One </vs-button>
      <vs-button> Two </vs-button>
      <vs-button> Three </vs-button>
      <vs-button> four </vs-button>
    </vs-button-group>

    <span class="divider" />

    <vs-button-group>
      <vs-button flat icon>
        <i class="bx bx-play" />
      </vs-button>
      <vs-button flat icon>
        <i class="bx bx-pause" />
      </vs-button>
      <vs-button flat icon>
        <i class="bx bx-fast-forward" />
      </vs-button>
      <vs-button flat icon>
        <i class="bx bx-shuffle" />
      </vs-button>
    </vs-button-group>

    <span class="divider" />

    <vs-button-group>
      <vs-button border> <i class="bx bxs-pencil" /> Edit </vs-button>
      <vs-button border icon>
        <i class="bx bx-font-color" />
      </vs-button>
      <vs-button border icon>
        <i class="bx bx-align-middle" />
      </vs-button>
      <vs-button border> <i class="bx bx-font-size" /> Font size </vs-button>
    </vs-button-group>

    <span class="divider" />

    <vs-button-group>
      <vs-button relief> <i class="bx bx-home-alt" /> Home </vs-button>
      <vs-button relief> <i class="bx bxs-phone-call" /> Contact </vs-button>
      <vs-button relief loading>
        <i class="bx bxs-cart-alt" /> Products
      </vs-button>
      <vs-button relief upload> <i class="bx bxs-envelope" /> Send </vs-button>
    </vs-button-group>
  </div>
</template>

<style lang="scss" scoped>

Toggle

This is an example of what you can achieve with simple logic and few lines of code.

Code Copied

• Template
• Script
• Style
• All

<template>
  <div class="center">
    <vs-button
      :icon="successMail"
      :upload="sendingMail"
      :color="successMail ? 'success' : 'primary'"
      @click="handleClickMail"
    >
      <span v-if="!successMail">
        <i class="bx bx-mail-send" />
        Send
      </span>

      <i v-else class="bx bx-check" />
    </vs-button>

    <vs-button
      :animate-inactive="successFace"
      :loading="loadingFace"
      color="facebook"
      @click="handleClickFace"
    >
      <i class="bx bxl-facebook-square" />
      {{ successFace ? 'Logout' : 'Facebook' }}
      <template #animate> <i class="bx bx-user" /> Login </template>
    </vs-button>
  </div>
</template>

Ripple New

You can change ripple style of a button with the ripple property and the allowed values are

• reverse
• cut

Code Copied

• Template

<template>
  <div class="center">
    <vs-button> Default </vs-button>
    <vs-button ripple="reverse"> Reverse </vs-button>
    <vs-button ripple="cut"> Cut </vs-button>
  </div>
</template>

API