チップ

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 コンポーザブルを使用すると、ユーザー操作の結果としてチップを作成できます。たとえば、メール クライアントでユーザーがメールを作成している場合、入力チップは、ユーザーが [to:] フィールドに入力したアドレスの人物を表すことができます。

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

@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 つのコンポーザブルのいずれかを使用します。

参考情報