Skip to main content
Version: 5.34.0

Button

The Button component is an interactive element activated by the user. Once activated, it performs an action, such as submitting a form or opening a dialog.

Usage​

Buttons can display text, icons, or both. They can be colored and styled with various options.

<script setup>
  import { MbscButton } from '@mobiscroll/vue';
</script>

<template>
  <MbscButton>Standard button</MbscButton>
  <MbscButton variant="flat">Flat button</MbscButton>
  <MbscButton variant="outline">Outline button</MbscButton>

  <MbscButton startIcon="home">With start icon</MbscButton>
  <MbscButton endIcon="home">With end icon</MbscButton>
  <MbscButton icon="pencil" ariaLabel="Icon only" />

  <MbscButton color="primary">Primary button</MbscButton>
  <MbscButton color="secondary">Secondary button</MbscButton>
  <MbscButton color="success">Success button</MbscButton>
  <MbscButton color="danger">Danger button</MbscButton>
  <MbscButton color="warning">Warning button</MbscButton>
  <MbscButton color="info">Info button</MbscButton>
  <MbscButton color="light">Light button</MbscButton>
  <MbscButton color="dark">Dark button</MbscButton>
</template>

Handling clicks​

Clicks can be handled using the standard @click event.

<script setup>
  import { MbscButton } from '@mobiscroll/vue';

  const handleClick = () => {
    alert('Button clicked!');
  };
</script>

<template>
  <MbscButton @click="handleClick">Click me!</MbscButton>
</template>

Options​

Explore the following API options that help you easily configure the Button component.

ariaLabel​

string

Specifies the accessible name of the button. Recommended for icon-only buttons.

Default value: undefined

color​

"light" | "dark" | "primary" | "secondary" | "success" | "danger" | "warning" | "info"

Specifies the predefined color of the button.

Default value: undefined

cssClass​

string

Specifies a custom CSS class for the component.

Default value: undefined

disabled​

boolean

Specifies the disabled state of the button.

Default value: false

endIcon​

any

Specifies the icon which will be displayed at the end of the button. Use the startIcon option for specifying an icon at the start.

Default value: undefined

icon​

any

Specifies the icon for an icon-only button.

Default value: undefined

startIcon​

any

Specifies the icon which will be displayed at the start of the button. Use the endIcon option for specifying an icon at the end.

Default value: undefined

tabIndex​

number

Specifies the tabindex attribute of the button.

Default value: undefined

theme​

string

Specifies the visual appearance of the component.

If it is 'auto' or undefined, the theme will automatically be chosen based on the platform. If custom themes are also present, they will take precedence over the built in themes, e.g. if there's an iOS based custom theme, it will be chosen on the iOS platform instead of the default iOS theme.

Supplied themes:

  • 'ios' - iOS theme
  • 'material' - Material theme
  • 'windows' - Windows theme

It's possible to modify theme colors or create custom themes.

info

Make sure that the theme you set is included in the downloaded package.

Default value: undefined

themeVariant​

"light" | "dark" | "auto"

Controls which variant of the theme will be used (light or dark).

Possible values:

  • 'light' - Use the light variant of the theme.
  • 'dark' - Use the dark variant of the theme.
  • 'auto' or undefined - Detect the preferred system theme on devices where this is supported.

To use the option with custom themes, make sure to create two custom themes, where the dark version has the same name as the light one, suffixed with '-dark', e.g.: 'my-theme' and 'my-theme-dark'.

Default value: undefined

variant​

"flat" | "standard" | "outline"

Specifies the style of the button.

Default value: 'standard'

Localization​

The Button component is fully localized. This covers date and time format, button copy, rtl and more.

locale​

MbscLocale

Sets the language of the component. The locale object contains all the translations for a given language. The built in language modules are listed below. If a language is not listed, it can be provided as a custom language module.

Supported values:

  • Arabic: localeAr, 'ar'
  • Bulgarian: localeBg, 'bg'
  • Catalan: localeCa, 'ca'
  • Czech: localeCs, 'cs'
  • Chinese: localeZh, 'zh'
  • Croatian: localeHr, 'hr'
  • Danish: localeDa, 'da'
  • Dutch: localeNl, 'nl'
  • English: localeEn or undefined, 'en'
  • English (UK): localeEnGB, 'en-GB'
  • Farsi: localeFa, 'fa'
  • German: localeDe, 'de'
  • Greek: localeEl, 'el'
  • Spanish: localeEs, 'es'
  • Finnish: localeFi, 'fi'
  • French: localeFr, 'fr'
  • Hebrew: localeHe, 'he'
  • Hindi: localeHi, 'hi'
  • Hungarian: localeHu, 'hu'
  • Italian: localeIt, 'it'
  • Japanese: localeJa, 'ja'
  • Korean: localeKo, 'ko'
  • Lithuanian: localeLt, 'lt'
  • Norwegian: localeNo, 'no'
  • Polish: localePl, 'pl'
  • Portuguese (Brazilian): localePtBR, 'pt-BR'
  • Portuguese (European): localePtPT, 'pt-PT'
  • Romanian: localeRo, 'ro'
  • Russian: localeRu, 'ru'
  • Russian (UA): localeRuUA, 'ru-UA'
  • Slovak: localeSk, 'sk'
  • Serbian: localeSr, 'sr'
  • Swedish: localeSv, 'sv'
  • Thai: localeTh, 'th'
  • Turkish: localeTr, 'tr'
  • Ukrainian: localeUa, 'ua'

Default value: undefined

rtl​

boolean

Enables right-to-left display.

Default value: false

Events​

The Button component ships with different event hooks for deep customization. Events are triggered through the lifecycle of the component where you can tie in custom functionality and code.

@destroy​

(args: any, inst: any) => void

Triggered when the component is destroyed.

Parameters:

  • args - The event argument object.

  • inst - The component instance.

@init​

(args: any, inst: any) => void

Triggered when the component is initialized.

Parameters:

  • args - The event argument object.

  • inst - The component instance.

Types​

MbscLocale​

Interface

Properties:

  • allDayText: string
  • amText: string
  • calendarSystem: MbscCalendarSystem
  • cancelText: string
  • clearText: string
  • closeText: string
  • dateFormat: string
  • dateFormatFull: string
  • dateFormatLong: string
  • dateText: string
  • dateWheelFormat: string
  • dayNames: Array<string>
  • dayNamesMin: Array<string>
  • dayNamesShort: Array<string>
  • daySuffix: string
  • dayText: string
  • eventText: string
  • eventsText: string
  • filterEmptyText: string
  • filterPlaceholderText: string
  • firstDay: number
  • fromText: string
  • hourText: string
  • minuteText: string
  • monthNames: Array<string>
  • monthNamesShort: Array<string>
  • monthSuffix: string
  • monthText: string
  • moreEventsPluralText: string
  • moreEventsText: string
  • nextMonthText: string
  • nextYearText: string
  • noEventsText: string
  • nowText: string
  • pmText: string
  • prevMonthText: string
  • prevYearText: string
  • rangeEndHelp: string
  • rangeEndLabel: string
  • rangeStartHelp: string
  • rangeStartLabel: string
  • rtl: boolean
  • secondText: string
  • selectedPluralText: string
  • selectedText: string
  • setText: string
  • timeFormat: string
  • timeText: string
  • timeWheels: string
  • toText: string
  • todayText: string
  • weekText: string
  • yearSuffix: string
  • yearText: string