Switch
コンポーネントを使用すると、ユーザーはオンとオフの 2 つの状態を切り替えることができます。アプリでは、スイッチを使用してユーザーに次のいずれかを許可できます。
- 設定のオンとオフを切り替えます。
- 機能を有効または無効にします。
- オプションを選択します。
このコンポーネントは、つまみとトラックの 2 つの部分で構成されています。つまみがドラッグ可能な部分で、トラックが背景になります。ユーザーはつまみを左右にドラッグしてスイッチの状態を変更できます。スイッチをタップして確認、消去することもできます。
基本的な実装
完全な API 定義については、Switch
リファレンスをご覧ください。使用する必要のある主なパラメータは次のとおりです。
checked
: スイッチの初期状態。onCheckedChange
: スイッチの状態が変化したときに呼び出されるコールバック。enabled
: スイッチが有効か無効か。colors
: スイッチに使用される色。
次の例は、Switch
コンポーザブルの最小限の実装を示しています。
@Composable fun SwitchMinimalExample() { var checked by remember { mutableStateOf(true) } Switch( checked = checked, onCheckedChange = { checked = it } ) }
この実装は、チェックボックスをオフにすると次のように表示されます。
オンにした場合の外観は次のようになります。
高度な実装
より高度なスイッチを実装するときに使用する主なパラメータは次のとおりです。
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 } ) }
この実装では、未確認の外観は前のセクションの例と同じです。ただし、オンにすると、この実装は次のようになります。
カスタムの色
次の例では、色パラメータを使用して、スイッチがオンになっているかどうかを考慮して、スイッチのつまみとトラックの色を変更する方法を示します。
@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, ) ) }
これを実装すると次のようになります。