Button

Buttonコンポーネントは、ユーザーが情報の保存や検索などの操作をできるようにします。

種類

ボタンの優先度や役割に合わせた4種類のコンポーネントを総称して、Buttonコンポーネントとして定義しています。

<>
<Button variant="primary">Primary</Button>
<Button>Secondary</Button>
<Button variant="danger">Danger</Button>
<Button variant="text">Text</Button>
</>

Primary

画面の主要なアクションを促すボタンです。

1つの画面に複数のPrimaryボタンを使わないでください。複数のPrimaryボタンがあるとユーザーは何をすればいいかわからなくなります。

<>
<Button variant="primary">ボタン</Button>
<Button variant="primary" prefix={<FaPlusCircleIcon />}>ボタン</Button>
<Button variant="primary" suffix={<FaCaretDownIcon />}>ボタン</Button>
<Button variant="primary" square>
<FaPlusCircleIcon alt="追加" />
</Button>
</>

Secondary

画面でのアクションを促す、Primaryボタンに対する副次的なボタンとして使います。
SmartHR UI では特に種類の指定をしない場合はSecondaryになります。

画面内にボタンが多すぎる場合、ユーザーは次に何をすればいいのか戸惑うかもしれません。その場合はボタンを減らしたり、画面を簡略化したり、複数の画面に分けることを検討しましょう。

<>
<Button>ボタン</Button>
<Button prefix={<FaPlusCircleIcon />}>ボタン</Button>
<Button suffix={<FaCaretDownIcon />}>ボタン</Button>
<Button square>
<FaPlusCircleIcon alt="追加" />
</Button>
</>

Danger

破壊的なアクション(データの永久消去など)の実行前に、ユーザーに一歩立ち止まって考えてもらいたいときに使います。

  • Dangerボタンが頻出すると効果がありません。
  • ユーザーにこのアクションを実行させる場合は、必ず確認を求めるステップを追加してください。(例:削除ダイアログ
  • すべてのユーザーが色を見たり、理解できるわけではないため、警告を促す赤色(DANGER)に頼らないでください。ボタン配置のコンテキストやラベルテキストは重要です。
<>
<Button variant="danger">ボタン</Button>
<Button variant="danger" prefix={<FaPlusCircleIcon />}>ボタン</Button>
<Button variant="danger" suffix={<FaCaretDownIcon />}>ボタン</Button>
<Button variant="danger" square>
<FaPlusCircleIcon alt="追加" />
</Button>
</>

Text

Secondaryボタンよりもさらに優先度が低いアクションのボタンとして使います。

また、ドロップダウンメニューとして使用したり、アイコンボタンとして使用するなど、ボタンではあるもののボタンの装飾を必要としない場合に使います。

<>
<Button variant="text">ボタン</Button>
<Button variant="text" prefix={<FaPlusCircleIcon />}>ボタン</Button>
<Button variant="text" suffix={<FaCaretDownIcon />}>ボタン</Button>
<Button variant="text" square>
<FaPlusCircleIcon alt="追加" />
</Button>
</>

AnchorButton

リンク(a要素)をボタンのように見せるためのコンポーネントですが、どうしようもないときだけ使います。 アクションボタンとして表現したい場合は、素直にButtonを使いましょう。

<>
<AnchorButton variant="primary" href="#h3-4">ボタン</AnchorButton>
<AnchorButton href="#h3-4">ボタン</AnchorButton>
<AnchorButton variant="danger" href="#h3-4">ボタン</AnchorButton>
<AnchorButton variant="text" href="#h3-4">ボタン</AnchorButton>
</>

レイアウト

サイズやアイコンの有無で、コンポーネント内のレイアウトにバリエーションがあります。
サイズ小かつアイコン付き(左)」のように組み合わせることもできます。

ボタンサイズ

2種類の大きさのボタンを使用できます。 SmartHR UIでは、サイズ(sizeprops)で指定できます。

種類表示例説明
通常
ボタン
通常のサイズです。
ボタン
レイアウトの都合上、どうしようもない場合に使うサイズです。

アイコンの有無

アイコン付きボタン

ラベルテキストの左右にアイコンを配置できます。
SmartHR UIでは、プレフィックス(prefixprops)およびサフィックス(suffixprops)にIconコンポーネントを指定することで表現できます。

ただし、左右のアイコンを同時に指定しないでください。アイコン付き(右)を優先し、アイコンを右に表示する場合は左のアイコンは設定しないようにしましょう。

種類表示例アイコンの役割
アイコン付き(左)
項目を追加
ダウンロード
ボタンのアクション(機能)を表すために使います。
同じアクションのボタンには、同じアイコンを採用してください。
アイコン付き(右)
一括操作
絞り込み
ドロップダウンのように、ボタン押下後に表示するUIを想起させるために使います。
(例:ドロップダウンボタンDropdownFilterDropdown

アイコンボタン

アイコンのみのボタンです。ラベルテキストを表示するレイアウト上の余裕がない場合などに使います。
ラベルテキストがないため、アイコンには必ず代替テキストを含めてください。

<>
<Button square>
<FaPlusCircleIcon alt="追加" />
</Button>
<Button square size="s">
<FaPlusCircleIcon alt="追加" />
</Button>
</>

状態

マウスオーバー

マウスポインタでボタンに触れている状態(hover状態)のスタイルです。 マウスオーバーを認知できるように、標準時の背景色にOVERLAYを重ねて表現します。

無効(disabled)

ボタンの操作ができない状態を表現したスタイルです。
無効状態のボタンはコントラストが低くユーザーを混乱させるため、できるだけ使わないようにしてください。

ユーザーはなぜ無効になっているのかわからないことがあります。「権限による表示制御」のデザインパターンを参考にして、無効状態の理由を表示したり、無効ではなくボタン自体を非表示にすることを検討してください。

<>
<Button variant="primary" prefix={<FaPlusCircleIcon />} disabled>ボタン</Button>
<Button prefix={<FaPlusCircleIcon />} disabled>ボタン</Button>
</>

ライティング

ラベルの書き方

ラベルは、そのボタンが担うアクションを体言止めで書きます。

  • ユーザーが入力したフォームを「送信」
  • タスクやオブジェクトを「追加」
  • 次のプロセスに進む「次へ」

「権限を追加」「申請を取り消し」など、対象のオブジェクト名などを明記しないとアクションが伝わりにくい場合は「を」で接続します。

ラベルの判断基準は以下のとおりです。

ボタンやテキストリンクなど、ユーザーのアクションを促すテキストですか?そうでない場合は{オブジェクト}の{操作名}と書きます。クリックしたら{操作名}の処理が実行されますか?(最終アクションですか?)そうでない場合は{オブジェクト}の{操作名}と書きます。テキストに対象オブジェクト名を明記しないと伝わりにくい場合は{オブジェクト名}を{操作名}と書きます。そうでない場合は{操作名}と書きます。

その他

type="button" について

SmartHR UIのButtonには意図しないsubmitを防ぐために、type="button"がついています。 そのため、form submitを使いたい場合は、必ずtype="submit"を明記してください。

Props

NameRequiredTypeDescription
size-"s", "default"ボタンの大きさ
children-string, number, false, true, ReactElement<any, string | JSXElementConstructor<any>>, ReactFragment, ReactPortalボタン内に表示する内容
className-stringコンポーネントに適用するクラス名
disabledDetail-{ icon?: FunctionComponent<{}>; message: ReactNode; }無効な理由
prefix-string, number, false, true, ReactElement<any, string | JSXElementConstructor<any>>, ReactFragment, ReactPortalボタン内の先頭に表示する内容。 通常は、アイコンを表示するために用いる。
suffix-string, number, false, true, ReactElement<any, string | JSXElementConstructor<any>>, ReactFragment, ReactPortalボタン内の末尾に表示する内容。 通常は、アイコンを表示するために用いる。
square-false, true`true` のとき、ボタンを正方形にする。
wide-false, true`true` のとき、ボタンの `width` を 100% にする。
variant-"text", "primary", "secondary", "danger", "skeleton"ボタンのスタイルの種類
loading-false, true処理が走ってるかどうか

参考文献