VBtn API

Props

name	type	default
`active`	boolean	undefined
Controls the active state of the item. This is typically used to highlight the component.
`active-color` New in v3.7.0	string	undefined
The applied color when the component is in an active state.
`append-icon`	\| string \| (string \| [string, number])[] \| (new () => any) \| FunctionalComponent	undefined
Creates a v-icon component after default content in the append slot.
`base-color`	string	undefined
Sets the color of component when not focused.
`block`	boolean	false
Expands the button to 100% of available space.
`border`	string \| number \| boolean	false
Applies utility border classes to the component. To use it, you need to omit the `border-` prefix, (for example use `border-sm` as `border="sm"`). Find a list of the built-in border classes on the borders page.
`color`	string	undefined
Applies specified color to the control - supports utility colors with or without `text-` prefix (for example `success`, `purple` or `text-purple`) or CSS color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the colors page.
`density`	'default' \| 'comfortable' \| 'compact'	'default'
Adjusts the vertical height used by the component.
`disabled`	boolean	false
Removes the ability to click or target the component.
`elevation`	string \| number	undefined
Designates an elevation applied to the component between 0 and 5. You can find more information on the elevation page.
`exact`	boolean	false
Exactly match the link. Without this, ‘/’ will match every route. You can find more information about the exact prop on the vue-router documentation.
`flat`	boolean	false
Removes the button box shadow. This is different than using the ‘flat’ variant.
`height`	string \| number	undefined
Sets the height for the component.
`href`	string	undefined
Designates the component as anchor and applies the href attribute.
`icon`	\| boolean \| string \| (string \| [string, number])[] \| (new () => any) \| FunctionalComponent	false
Apply a specific icon using the v-icon component. The button will become round.
`loading`	string \| boolean	false
Displays linear progress bar. Can either be a String which specifies which color is applied to the progress bar (any material color or theme color - primary, secondary, success, info, warning, error) or a Boolean which uses the component color (set by color prop - if it’s supported by the component) or the primary color.
`location`	Anchor	undefined
Specifies the component’s location. Can combine by using a space separated string.
`max-height`	string \| number	undefined
Sets the maximum height for the component.
`max-width`	string \| number	undefined
Sets the maximum width for the component.
`min-height`	string \| number	undefined
Sets the minimum height for the component.
`min-width`	string \| number	undefined
Sets the minimum width for the component.
`position`	'fixed' \| 'static' \| 'relative' \| 'absolute' \| 'sticky'	undefined
Sets the position for the component.
`prepend-icon`	\| string \| (string \| [string, number])[] \| (new () => any) \| FunctionalComponent	undefined
Creates a v-icon component in the prepend slot before default content.
`readonly` New in v3.6.0	boolean	false
Puts the button in a readonly state. Cannot be clicked or navigated to by keyboard.
`replace`	boolean	false
Setting replace prop will call `router.replace()` instead of `router.push()` when clicked, so the navigation will not leave a history record. You can find more information about the replace prop on the vue-router documentation.
`ripple`	boolean \| { class: string; keys: string[] }	true
Applies the v-ripple directive.
`rounded`	string \| number \| boolean	undefined
Designates the border-radius applied to the component. This can be 0, xs, sm, true, lg, xl, pill, circle, and shaped. Find more information on available border radius classes on the Border Radius page.
`selected-class`	string	undefined
Configure the active CSS class applied when an item is selected.
`size`	string \| number	'default'
Sets the height and width of the component. Default unit is px. Can also use the following predefined sizes: x-small, small, default, large, and x-large.
`slim` New in v3.4.0	boolean	false
Reduces padding to 0 8px.
`spaced` New in v3.10.0	'end' \| 'start' \| 'both'	undefined
Extends content to the edges to move main content from prepend and append slots.
`stacked`	boolean	false
Displays the button as a flex-column.
`symbol`	any	undefined
The Symbol used to hook into group functionality for components like v-btn-toggle and v-bottom-navigation.
`tag`	string \| (new () => any) \| FunctionalComponent	'button'
Specify a custom tag used on the root element.
`text` New in v3.2.0	string \| number \| boolean	undefined
Specify content text for the component.
`theme`	string	undefined
Specify a theme for this component and all of its children.
`tile`	boolean	false
Removes any applied border-radius from the component.
`to`	string \| RouteLocationAsRelativeGeneric \| RouteLocationAsPathGeneric	undefined
Denotes the target route of the link. You can find more information about the to prop on the vue-router documentation.
`value`	any	undefined
The value used when the component is selected in a group. If not provided, a unique ID will be used.
`variant`	'text' \| 'flat' \| 'elevated' \| 'tonal' \| 'outlined' \| 'plain'	'elevated'
Applies a distinct style to the component.
`width`	string \| number	undefined
Sets the width for the component.

Events

name	type
`group:selected`	[{ value: boolean }]
Event that is emitted when an item is selected within a group.

Slots

never

never

never

never

`append`
Adds an item inside the input and after input content.
`default`
The default Vue slot.
`loader`
Slot for custom loader (displayed when loading prop is equal to true).
`prepend`
Adds an item outside the input and before input content.

Exposed

{
  id: string
  isSelected: boolean
  isFirst: boolean
  isLast: boolean
  toggle: () => void
  select: (value: boolean) => void
  selectedClass: false | (string | undefined)[]
  value: unknown
  disabled: boolean | undefined
  group: {
    register: (item: GroupItem, cmp: ComponentInternalInstance) => void
    unregister: (id: string) => void
    select: (id: string, value: boolean) => void
    selected: readonly string[]
    isSelected: (id: string) => boolean
    prev: () => void
    next: () => void
    selectedClass: string | undefined
    items: { id: string; value: unknown; disabled: boolean | undefined }[]
    disabled: boolean | undefined
    getItemIndex: (value: unknown) => number
  }
  register: () => void
  unregister: () => void
}

`group`
Internal representation when used in VBtnToggle.

SASS Variables

name	default
`$button-background`	rgb(var(--v-theme-surface))
`$button-banner-actions-padding`	0 8px
`$button-border`	( $button-border-color, $button-border-style, $button-border-width, $button-border-thin-width )
`$button-border-color`	settings.$border-color-root
`$button-border-radius`	settings.$border-radius-root
`$button-border-style`	settings.$border-style-root
`$button-border-thin-width`	thin
`$button-border-width`	0
`$button-card-actions-padding`	0 8px
`$button-color`	tools.theme-color('on-surface', var(--v-high-emphasis-opacity))
`$button-colored-disabled`	true
`$button-density`	('default': 0, 'comfortable': -2, 'compact': -3)
`$button-disabled-opacity`	0.26
`$button-disabled-overlay`	0.12
`$button-elevation`	('default': 1, 'hover': 2, 'active': 1)
`$button-font-size`	tools.map-deep-get(settings.$typography, 'label-large', 'size')
`$button-font-weight`	tools.map-deep-get(settings.$typography, 'label-large', 'weight')
`$button-height`	36px
`$button-icon-border-radius`	map.get(settings.$rounded, 'circle')
`$button-icon-density`	('default': 3, 'comfortable': 0, 'compact': -2)
`$button-icon-font-size`	1rem
`$button-line-height`	normal
`$button-loader-size`	1.5em
`$button-margin-end`	calc(var(--v-btn-height) / #{$button-margin-end-multiplier})
`$button-margin-end-multiplier`	4.5
`$button-margin-start`	calc(var(--v-btn-height) / #{$button-margin-start-multiplier})
`$button-margin-start-multiplier`	-9
`$button-max-width`	100%
`$button-padding-ratio`	2.25
`$button-pagination-border-radius`	settings.$border-radius-root
`$button-pagination-padding-inline`	5px
`$button-pagination-rounded-border-radius`	map.get(settings.$rounded, 'circle')
`$button-plain-opacity`	.62
`$button-positions`	absolute fixed
`$button-rounded-border-radius`	map.get(settings.$rounded, 'xl')
`$button-sizes`	map.merge( ( 'height': $button-height, 'font-size': $button-font-size, 'width-ratio': $button-width-ratio, 'padding-ratio': $button-padding-ratio ), $button-sizes )
`$button-snackbar-action-padding`	0 8px
`$button-stacked-density`	('default': 0, 'comfortable': -4, 'compact': -6)
`$button-stacked-gap`	4px
`$button-stacked-height`	72px
`$button-stacked-line-height`	1.25
`$button-stacked-padding-ratio`	4.5
`$button-stacked-sizes`	map.merge( ( 'height': $button-stacked-height, 'font-size': $button-font-size, 'width-ratio': $button-stacked-width-ratio, 'padding-ratio': $button-stacked-padding-ratio ), $button-stacked-sizes )
`$button-stacked-width-ratio`	1
`$button-text-letter-spacing`	tools.map-deep-get(settings.$typography, 'label-large', 'letter-spacing')
`$button-text-transform`	none
`$button-transition-property`	box-shadow, transform, opacity, background
`$button-variants`	( $button-background, $button-color, map.get($button-elevation, 'default'), $button-plain-opacity, 'v-btn' )
`$button-vertical-align`	middle
`$button-white-space`	nowrap
`$button-width-ratio`	math.div(16, 9)

#VBtn API

VBtn API