Button

Buttonは、フォームの送信、モーダルの開閉など、ユーザーが操作できるインタラクティブなコンポーネントです。

<Button>Button</Button>

使い方

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>

リンクとして機能させたい場合は、as="a"を設定します。フレームワークがリンクコンポーネントを提供している場合は、as={FrameworkLink}を設定します。各フレームワークのリンクコンポーネントとの統合は、こちらから使用しているフレームワークのドキュメントをご覧ください。

Buttonの子要素がアイコンのみの場合は、IconButtonを使用します。

Buttonが複数存在し、それらのButtonがグルーピングが可能な場合は、ButtonGroupを使用します。

バリアントを変更する

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

サイズを変更する

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

カラースキームを変更する

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

形を変える

角丸にする場合は、fullRoundedをtrueにします。

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

無効にする

無効にする場合は、disabledをtrueにします。

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

アイコンを追加する

アイコンを追加する場合は、startIconまたはendIconにReactNodeを設定します。

<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>

ローディングアニメーションを使う

ローディングアニメーションを使う場合は、loadingをtrueにします。また、ローディング中にテキストを変更する場合は、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>

Buttonのローディングは、内部でLoadingを使用しています。

グループ化する

<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	デフォルト	型 / 説明
`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.
`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	デフォルト	型 / 説明
`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" \| "anchor-center" \| "baseline" \| "center" \| "end" \| "flex-end" \| "flex-start" \| "inherit" \| "initial" \| "normal" ...` The CSS `align-items` property.
`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.
`justify`	-	`"-moz-initial" \| "center" \| "end" \| "flex-end" \| "flex-start" \| "inherit" \| "initial" \| "left" \| "normal" \| "revert-layer" ...` The CSS `justify-content` property.
`shrink`	-	`"-moz-initial" \| "inherit" \| "initial" \| "revert-layer" \| "revert" \| "unset" \| AnyString \| number & {} ...` The CSS `flex-shrink` property.
`wrap`	-	`"-moz-initial" \| "inherit" \| "initial" \| "nowrap" \| "revert-layer" \| "revert" \| "unset" \| "wrap-reverse" \| "wrap" \| AnyString ...` The CSS `flex-wrap` property.

ButtonGroup.Item

Prop	デフォルト	型 / 説明
`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.
`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`.

アクセシビリティ

Buttonは、アクセシビリティに関してWAI-ARIA - Button Patternに従います。

キー	説明	状態
`Enter`, `Space`	フォーカスしているボタンをアクティブにします。	-

ARIAロールと属性

コンポーネントと要素	ロールと属性	使い方
`button.ui-button`	`role="button"`	デフォルトでは`Button`は`button.ui-button`としてレンダリングされます。`as`を使うとホスト要素は変更されます。

類似のコンポーネント

CloseButtonは、基本的にコンポーネントの閉じる機能をトリガーするために使用するコンポーネントです。

IconButtonは、ボタン内にアイコンを表示するコンポーネントです。

FileButtonは、ユーザーがファイルを選択するために使用されるボタンのコンポーネントです。

Toggleは、オンまたはオフの２つの状態を持つコンポーネントです。

使用しているコンポーネント・フック

Groupは、複数の要素をまとめて扱うためのコンポーネントです。

Loadingは、データの読み込み中などの待機時間に表示するコンポーネントです。

Rippleは、要素に波及効果を付与し、ユーザーがクリックしたかどうかを認識させるコンポーネントです。

使用されているコンポーネント・フック

ActionBarは、下部に表示されるアクションバーを表示するコンポーネントです。

Calendarは、日付を表示または選択するカレンダーのコンポーネントです。

Carouselは、複数の要素をスライドショーのように表示するコンポーネントです。

CloseButtonは、基本的にコンポーネントの閉じる機能をトリガーするために使用するコンポーネントです。

Drawerは、画面の端から表示されるパネルのコンポーネントです。

FileButtonは、ユーザーがファイルを選択するために使用されるボタンのコンポーネントです。

Formは、複数のフォーム要素をグループ化するためのコンポーネントです。

Menuは、一般的なドロップダウンメニューを表示するコンポーネントです。

Modalは、主要なコンテンツに重ねて表示され、ユーザーの注意を情報のみに集中させるコンポーネントです。

NativePopoverは、HTML Popover APIを使用して要素の周りにフローティングして情報を表示するコンポーネントです。

NumberInputは、ユーザーからの数値入力を取得するために使用されるコンポーネントです。

Paginationは、コンテンツのページ分割とナビゲーションを管理するためのコンポーネントです。

PasswordInputは、表示・非表示の切り替えができるパスワード入力用のコンポーネントです。

Popoverは、要素の周りにフローティングして情報を表示するコンポーネントです。

Tipは、アイコンボタンをトリガーとして補足情報を表示するコンポーネントです。

Toggleは、オンまたはオフの２つの状態を持つコンポーネントです。