スイッチ

Switch コンポーネントを使用すると、ユーザーはオンとオフの 2 つの状態を切り替えることができます。アプリでスイッチを使用して、ユーザーが次のいずれかを行えるようにすることができます。

  • 設定をオンまたはオフに切り替えます。
  • 機能を有効または無効にします。
  • オプションを選択します。

このコンポーネントは、つまみとトラックの 2 つの部分で構成されています。つまみはスイッチのドラッグ可能な部分で、トラックは背景です。ユーザーは、つまみを左右にドラッグしてスイッチの状態を変更できます。スイッチをタップして確認し、クリアすることもできます。

ライトモードとダークモードの Switch コンポーネントの例。
図 1. スイッチ コンポーネント。

基本的な実装

完全な API 定義については、Switch リファレンスをご覧ください。使用する必要がある主なパラメータは次のとおりです。

  • checked: スイッチの初期状態。
  • onCheckedChange: スイッチの状態が変化したときに呼び出されるコールバック。
  • enabled: スイッチが有効か無効か。
  • colors: スイッチに使用される色。

次の例は、Switch コンポーザブルの最小限の実装です。

@Composable
fun SwitchMinimalExample() {
    var checked by remember { mutableStateOf(true) }

    Switch(
        checked = checked,
        onCheckedChange = {
            checked = it
        }
    )
}

これを実装すると、チェックボックスがオフの場合は次のようになります。

オフになっている基本的なスイッチ。
図 2. オフのスイッチ。

オンにすると、次のように表示されます。

オンになっている基本的な Switch。
図 3. オンになっているスイッチ。

高度な実装

より高度なスイッチを実装する際に使用する主なパラメータは次のとおりです。

  • thumbContent: チェックされたときのつまみの外観をカスタマイズするために使用します。
  • colors: トラックとつまみの色をカスタマイズするために使用します。

カスタム サムネイル

thumbContent パラメータに任意のコンポーズ可能な関数を渡して、カスタムのつまみを作成できます。次の例は、つまみにカスタム アイコンを使用するスイッチの例です。

@Composable
fun SwitchWithIconExample() {
    var checked by remember { mutableStateOf(true) }

    Switch(
        checked = checked,
        onCheckedChange = {
            checked = it
        },
        thumbContent = if (checked) {
            {
                Icon(
                    imageVector = Icons.Filled.Check,
                    contentDescription = null,
                    modifier = Modifier.size(SwitchDefaults.IconSize),
                )
            }
        } else {
            null
        }
    )
}

この実装では、チェックされていない状態の外観は前のセクションの例と同じです。ただし、チェックすると、この実装は次のようになります。

thumbContent パラメータを使用して、オンのときにカスタム アイコンを表示するスイッチ。
図 4. カスタムのチェック済みアイコンを含むスイッチ。

カスタムカラー

次の例は、colors パラメータを使用して、スイッチがオンになっているかどうかを考慮しながら、スイッチのつまみとトラックの色を変更する方法を示しています。

@Composable
fun SwitchWithCustomColors() {
    var checked by remember { mutableStateOf(true) }

    Switch(
        checked = checked,
        onCheckedChange = {
            checked = it
        },
        colors = SwitchDefaults.colors(
            checkedThumbColor = MaterialTheme.colorScheme.primary,
            checkedTrackColor = MaterialTheme.colorScheme.primaryContainer,
            uncheckedThumbColor = MaterialTheme.colorScheme.secondary,
            uncheckedTrackColor = MaterialTheme.colorScheme.secondaryContainer,
        )
    )
}

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

colors パラメータを使用して、つまみとトラックの両方にカスタムカラーを使用したスイッチを表示するスイッチ。
図 5. カスタムカラーのスイッチ。

参考情報