Button

Button is an interactive component that allows users to perform actions such as submitting forms and toggling modals.

<Button>Button</Button>

Usage

import { Button, ButtonGroup } from "@yamada-ui/react"

import { Button, ButtonGroup } from "@/components/ui"

import { Button, ButtonGroup } from "@workspaces/ui"

<Button />

<ButtonGroup.Root>
  <ButtonGroup.Item />
</ButtonGroup.Root>

Change Variant

<Wrap gap="md">
  <For each={["solid", "subtle", "surface", "outline", "ghost"]}>
    {(variant, index) => (
      <Button variant={variant} key={index}>
        {toTitleCase(variant)}
      </Button>
    )}
  </For>
</Wrap>

Change Size

<Wrap gap="md">
  <For each={["xs", "sm", "md", "lg", "xl"]}>
    {(size, index) => (
      <Button size={size} key={index} minW="24">
        {toTitleCase(size)}
      </Button>
    )}
  </For>
</Wrap>

Change Color Scheme

<Wrap gap="md">
  <For each={["success", "warning"]}>
    {(colorScheme, index) => (
      <Button colorScheme={colorScheme} key={index}>
        {toTitleCase(colorScheme)}
      </Button>
    )}
  </For>
</Wrap>

Change Shape

To rounded corners, set fullRounded to true.

<Wrap gap="md">
  <For each={["solid", "subtle", "surface", "outline", "ghost"]}>
    {(variant, index) => (
      <Button variant={variant} key={index} fullRounded>
        Button
      </Button>
    )}
  </For>
</Wrap>

Disable

To disable, set disabled to true.

<Wrap gap="md">
  <For each={["solid", "subtle", "surface", "outline", "ghost"]}>
    {(variant, index) => (
      <Button variant={variant} key={index} disabled>
        Button
      </Button>
    )}
  </For>
</Wrap>

Add Icon

To add an icon, set a ReactNode to startIcon or endIcon.

<Wrap gap="md">
  <Button variant="solid" startIcon={<PlusIcon />}>
    Button
  </Button>

  <Button variant="subtle" endIcon={<ArrowRightIcon />}>
    Button
  </Button>

  <Button variant="surface" startIcon={<MailIcon />}>
    Button
  </Button>

  <Button variant="outline" endIcon={<CheckIcon />}>
    Button
  </Button>

  <Button variant="ghost" startIcon={<XIcon />}>
    Button
  </Button>
</Wrap>

Use Loading Animation

To use a loading animation, set loading to true. If you want to change the text during loading, use loadingMessage.

<Wrap gap="md">
  <Button loading>Button</Button>

  <Button variant="subtle" loading loadingIcon="dots">
    Button
  </Button>

  <Button variant="surface" loading loadingIcon={<Loading.Puff />}>
    Button
  </Button>

  <Button variant="outline" loading loadingMessage="Loading...">
    Button
  </Button>

  <Button
    variant="ghost"
    loading
    loadingIcon="grid"
    loadingMessage="Loading..."
    loadingPlacement="end"
  >
    Button
  </Button>
</Wrap>

The loading for Button internally uses Loading.

Grouping

<VStack>
  <ButtonGroup.Root attached variant="outline">
    <ButtonGroup.Item>Button</ButtonGroup.Item>
    <ButtonGroup.IconItem icon={<PlusIcon />} />
  </ButtonGroup.Root>

  <Wrap gap="md">
    <ButtonGroup.Root>
      <ButtonGroup.Item>Button</ButtonGroup.Item>
      <ButtonGroup.Item>Button</ButtonGroup.Item>
      <ButtonGroup.Item>Button</ButtonGroup.Item>
    </ButtonGroup.Root>

    <ButtonGroup.Root attached disabled variant="outline">
      <ButtonGroup.Item>Button</ButtonGroup.Item>
      <ButtonGroup.Item>Button</ButtonGroup.Item>
      <ButtonGroup.Item>Button</ButtonGroup.Item>
    </ButtonGroup.Root>
  </Wrap>

  <Wrap gap="md">
    <ButtonGroup.Root orientation="vertical">
      <ButtonGroup.Item>Button</ButtonGroup.Item>
      <ButtonGroup.Item>Button</ButtonGroup.Item>
      <ButtonGroup.Item>Button</ButtonGroup.Item>
    </ButtonGroup.Root>

    <ButtonGroup.Root orientation="vertical" attached variant="outline">
      <ButtonGroup.Item>Button</ButtonGroup.Item>
      <ButtonGroup.Item>Button</ButtonGroup.Item>
      <ButtonGroup.Item>Button</ButtonGroup.Item>
    </ButtonGroup.Root>
  </Wrap>
</VStack>

Props

Button

Prop	Default	Type / Description
`as`	-	`As` The HTML element to render.
`asChild`	-	`boolean` Merges its props onto its immediate child.
`css`	-	`CSSObject \| CSSObject[]` The CSS object.
`colorScheme`	-	`"amber" \| "black" \| "blackAlpha" \| "blue" \| "cyan" \| "danger" \| "emerald" \| "error" \| "flashy" \| "fuchsia" ...` Set color scheme variables.
`size`	`"md"`	`"2xl" \| "lg" \| "md" \| "sm" \| "xl" \| "xs"` The size of the component.
`variant`	`"solid"`	`"ghost" \| "outline" \| "solid" \| "subtle" \| "surface" ...` The variant of the component.
`active`	`false`	`boolean` If `true`, the button is represented as active.
`disabled`	`false`	`boolean` If `true`, the button is disabled.
`disableRipple`	`false`	`boolean` If `true`, disable ripple effects when pressing a element.
`endIcon`	-	`ReactNode` The icon to display at the end side of the button.
`fullRounded`	`false`	`boolean` If `true`, the button is full rounded. Else, it'll be slightly round.
`iconProps`	-	`ButtonIconProps` The props of the icon element.
`loading`	`false`	`boolean` If `true`, the loading state of the button is represented.
`loadingIcon`	`"oval"`	`Loading.Scheme \| ReactNode` The icon to display when the button is loading.
`loadingMessage`	-	`ReactNode` The message to display when the button is loading.
`loadingPlacement`	`"start"`	`"end" \| "start"` The placement of the loading indicator. Accepts `start` or `end`.
`loadingProps`	-	`ButtonLoadingProps` The props of the loading icon element.
`startIcon`	-	`ReactNode` The icon to display at the start side of the button.
`type`	`"button"`	`HTMLProps<"button">["type"]` The type of button. Accepts `button`, `reset`, or `submit`.

ButtonGroup.Root

Prop	Default	Type / Description
`as`	-	`As` The HTML element to render.
`asChild`	-	`boolean` Merges its props onto its immediate child.
`css`	-	`CSSObject \| CSSObject[]` The CSS object.
`colorScheme`	-	`"amber" \| "black" \| "blackAlpha" \| "blue" \| "cyan" \| "danger" \| "emerald" \| "error" \| "flashy" \| "fuchsia" ...` Set color scheme variables.
`size`	`"md"`	`"2xl" \| "lg" \| "md" \| "sm" \| "xl" \| "xs"` The size of the component.
`variant`	`"solid"`	`"ghost" \| "outline" \| "solid" \| "subtle" \| "surface" ...` The variant of the component.
`align`	-	`"-moz-initial" \| "baseline" \| "center" \| "end" \| "flex-end" \| "flex-start" \| "inherit" \| "initial" \| "normal" \| "revert-layer" ...` The CSS `align-items` property.
`attached`	`false`	`boolean` If `true`, the borderRadius of button that are direct children will be altered to look flushed together.
`basis`	-	`"-moz-fit-content" \| "-moz-initial" \| "-moz-max-content" \| "-moz-min-content" \| "-webkit-auto" \| "0.5" \| "1.5" \| "1" \| "1/12" \| "1/2" ...` The CSS `flex-basis` property.
`direction`	-	`"-moz-initial" \| "column-reverse" \| "column" \| "inherit" \| "initial" \| "revert-layer" \| "revert" \| "row-reverse" \| "row" \| "unset" ...` The CSS `flex-direction` property.
`disabled`	`false`	`boolean` If `true`, all wrapped button will be disabled.
`fullRounded`	`false`	`boolean` If `true`, the button is full rounded. Else, it'll be slightly round.
`grow`	`false`	`boolean` If `true`, the children will grow to fill the available space.
`justify`	-	`"-moz-initial" \| "center" \| "end" \| "flex-end" \| "flex-start" \| "inherit" \| "initial" \| "left" \| "normal" \| "revert-layer" ...` The CSS `justify-content` property.
`orientation`	`"horizontal"`	`"horizontal" \| "vertical"` The orientation of the group.
`shrink`	-	`"-moz-initial" \| "inherit" \| "initial" \| "revert-layer" \| "revert" \| "unset" \| number & {} ...` The CSS `flex-shrink` property.
`stacking`	-	`"first-on-top" \| "last-on-top"` The stacking order of the group.
`wrap`	-	`"-moz-initial" \| "inherit" \| "initial" \| "nowrap" \| "revert-layer" \| "revert" \| "unset" \| "wrap-reverse" \| "wrap" ...` The CSS `flex-wrap` property.

ButtonGroup.Item

Prop	Default	Type / Description
`as`	-	`As` The HTML element to render.
`asChild`	-	`boolean` Merges its props onto its immediate child.
`css`	-	`CSSObject \| CSSObject[]` The CSS object.
`colorScheme`	-	`"amber" \| "black" \| "blackAlpha" \| "blue" \| "cyan" \| "danger" \| "emerald" \| "error" \| "flashy" \| "fuchsia" ...` Set color scheme variables.
`size`	`"md"`	`"2xl" \| "lg" \| "md" \| "sm" \| "xl" \| "xs"` The size of the component.
`variant`	`"solid"`	`"ghost" \| "outline" \| "solid" \| "subtle" \| "surface" ...` The variant of the component.
`active`	`false`	`boolean` If `true`, the button is represented as active.
`disabled`	`false`	`boolean` If `true`, the button is disabled.
`disableRipple`	`false`	`boolean` If `true`, disable ripple effects when pressing a element.
`endIcon`	-	`ReactNode` The icon to display at the end side of the button.
`fullRounded`	`false`	`boolean` If `true`, the button is full rounded. Else, it'll be slightly round.
`iconProps`	-	`ButtonIconProps` The props of the icon element.
`loading`	`false`	`boolean` If `true`, the loading state of the button is represented.
`loadingIcon`	`"oval"`	`Loading.Scheme \| ReactNode` The icon to display when the button is loading.
`loadingMessage`	-	`ReactNode` The message to display when the button is loading.
`loadingPlacement`	`"start"`	`"end" \| "start"` The placement of the loading indicator. Accepts `start` or `end`.
`loadingProps`	-	`ButtonLoadingProps` The props of the loading icon element.
`startIcon`	-	`ReactNode` The icon to display at the start side of the button.
`type`	`"button"`	`HTMLProps<"button">["type"]` The type of button. Accepts `button`, `reset`, or `submit`.

Accessibility

The Button follows the WAI-ARIA - Button Pattern for accessibility.

Key	Description	State
`Space`, `Enter`	When element has focus, activates it.	-

ARIA Roles and Attributes

Component	Role and Attribute	Usage
`Button`	`role="button"`	Indicates that it is a button.