ButtonIconアイコンボタン

アイコンボタンは、主に二次的な操作を実行するために使用されます。

使用方法

コンポーネントを必要に応じてインポートします：

import 'mdui/components/button-icon.js';

コンポーネントの TypeScript 型を必要に応じてインポートします：

import type { ButtonIcon } from 'mdui/components/button-icon.js';

使用例：

<mdui-button-icon icon="search"></mdui-button-icon>

例

アイコン

icon 属性で Material Icons アイコン名を指定します。デフォルトスロットでアイコン要素を指定することもできます。

<mdui-button-icon icon="search"></mdui-button-icon>
<mdui-button-icon>
  <mdui-icon name="search"></mdui-icon>
</mdui-button-icon>

ソース

形状

variant 属性を使用してアイコンボタンの形状を設定します。

<mdui-button-icon variant="standard" icon="search"></mdui-button-icon>
<mdui-button-icon variant="filled" icon="search"></mdui-button-icon>
<mdui-button-icon variant="tonal" icon="search"></mdui-button-icon>
<mdui-button-icon variant="outlined" icon="search"></mdui-button-icon>

ソース

選択可能

selectable 属性を追加すると、アイコンボタンを選択可能にできます。

<mdui-button-icon selectable icon="favorite_border"></mdui-button-icon>

ソース

selected-icon 属性で選択状態の Material Icons アイコン名を指定します。selected-icon スロットを通じて選択状態のアイコン要素を指定することもできます。

<mdui-button-icon selectable icon="favorite_border" selected-icon="favorite"></mdui-button-icon>
<mdui-button-icon selectable icon="favorite_border">
  <mdui-icon slot="selected-icon" name="favorite"></mdui-icon>
</mdui-button-icon>

ソース

アイコンボタンが選択されると、selected 属性が true になります。また、selected 属性を追加することで、アイコンボタンをデフォルトで選択状態にできます。

<mdui-button-icon selectable selected icon="favorite_border" selected-icon="favorite"></mdui-button-icon>

ソース

リンク

href 属性を追加すると、アイコンボタンをリンクにできます。この場合、リンク関連の属性 download、target、rel も使用できます。

<mdui-button-icon icon="search" href="https://www.mdui.org" target="_blank"></mdui-button-icon>

ソース

無効およびローディング状態

disabled 属性を追加するとアイコンボタンを無効にできます；loading 属性を追加するとアイコンボタンにローディング状態を追加できます。

<mdui-button-icon disabled icon="search" variant="tonal"></mdui-button-icon>
<mdui-button-icon loading icon="search" variant="tonal"></mdui-button-icon>
<mdui-button-icon loading disabled icon="search" variant="tonal"></mdui-button-icon>

ソース

API

プロパティ

HTML 属性	JavaScript プロパティ	型	デフォルト値
`variant`	`variant`	`'standard' \| 'filled' \| 'tonal' \| 'outlined'`	`'standard'`
アイコンボタンの形状です。次の値を指定します： `standard`：最も低い優先度の操作に適しています。 `filled`：視覚的な強調度が高く、高優先度の操作に適しています。 `tonal`：`filled` と `outlined` の中間の視覚的強調度です。中～高優先度の操作に適しています。 `outlined`：中優先度の操作に適しています。
`icon`	`icon`	`string`	-
Material Iconsのアイコン名です。デフォルトスロットで設定することもできます。
`selected-icon`	`selectedIcon`	`string`	-
選択状態のMaterial Iconsアイコン名です。`slot="selected-icon"` で設定することもできます。
`selectable`	`selectable`	`boolean`	`false`
選択可能かどうかを指定します。
`selected`	`selected`	`boolean`	`false`
選択されているかどうかを指定します。
`href`	`href`	`string`	-
リンク先のURLです。この属性を設定すると、コンポーネント内部は `<a>` 要素としてレンダリングされ、リンク関連の属性が使用可能になります。
`download`	`download`	`string`	-
ダウンロードリンクの対象ファイル名です。注：`href` 属性が設定されている場合にのみ有効です。
`target`	`target`	`'_blank' \| '_parent' \| '_self' \| '_top'`	-
リンクの開き方です。次の値を指定します： `_blank`：新しいウィンドウで開く `_parent`：親フレームで開く `_self`：デフォルト。現在のフレームで開く `_top`：最上位のウィンドウで開く注：`href` 属性が設定されている場合にのみ有効です。
`rel`	`rel`	`'alternate' \| 'author' \| 'bookmark' \| 'external' \| 'help' \| 'license' \| 'me' \| 'next' \| 'nofollow' \| 'noreferrer' \| 'opener' \| 'prev' \| 'search' \| 'tag'`	-
現在のドキュメントとリンク先ドキュメントの関係です。次の値を指定します： `alternate`：現在のドキュメントの代替バージョン `author`：現在のドキュメントまたは記事の作成者 `bookmark`：直近の祖先セクションへのパーマリンク `external`：参照先ドキュメントが現在のサイトとは異なるサイトにあることを示します `help`：関連するヘルプドキュメントへのリンク `license`：現在のドキュメントのメインコンテンツが、参照先ファイルの著作権ライセンスの対象であることを示します `me`：現在のドキュメントがリンク先コンテンツの所有者を表します `next`：現在のドキュメントがシリーズの一部であり、参照先ドキュメントがシリーズの次のドキュメントです `nofollow`：現在のドキュメントの作成者または発行者が、参照先ファイルを推奨していないことを示します `noreferrer`：`Referer` ヘッダーを含めません。`noopener` と同様の効果です `opener`：ハイパーリンクが最上位のブラウジングコンテキストを作成する場合（つまり `target` 属性値が `_blank`）、補助ブラウジングコンテキストを作成します `prev`：現在のドキュメントがシリーズの一部であり、参照先ドキュメントがシリーズの前のドキュメントです `search`：現在のファイルとその関連ページを検索するために使用できるリソースへのリンクを提供します `tag`：現在のドキュメントに適用されるタグ（指定されたアドレスで識別される）を提供します注：`href` 属性が指定されている場合にのみ使用できます。
`autofocus`	`autofocus`	`boolean`	`false`
ページ読み込み完了後、自動的にフォーカスを取得するかどうかを指定します。
`tabindex`	`tabIndex`	`number`	-
Tab キーによるフォーカス移動時の、要素の順序を指定します。
`disabled`	`disabled`	`boolean`	`false`
無効状態にするかどうかを指定します。
`loading`	`loading`	`boolean`	`false`
読み込み中状態にするかどうかを指定します。
`name`	`name`	`string`	`''`
ボタンの名前です。フォームデータと共に送信されます。注：`href` 属性が設定されていない場合にのみ有効です。
`value`	`value`	`string`	`''`
ボタンの初期値です。フォームデータと共に送信されます。注：`href` 属性が設定されていない場合にのみ有効です。
`type`	`type`	`'submit' \| 'reset' \| 'button'`	`'button'`
ボタンのタイプです。デフォルトのタイプは `button` です。次のタイプを指定します： `submit`：ボタンをクリックするとフォームデータがサーバーに送信されます `reset`：ボタンをクリックするとフォーム内のすべてのフィールドが初期値にリセットされます `button`：このタイプのボタンにはデフォルトの動作はありません注：`href` 属性が指定されていない場合にのみ有効です。
`form`	`form`	`string`	-
関連付ける `<form>` 要素です。この属性値には、同一ページ内の `<form>` 要素の `id` を指定する必要があります。この属性が指定されていない場合、この要素は `<form>` 要素の子要素である必要があります。この属性を使用すると、要素を `<form>` 要素の子要素だけでなく、ページ上の任意の場所に配置できます。注：`href` 属性が指定されていない場合にのみ有効です。
`formaction`	`formAction`	`string`	-
フォーム送信先のURLを指定します。この属性が指定されている場合、`<form>` 要素の `action` 属性は上書きされます。注：`href` 属性が指定されておらず、かつ `type="submit"` の場合にのみ有効です。
`formenctype`	`formEnctype`	`'application/x-www-form-urlencoded' \| 'multipart/form-data' \| 'text/plain'`	-
サーバーにフォームを送信する際のコンテンツタイプを指定します。次の値を指定します： `application/x-www-form-urlencoded`：この属性が指定されていない場合のデフォルト値 `multipart/form-data`：フォームに `<input type="file">` 要素が含まれる場合に使用します `text/plain`：HTML5で追加された、デバッグ用この属性が指定されている場合、`<form>` 要素の `enctype` 属性は上書きされます。注：`href` 属性が指定されておらず、かつ `type="submit"` の場合にのみ有効です。
`formmethod`	`formMethod`	`'post' \| 'get'`	-
フォーム送信時に使用するHTTPメソッドを指定します。次の値を指定します： `post`：フォームデータはフォームコンテンツに含まれてサーバーに送信されます `get`：フォームデータは `?` 区切りでフォームのURI属性に追加され、生成されたURIがサーバーに送信されます。フォームに副作用がなく、ASCII文字のみを含む場合にこのメソッドを使用しますこの属性が設定されている場合、`<form>` 要素の `method` 属性は上書きされます。注：`href` 属性が設定されておらず、かつ `type="submit"` の場合にのみ有効です。
`formnovalidate`	`formNoValidate`	`boolean`	`false`
この属性が設定されている場合、フォーム送信時にフォーム検証は実行されません。この属性が設定されている場合、`<form>` 要素の `novalidate` 属性は上書きされます。注：`href` 属性が設定されておらず、かつ `type="submit"` の場合にのみ有効です。
`formtarget`	`formTarget`	`'_self' \| '_blank' \| '_parent' \| '_top'`	-
フォーム送信後に受信したレスポンスを表示する場所を指定します。次の値を指定します： `_self`：デフォルトのオプション。現在のフレームで開きます `_blank`：新しいウィンドウで開きます `_parent`：親フレームで開きます `_top`：最上位のウィンドウで開きますこの属性が設定されている場合、`<form>` 要素の `target` 属性は上書きされます。注：`href` 属性が設定されておらず、かつ `type="submit"` の場合にのみ有効です。
	`validity`	`ValidityState`	-
フォーム検証ステータスを表す `ValidityState` オブジェクトです。詳細は `ValidityState` を参照してください。
	`validationMessage`	`string`	-
フォーム検証に合格しなかった場合、このプロパティにはエラーメッセージが設定されます。検証に合格した場合は空の文字列になります。

メソッド

名前	パラメーター	戻り値
`click`		`void`
要素のマウスクリックをシミュレートします。
`focus`	`options: FocusOptions` (オプション)	`void`
現在の要素にフォーカスを設定します。オプションとして、以下のプロパティを持つオブジェクトを渡すことができます： `preventScroll`：デフォルトでは、要素がフォーカスを取得すると、その要素がビュー内に表示されるようにページがスクロールします。ページのスクロールを防ぐには、このプロパティを `true` に設定します。
`blur`		`void`
現在の要素からフォーカスを外します。
`checkValidity`		`boolean`
フォームフィールドが検証に合格するかどうかをチェックします。合格しない場合は `false` を返し、`invalid` イベントをトリガーします。合格した場合は `true` を返します。
`reportValidity`		`boolean`
フォームフィールドが検証に合格するかどうかをチェックします。合格しない場合は `false` を返し、`invalid` イベントをトリガーします。合格した場合は `true` を返します。検証に合格しなかった場合は、コンポーネントに検証失敗のエラーメッセージも表示されます。
`setCustomValidity`	`message: string`	`void`
カスタムのエラーメッセージを設定します。このテキストが空でない限り、フィールドが検証に合格していないと見なされます。

イベント

名前
`focus`
フォーカスを取得したときに発生します。
`blur`
フォーカスを失ったときに発生します。
`change`
選択状態が変更されたときに発生します。
`invalid`
フォームフィールドの検証に合格しなかったときに発生します。

Slots

名前
デフォルト
アイコンコンポーネント
`selected-icon`
選択状態で表示されるアイコン要素

CSS Parts

名前
`button`
内部の `<button>` または `<a>` 要素
`icon`
非選択状態のアイコン
`selected-icon`
選択状態のアイコン
`loading`
読み込み中状態の `<mdui-circular-progress>` 要素

CSS カスタムプロパティ

名前
`--shape-corner`
コンポーネントの角丸のサイズ。ピクセル値で直接指定できますが、デザイントークンを参照することをお勧めします。

前の章

Button ボタン

次の章

Card カード