MazBtnGroup

MazBtnGroup is a component to group multiple MazBtn buttons together with seamless styling. Supports props-based or slot-based rendering with customizable orientation, size, and color.

Before use it, you should install the MazUi plugin in your project, follow instructions in Getting Started

Basic usage with items

Use the items prop to quickly create a button group from an array of button configurations.

<template>
  <MazBtnGroup :items="items" />
</template>

<script lang="ts" setup>
import MazBtnGroup from 'maz-ui/components/MazBtnGroup'
import type { MazButtonGroupOption } from 'maz-ui/components/MazBtnGroup'

const items: MazButtonGroupOption[] = [
  { text: 'Day' },
  { text: 'Week', active: true },
  { text: 'Month' },
]
</script>

Slot-based usage

Use the default slot to pass MazBtn components directly for full control over each button.

<template>
  <MazBtnGroup>
    <MazBtn>Edit</MazBtn>
    <MazBtn :active="true">Save</MazBtn>
    <MazBtn>Delete</MazBtn>
  </MazBtnGroup>
</template>

<script lang="ts" setup>
import MazBtnGroup from 'maz-ui/components/MazBtnGroup'
import MazBtn from 'maz-ui/components/MazBtn'
</script>

Orientation

Use the orientation prop to arrange buttons horizontally (row) or vertically (col).

Row (default)

Column

<template>
  <MazBtnGroup :items="items" orientation="row" />
  <MazBtnGroup :items="items" orientation="col" />
</template>

Sizes

Use the size prop to apply a size to all buttons in the group.

<template>
  <MazBtnGroup :items="items" size="mini" />
  <MazBtnGroup :items="items" size="xs" />
  <MazBtnGroup :items="items" size="sm" />
  <MazBtnGroup :items="items" size="md" />
  <MazBtnGroup :items="items" size="lg" />
  <MazBtnGroup :items="items" size="xl" />
</template>

Colors

Use the color prop to apply a color to all buttons in the group.

<template>
  <MazBtnGroup :items="items" color="primary" />
  <MazBtnGroup :items="items" color="secondary" />
  <MazBtnGroup :items="items" color="info" />
  <MazBtnGroup :items="items" color="success" />
  <MazBtnGroup :items="items" color="warning" />
  <MazBtnGroup :items="items" color="destructive" />
</template>

Button variants

Use the outlined or pastel properties on individual buttons or apply different variants to buttons in the group.

Outlined

<template>
  <MazBtnGroup :items="items" />
</template>

<script lang="ts" setup>
import MazBtnGroup from 'maz-ui/components/MazBtnGroup'
import type { MazButtonGroupOption } from 'maz-ui/components/MazBtnGroup'

const items: MazButtonGroupOption[] = [
  { text: 'Day', outlined: true },
  { text: 'Week', outlined: true },
  { text: 'Month', outlined: true },
]
</script>

Pastel

<template>
  <MazBtnGroup :items="items" />
</template>

<script lang="ts" setup>
import MazBtnGroup from 'maz-ui/components/MazBtnGroup'
import type { MazButtonGroupOption } from 'maz-ui/components/MazBtnGroup'

const items: MazButtonGroupOption[] = [
  { text: 'Day', pastel: true },
  { text: 'Week', pastel: true },
  { text: 'Month', pastel: true },
]
</script>

Slot-based variants

<template>
  <MazBtnGroup>
    <MazBtn outlined>Edit</MazBtn>
    <MazBtn outlined>Save</MazBtn>
    <MazBtn outlined>Delete</MazBtn>
  </MazBtnGroup>

  <MazBtnGroup>
    <MazBtn pastel>Edit</MazBtn>
    <MazBtn pastel>Save</MazBtn>
    <MazBtn pastel>Delete</MazBtn>
  </MazBtnGroup>
</template>

Click handlers

Add click handlers to buttons using the onClick property in items.

<template>
  <MazBtnGroup :items="items" />
</template>

<script lang="ts" setup>
import MazBtnGroup from 'maz-ui/components/MazBtnGroup'
import type { MazButtonGroupOption } from 'maz-ui/components/MazBtnGroup'

const items: MazButtonGroupOption[] = [
  { text: 'Alert', onClick: () => alert('Clicked Alert!') },
  { text: 'Console', onClick: () => console.log('Clicked Console!') },
]
</script>

With icons

Use the leftIcon or rightIcon properties to add icons to buttons.

<template>
  <MazBtnGroup :items="items" />
  <MazBtnGroup :items="iconOnlyItems" />
</template>

<script lang="ts" setup>
import MazBtnGroup from 'maz-ui/components/MazBtnGroup'
import type { MazButtonGroupOption } from 'maz-ui/components/MazBtnGroup'
import { MazArrowLeft, MazArrowRight } from '@maz-ui/icons'

const items: MazButtonGroupOption[] = [
  { text: 'Previous', leftIcon: MazArrowLeft, active: true },
  { text: 'Next', rightIcon: MazArrowRight },
]

const iconOnlyItems: MazButtonGroupOption[] = [
  { icon: MazBars3, color: 'transparent', outlined: true, active: true },
  { icon: MazSquares2x2, color: 'transparent', outlined: true },
]
</script>

With links

Use the href or to properties to create link buttons.

External LinkRouter Link

<template>
  <MazBtnGroup :items="items" />
</template>

<script lang="ts" setup>
import MazBtnGroup from 'maz-ui/components/MazBtnGroup'
import type { MazButtonGroupOption } from 'maz-ui/components/MazBtnGroup'

const items: MazButtonGroupOption[] = [
  { text: 'External Link', href: 'https://maz-ui.com', target: '_blank' },
  { text: 'Router Link', to: { path: '/components/maz-btn' } },
]
</script>

Mixed button styles

Combine different button styles within the same group.

<template>
  <MazBtnGroup :items="items" />
</template>

<script lang="ts" setup>
import MazBtnGroup from 'maz-ui/components/MazBtnGroup'
import type { MazButtonGroupOption } from 'maz-ui/components/MazBtnGroup'

const items: MazButtonGroupOption[] = [
  { text: 'Primary', color: 'primary' },
  { text: 'Success', color: 'success' },
  { text: 'Warning', color: 'warning', outlined: true },
  { text: 'Danger', color: 'destructive', pastel: true },
]
</script>

Types

MazButtonGroupOption

import type { MazBtnProps } from 'maz-ui/components/MazBtn'
import type { RouteLocationRaw } from 'vue-router'

interface MazButtonGroupOption extends Omit<MazBtnProps, 'block'> {
  /** The text of the button */
  text: string
  /** Click handler for the button */
  onClick?: () => void
  /** The href for anchor links */
  href?: string
  /** The route for router-link */
  to?: RouteLocationRaw
}

MazButtonGroupProps

interface MazButtonGroupProps {
  /**
   * The items for the button group (optional when using slot-based approach)
   * @default undefined
   */
  items?: MazButtonGroupOption[]
  /**
   * The orientation of the button group
   * @values 'row' | 'col'
   * @default 'row'
   */
  orientation?: 'row' | 'col'
  /**
   * The size of all buttons (only applies to props-based buttons)
   * @default 'md'
   */
  size?: 'mini' | 'xs' | 'sm' | 'md' | 'lg' | 'xl'
  /**
   * The color of all buttons (only applies to props-based buttons)
   * @default 'primary'
   */
  color?: 'primary' | 'secondary' | 'info' | 'success' | 'warning' | 'destructive' | 'transparent' | 'contrast' | 'accent'
}

Props

Name	Description	Type	Required	Default	Possible values
items	The items for the button group (optional when using slot-based approach)	MazButtonGroupOption[]	No	undefined	-
orientation	The orientation of the button group	"row" | "col"	No	row	row' | 'col
size	The size of all buttons (only applies to props-based buttons)	MazSize	No	md	-
color	The color of all buttons (only applies to props-based buttons)	MazColor	No	primary	-
rounded-size	The rounded size of the buttons	Native type	No	lg	-
outlined	The outlined state of the buttons	boolean	No	false	-
pastel	The pastel state of the buttons	boolean	No	false	-
loading	The loading state of the buttons	boolean	No	false	-
disabled	The disabled state of the buttons	boolean	No	false	-

Slots

Name	Description	Bindings
button-[index]	Custom content for a specific button	item MazButtonGroupOption - The button item index number - The button index
default	Slot for passing MazBtn components directly