Chip

Chip コンポーネントは、コンパクトでインタラクティブな UI 要素です。連絡先やタグなどの複雑なエンティティを表します。多くの場合、アイコンとラベルが付きます。チェック可能、閉じる可能、クリック可能のいずれかになります。

チップには次の 4 種類があり、それぞれ使用する場面が異なります。

  • アシスト: タスクの実行中にユーザーをガイドします。多くの場合、ユーザー入力に応じて一時的な UI 要素として表示されます。
  • フィルタ: ユーザーがオプションのセットからコンテンツを絞り込むことができます。選択または選択解除できます。選択するとチェックマーク アイコンが表示されることがあります。
  • 入力: メニューでの選択など、ユーザーが提供した情報を表します。アイコンとテキストを含めることができ、削除用の X を提供します。
  • 候補: 最近のアクティビティや入力に基づいて、ユーザーにおすすめの情報を提示します。通常、入力フィールドの下に表示され、ユーザーの操作を促します。
4 つのチップ コンポーネントの例。それぞれの固有の特性が強調されています。
図 1. 4 つのチップ コンポーネント。

API サーフェス

チップの 4 つのタイプに対応する 4 つのコンポーザブルがあります。以降のセクションでは、これらのコンポーザブルとその違いについて詳しく説明します。ただし、次のパラメータは共有されます。

  • label: チップに表示される文字列。
  • icon: チップの先頭に表示されるアイコン。特定のコンポーザブルには、個別の leadingIcon パラメータと trailingIcon パラメータがあります。
  • onClick: ユーザーがチップを押したときに呼び出されるラムダ。

アシスト チップ

AssistChip コンポーザブルを使用すると、ユーザーを特定の方向に誘導するアシスト チップを簡単に作成できます。特徴の 1 つは、チップの左側にアイコンを表示できる leadingIcon パラメータです。次の例は、実装方法を示しています。

@Composable
fun AssistChipExample() {
    AssistChip(
        onClick = { Log.d("Assist chip", "hello world") },
        label = { Text("Assist chip") },
        leadingIcon = {
            Icon(
                Icons.Filled.Settings,
                contentDescription = "Localized description",
                Modifier.size(AssistChipDefaults.IconSize)
            )
        }
    )
}
Chip.kt

これを実装すると次のようになります。

先頭のアイコンとテキストラベルが表示されたシンプルなアシスト チップ。
図 2. アシスト チップ。

フィルタラベル

FilterChip コンポーザブルでは、チップが選択されているかどうかをトラッキングする必要があります。次の例は、ユーザーがチップを選択したときにのみ先頭のチェック アイコンを表示する方法を示しています。

@Composable
fun FilterChipExample() {
    var selected by remember { mutableStateOf(false) }

    FilterChip(
        onClick = { selected = !selected },
        label = {
            Text("Filter chip")
        },
        selected = selected,
        leadingIcon = if (selected) {
            {
                Icon(
                    imageVector = Icons.Filled.Done,
                    contentDescription = "Done icon",
                    modifier = Modifier.size(FilterChipDefaults.IconSize)
                )
            }
        } else {
            null
        },
    )
}
Chip.kt

この実装は、選択されていない場合は次のようになります。

選択されていないフィルタラベル。チェックマークがなく、背景は無地。
図 3. 選択されていないフィルタラベル。

選択すると、次のように表示されます。

選択されたフィルタ チップ。チェックマークと色付きの背景が表示されています。
図 4. 選択したフィルタチップ。

入力チップ

InputChip コンポーザブルを使用すると、ユーザー操作の結果としてチップを作成できます。たとえば、メール クライアントでユーザーがメールを作成しているときに、入力チップは、ユーザーが [宛先:] フィールドに追加した連絡先を表すことがあります。

次の実装は、選択済みの状態の入力チップを示しています。ユーザーがチップを押すと、チップが閉じます。

@Composable
fun InputChipExample(
    text: String,
    onDismiss: () -> Unit,
) {
    var enabled by remember { mutableStateOf(true) }
    if (!enabled) return

    InputChip(
        onClick = {
            onDismiss()
            enabled = !enabled
        },
        label = { Text(text) },
        selected = enabled,
        avatar = {
            Icon(
                Icons.Filled.Person,
                contentDescription = "Localized description",
                Modifier.size(InputChipDefaults.AvatarSize)
            )
        },
        trailingIcon = {
            Icon(
                Icons.Default.Close,
                contentDescription = "Localized description",
                Modifier.size(InputChipDefaults.AvatarSize)
            )
        },
    )
}
Chip.kt

これを実装すると次のようになります。

アバターと末尾のアイコンを含む入力チップ。
図 5. 入力チップ。

候補ワード

SuggestionChip コンポーザブルは、API 定義と一般的なユースケースの両方において、このページに記載されているコンポーザブルの中で最も基本的なものです。候補チップには、動的に生成されたヒントが表示されます。たとえば、AI チャットアプリでは、候補ワードを使用して、最新のメッセージに対する返信の候補を表示できます。

SuggestionChip の次の実装について考えてみましょう。

@Composable
fun SuggestionChipExample() {
    SuggestionChip(
        onClick = { Log.d("Suggestion chip", "hello world") },
        label = { Text("Suggestion chip") }
    )
}
Chip.kt

これを実装すると次のようになります。

シンプルな候補ワード。
図 6. 候補ワード。

チップを挿入しました

このドキュメントの例はすべて、フラットな外観のベース コンポーザブルを使用しています。外観が強調されたチップが必要な場合は、次の 3 つのコンポーザブルのいずれかを使用します。

参考情報