分割ボタン

スプリット ボタンは、2 つのボタンのグループを定義します。先頭のボタンはプライマリ アクションを実行し、末尾のボタンはコンテキストに関連するセカンダリ オプションのセットを開きます。

有効にすると、末尾のメニューボタンのアイコンが回転し、形状が変化します。 スプリット ボタンは、単独で配置することも、同じサイズの他のボタンと並べて配置することもできます。

スプリット ボタンの使用

  • メニューを開き、メイン アクションに関連するサブオプションをユーザーに提供します。
  • 単独で使用することも、標準ボタンやアイコンボタンと組み合わせて使用することもできます。
  • 通常はメニューを開きますが、カードなどの他のコンポーネントを開くようにカスタマイズすることもできます。
  • ボタンやアイコンボタンと同じ 5 つのサイズ(XS、S、M、L、XL)をサポートしています。
複数のサイズとカラースタイルの分割ボタン。
図 1. 複数のサイズとカラースタイルのスプリット ボタン。

例

塗りつぶしスプリット ボタン

塗りつぶしスプリット ボタンは、重要または最終的なアクションに使用される、強調度の高いバリエーションです。次のスニペットは、SplitButtonDefaults.LeadingButton と SplitButtonDefaults.TrailingButton を含む SplitButtonLayout を使用して、塗りつぶしスプリット ボタンを実装しています。

@Composable
fun FilledSplitButtonSample() {
    var checked by rememberSaveable { mutableStateOf(false) }

    SplitButtonLayout(
        leadingButton = {
            SplitButtonDefaults.LeadingButton(onClick = { /* Do Nothing */ }) {
                Icon(
                    painter = rememberVectorPainter(AppIcons.Edit),
                    modifier = Modifier.size(SplitButtonDefaults.LeadingIconSize),
                    contentDescription = null,
                )
                Spacer(Modifier.size(ButtonDefaults.IconSpacing))
                Text("My Button")
            }
        },
        trailingButton = {
            SplitButtonDefaults.TrailingButton(
                checked = checked,
                onCheckedChange = { checked = it },
                modifier =
                    Modifier.semantics {
                        stateDescription = if (checked) "Expanded" else "Collapsed"
                        contentDescription = "Toggle Button"
                    },
            ) {
                val rotation: Float by
                    animateFloatAsState(
                        targetValue = if (checked) 180f else 0f,
                        label = "Trailing Icon Rotation",
                    )
                Icon(
                    painter = rememberVectorPainter(AppIcons.KeyboardArrowDown),
                    modifier =
                        Modifier.size(SplitButtonDefaults.TrailingIconSize).graphicsLayer {
                            this.rotationZ = rotation
                        },
                    contentDescription = null,
                )
            }
        },
    )
}

トーン分割ボタン

トーン分割ボタンは、分割ボタンの中強調バリアントです。次のスニペットでは、SplitButtonLayout 内で SplitButtonDefaults.TonalLeadingButton と SplitButtonDefaults.TonalTrailingButton を使用しています。

@Composable
fun TonalSplitButtonSample() {
    var checked by rememberSaveable { mutableStateOf(false) }

    SplitButtonLayout(
        leadingButton = {
            SplitButtonDefaults.TonalLeadingButton(onClick = { /* Do Nothing */ }) {
                Icon(
                    painter = rememberVectorPainter(AppIcons.Edit),
                    modifier = Modifier.size(SplitButtonDefaults.LeadingIconSize),
                    contentDescription = null,
                )
                Spacer(Modifier.size(ButtonDefaults.IconSpacing))
                Text("My Button")
            }
        },
        trailingButton = {
            SplitButtonDefaults.TonalTrailingButton(
                checked = checked,
                onCheckedChange = { checked = it },
                modifier =
                    Modifier.semantics {
                        stateDescription = if (checked) "Expanded" else "Collapsed"
                        contentDescription = "Toggle Button"
                    },
            ) {
                val rotation: Float by
                    animateFloatAsState(
                        targetValue = if (checked) 180f else 0f,
                        label = "Trailing Icon Rotation",
                    )
                Icon(
                    painter = rememberVectorPainter(AppIcons.KeyboardArrowDown),
                    modifier =
                        Modifier.size(SplitButtonDefaults.TrailingIconSize).graphicsLayer {
                            this.rotationZ = rotation
                        },
                    contentDescription = null,
                )
            }
        },
    )
}