Chipチップ

チップコンポーネントは、ユーザーの情報入力を補助し、選択、コンテンツのフィルタリング、関連操作の実行などに使用します。

使用方法

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

import 'mdui/components/chip.js';

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

import type { Chip } from 'mdui/components/chip.js';

使用例：

Chip

<mdui-chip>Chip</mdui-chip>

例

形状

variant 属性を使用してチップの形状を設定します。チップには以下の4種類の形状があり、用途に応じて選択できます：

assist：現在のコンテキストに関連する補助操作を表示するために使用されます。例えば、注文ページで共有やお気に入りなどの機能を提供します。
filter：コンテンツをフィルタリングするために使用されます。例えば、検索結果ページで検索結果をフィルタリングします。
input：ユーザーが入力した情報の断片を表すために使用されます。例えば、Gmail の「宛先」フィールドの連絡先などです。
suggestion：動的に生成されたレコメンデーション情報を提供し、ユーザーの操作を簡素化するために使用されます。例えば、チャットアプリケーションでユーザーが送信したいと思う可能性のある情報を推測し、選択できるようにします。

Assist

Filter

Input

Suggestion

<mdui-chip variant="assist">Assist</mdui-chip>
<mdui-chip variant="filter">Filter</mdui-chip>
<mdui-chip variant="input">Input</mdui-chip>
<mdui-chip variant="suggestion">Suggestion</mdui-chip>

ソース

影

elevated 属性を追加すると、チップに影が付きます。

Chip

<mdui-chip elevated>Chip</mdui-chip>

ソース

アイコン

icon または end-icon 属性を指定すると、チップの左側または右側に Material Icons アイコンをそれぞれ表示できます。また、icon スロットや end-icon スロットを使用して、チップの左側や右側に要素を追加することもできます。

Icon

End Icon

Slot

<mdui-chip icon="search">Icon</mdui-chip>
<mdui-chip end-icon="arrow_forward">End Icon</mdui-chip>
<mdui-chip>
  Slot
  <mdui-icon slot="icon" name="downloading"></mdui-icon>
  <mdui-icon slot="end-icon" name="attach_file"></mdui-icon>
</mdui-chip>

ソース

リンク

href 属性を追加すると、チップをリンクにできます。この場合、リンク関連の download、target、rel 属性も使用できます。

Link

<mdui-chip href="https://www.mdui.org" target="_blank">Link</mdui-chip>

ソース

無効および読み込み中状態

disabled 属性を追加するとチップを無効にできます。loading 属性を追加するとチップを読み込み中状態にできます。

Disabled

Loading & Disabled

<mdui-chip disabled>Disabled</mdui-chip>
<mdui-chip loading>Loading</mdui-chip>
<mdui-chip loading disabled>Loading & Disabled</mdui-chip>

ソース

選択可能

selectable 属性を追加すると、チップを選択可能にできます。

Chip

<mdui-chip selectable>Chip</mdui-chip>

ソース

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

Chip

<mdui-chip selectable selected-icon="favorite">Chip</mdui-chip>
<mdui-chip selectable>
  Chip
  <mdui-icon slot="selected-icon" name="favorite"></mdui-icon>
</mdui-chip>

ソース

チップが選択されると、selected 属性が true になります。また、selected 属性を追加することで、チップをデフォルトで選択状態にできます。

Chip

<mdui-chip selectable selected>Chip</mdui-chip>

ソース

削除可能

deletable 属性を追加すると、チップの右側に削除アイコンが表示されます。このアイコンをクリックすると delete イベントがトリガーされます。delete-icon 属性で削除アイコンの Material Icons アイコン名を指定するか、delete-icon スロットで削除アイコンの要素を指定できます。

Chip

<mdui-chip deletable>Chip</mdui-chip>
<mdui-chip deletable delete-icon="backspace">Chip</mdui-chip>
<mdui-chip deletable>
  Chip
  <mdui-icon slot="delete-icon" name="backspace"></mdui-icon>
</mdui-chip>

ソース

API

プロパティ

HTML 属性	JavaScript プロパティ	型	デフォルト値
`variant`	`variant`	`'assist' \| 'filter' \| 'input' \| 'suggestion'`	`'assist'`
チップの形状です。次の値を指定します： `assist`：注文ページでの共有やお気に入りなど、現在のコンテキストに関連する補助操作を表示するために使用します。 `filter`：検索結果ページでの検索結果の絞り込みなど、コンテンツをフィルタリングするために使用します。 `input`：Gmailの「To」フィールドの連絡先など、ユーザーが入力した情報の断片を表すために使用します。 `suggestion`：チャットアプリでユーザーが送信しそうなメッセージを予測するなど、ユーザー操作を簡素化するために動的生成された推奨情報を提供するために使用します。
`elevated`	`elevated`	`boolean`	`false`
影を表示するかどうかを指定します。
`selectable`	`selectable`	`boolean`	`false`
選択可能かどうかを指定します。
`selected`	`selected`	`boolean`	`false`
選択されているかどうかを指定します。
`deletable`	`deletable`	`boolean`	`false`
削除可能かどうかを指定します。`true` の場合、チップの右側に削除アイコンが表示されます。
`icon`	`icon`	`string`	-
左側に表示するMaterial Iconsのアイコン名です。`slot="icon"` で設定することもできます。
`selected-icon`	`selectedIcon`	`string`	-
選択状態の左側に表示するMaterial Iconsのアイコン名です。`slot="selected-icon"` で設定することもできます。
`end-icon`	`endIcon`	`string`	-
右側に表示するMaterial Iconsのアイコン名です。`slot="end-icon"` で設定することもできます。
`delete-icon`	`deleteIcon`	`string`	-
削除可能な場合に、右側の削除アイコンとして使用するMaterial Iconsのアイコン名です。`slot="delete-icon"` で設定することもできます。
`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`
フォーカスを失ったときに発生します。
`invalid`
フォームフィールドの検証に合格しなかったときに発生します。
`change`
選択状態が変更されたときに発生します。
`delete`
削除アイコンがクリックされたときに発生します。

Slots

名前
デフォルト
チップのテキスト
`icon`
左側の要素
`end-icon`
右側の要素
`selected-icon`
選択状態の左側の要素
`delete-icon`
削除可能な場合の右側の削除要素

CSS Parts

名前
`button`
内部の `<button>` または `<a>` 要素
`label`
チップのテキスト
`icon`
左側のアイコン
`end-icon`
右側のアイコン
`selected-icon`
選択状態の左側のアイコン
`delete-icon`
削除可能な場合の右側の削除アイコン
`loading`
読み込み中状態の `<mdui-circular-progress>` 要素

CSS カスタムプロパティ

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

前の章

Checkbox チェックボックス

次の章

CircularProgress 円形プログレス