このページは Cloud Translation API によって翻訳されました。

Compose のカスタムデザインシステム

マテリアルは Google が推奨するデザインシステムであり、Jetpack Compose にはマテリアルの実装が同梱されていますが、これを使用するように強制されているわけではありません。マテリアルは完全に公開 API に基づいて構築されているため、同じ手法で独自のデザインシステムを作成できます。

独自のデザインシステムは、以下の複数のアプローチで作成できます。

テーマ値を追加して MaterialTheme を拡張する
1 つ以上のマテリアルシステム（Colors、Typography、Shapes）をカスタム実装に置き換えながら、他のシステムはそのまま使用する
フルカスタムデザインシステムを実装し、MaterialTheme を置き換える

カスタムデザインでマテリアルコンポーネントを引き続き使用することもできますありません可能ですが、モデルの使用にあたっては次の点に注意してください実践する方法を学びました。

MaterialTheme およびカスタムデザインシステムで使用される下位の構造と API の詳細については、Compose のテーマの構造ガイドをご覧ください。

マテリアルテーマの拡張

Compose Material は、マテリアルテーマ設定を綿密にモデル化し、マテリアルガイドラインに沿った、シンプルかつタイプセーフなものにします。ただし、色、タイポグラフィ、シェイプのセットを使用できます。

最も簡単なアプローチは、拡張プロパティを追加する方法です。

// Use with MaterialTheme.colorScheme.snackbarAction
val ColorScheme.snackbarAction: Color
    @Composable
    get() = if (isSystemInDarkTheme()) Red300 else Red700

// Use with MaterialTheme.typography.textFieldInput
val Typography.textFieldInput: TextStyle
    get() = TextStyle(/* ... */)

// Use with MaterialTheme.shapes.card
val Shapes.card: Shape
    get() = RoundedCornerShape(size = 20.dp)CustomDesignSystem.kt

これにより、MaterialTheme を使用する API との整合性が確保されます。この例は、定義するには、 surfaceColorAtElevation これにより、高度に応じて使用するサーフェスの色が決まります。

もう 1 つの方法は、「ラップ」する拡張テーマを定義することです。MaterialTheme、あります。

caution と onCaution という 2 つの色を追加するとします。黄色い色で表示されます。ただし、既存のマテリアルカラー:

@Immutable
data class ExtendedColors(
    val caution: Color,
    val onCaution: Color
)

val LocalExtendedColors = staticCompositionLocalOf {
    ExtendedColors(
        caution = Color.Unspecified,
        onCaution = Color.Unspecified
    )
}

@Composable
fun ExtendedTheme(
    /* ... */
    content: @Composable () -> Unit
) {
    val extendedColors = ExtendedColors(
        caution = Color(0xFFFFCC02),
        onCaution = Color(0xFF2C2D30)
    )
    CompositionLocalProvider(LocalExtendedColors provides extendedColors) {
        MaterialTheme(
            /* colors = ..., typography = ..., shapes = ... */
            content = content
        )
    }
}

// Use with eg. ExtendedTheme.colors.caution
object ExtendedTheme {
    val colors: ExtendedColors
        @Composable
        get() = LocalExtendedColors.current
}CustomDesignSystem.kt

これは、MaterialTheme を使用する API に似ています。また、複数のテーマをサポートしており、MaterialTheme と同じ方法で ExtendedTheme をネストできます。

マテリアルコンポーネントを使用する

マテリアルテーマを拡張する際、既存の MaterialTheme 値は維持され、マテリアルコンポーネントには引き続き適切なデフォルトが適用されます。

コンポーネントで拡張値を使用する場合は、値を独自の値でラップするコンポーズ可能な関数を使用して、変更する値を直接設定し、他のコンポーザブルを、含まれるコンポーザブルにパラメータとして公開します。

@Composable
fun ExtendedButton(
    onClick: () -> Unit,
    modifier: Modifier = Modifier,
    content: @Composable RowScope.() -> Unit
) {
    Button(
        colors = ButtonDefaults.buttonColors(
            containerColor = ExtendedTheme.colors.caution,
            contentColor = ExtendedTheme.colors.onCaution
            /* Other colors use values from MaterialTheme */
        ),
        onClick = onClick,
        modifier = modifier,
        content = content
    )
}CustomDesignSystem.kt

その後、必要に応じて Button の使用を ExtendedButton に置き換えます。

@Composable
fun ExtendedApp() {
    ExtendedTheme {
        /*...*/
        ExtendedButton(onClick = { /* ... */ }) {
            /* ... */
        }
    }
}CustomDesignSystem.kt

マテリアルサブシステムの置き換え

マテリアルテーマ設定を拡張する代わりに、1 つ以上の Colors、Typography、または Shapes（カスタム実装の場合）維持します

色を維持したまま、タイプ / シェイプのシステムを置き換えるとします。 system:

@Immutable
data class ReplacementTypography(
    val body: TextStyle,
    val title: TextStyle
)

@Immutable
data class ReplacementShapes(
    val component: Shape,
    val surface: Shape
)

val LocalReplacementTypography = staticCompositionLocalOf {
    ReplacementTypography(
        body = TextStyle.Default,
        title = TextStyle.Default
    )
}
val LocalReplacementShapes = staticCompositionLocalOf {
    ReplacementShapes(
        component = RoundedCornerShape(ZeroCornerSize),
        surface = RoundedCornerShape(ZeroCornerSize)
    )
}

@Composable
fun ReplacementTheme(
    /* ... */
    content: @Composable () -> Unit
) {
    val replacementTypography = ReplacementTypography(
        body = TextStyle(fontSize = 16.sp),
        title = TextStyle(fontSize = 32.sp)
    )
    val replacementShapes = ReplacementShapes(
        component = RoundedCornerShape(percent = 50),
        surface = RoundedCornerShape(size = 40.dp)
    )
    CompositionLocalProvider(
        LocalReplacementTypography provides replacementTypography,
        LocalReplacementShapes provides replacementShapes
    ) {
        MaterialTheme(
            /* colors = ... */
            content = content
        )
    }
}

// Use with eg. ReplacementTheme.typography.body
object ReplacementTheme {
    val typography: ReplacementTypography
        @Composable
        get() = LocalReplacementTypography.current
    val shapes: ReplacementShapes
        @Composable
        get() = LocalReplacementShapes.current
}CustomDesignSystem.kt

マテリアルコンポーネントを使用する

MaterialTheme の 1 つ以上のシステムが置き換えられたときにマテリアルコンポーネントをそのまま使用すると、不要なマテリアルの色、タイプ、またはシェイプの値が返されることがあります。

コンポーネントで置換値を使用する場合は、独自の値でラップします。関連するシステムの値を直接設定するコンポーズ可能な関数他のコンポーザブルを、含まれるコンポーザブルにパラメータとして公開します。

@Composable
fun ReplacementButton(
    onClick: () -> Unit,
    modifier: Modifier = Modifier,
    content: @Composable RowScope.() -> Unit
) {
    Button(
        shape = ReplacementTheme.shapes.component,
        onClick = onClick,
        modifier = modifier,
        content = {
            ProvideTextStyle(
                value = ReplacementTheme.typography.body
            ) {
                content()
            }
        }
    )
}CustomDesignSystem.kt

その後、必要に応じて Button の使用を ReplacementButton に置き換えます。

@Composable
fun ReplacementApp() {
    ReplacementTheme {
        /*...*/
        ReplacementButton(onClick = { /* ... */ }) {
            /* ... */
        }
    }
}CustomDesignSystem.kt

フルカスタムデザインシステムを実装する

マテリアルテーマ設定の代わりに、完全なカスタムデザインシステムにすることもできます。 MaterialTheme が次のシステムを提供しているとします。

Colors、Typography、Shapes: マテリアルテーマ設定システム
TextSelectionColors: Text と TextField によるテキスト選択に使用される色
Ripple、RippleTheme: Indication のマテリアル実装

マテリアルコンポーネントを引き続き使用するには、これらのシステムの一部をカスタムテーマまたはテーマで置き換えるか、コンポーネント内でこれらのシステムを処理して、望ましくない動作が発生しないようにする必要があります。

ただし、デザインシステムはマテリアルが依存するコンセプトに限定されません。既存のシステムを変更して、新しいクラスと型を備えたまったく新しいシステムを導入し、他のコンセプトをテーマに対応させることができます。

次のコードでは、グラデーション（List<Color>）を含むカスタムカラーシステムをモデル化し、タイプシステムを含め、新しいエレベーションシステムを導入して、MaterialTheme で提供される他のシステムを除外しています。

@Immutable
data class CustomColors(
    val content: Color,
    val component: Color,
    val background: List<Color>
)

@Immutable
data class CustomTypography(
    val body: TextStyle,
    val title: TextStyle
)

@Immutable
data class CustomElevation(
    val default: Dp,
    val pressed: Dp
)

val LocalCustomColors = staticCompositionLocalOf {
    CustomColors(
        content = Color.Unspecified,
        component = Color.Unspecified,
        background = emptyList()
    )
}
val LocalCustomTypography = staticCompositionLocalOf {
    CustomTypography(
        body = TextStyle.Default,
        title = TextStyle.Default
    )
}
val LocalCustomElevation = staticCompositionLocalOf {
    CustomElevation(
        default = Dp.Unspecified,
        pressed = Dp.Unspecified
    )
}

@Composable
fun CustomTheme(
    /* ... */
    content: @Composable () -> Unit
) {
    val customColors = CustomColors(
        content = Color(0xFFDD0D3C),
        component = Color(0xFFC20029),
        background = listOf(Color.White, Color(0xFFF8BBD0))
    )
    val customTypography = CustomTypography(
        body = TextStyle(fontSize = 16.sp),
        title = TextStyle(fontSize = 32.sp)
    )
    val customElevation = CustomElevation(
        default = 4.dp,
        pressed = 8.dp
    )
    CompositionLocalProvider(
        LocalCustomColors provides customColors,
        LocalCustomTypography provides customTypography,
        LocalCustomElevation provides customElevation,
        content = content
    )
}

// Use with eg. CustomTheme.elevation.small
object CustomTheme {
    val colors: CustomColors
        @Composable
        get() = LocalCustomColors.current
    val typography: CustomTypography
        @Composable
        get() = LocalCustomTypography.current
    val elevation: CustomElevation
        @Composable
        get() = LocalCustomElevation.current
}CustomDesignSystem.kt

マテリアルコンポーネントを使用する

MaterialTheme が存在しない場合、マテリアルコンポーネントをそのまま使用すると、不要なマテリアルの色、タイプ、シェイプの値および表示動作が発生します。

コンポーネントでカスタム値を使用する場合は、値を独自のコンポーザブルでラップします。関連するシステムの値を直接設定してその他はパラメータとして、それを含むコンポーザブルに渡します。

設定した値には、カスタムテーマからアクセスすることをおすすめします。テーマで Color、TextStyle、Shape、またはハードコードできます。

@Composable
fun CustomButton(
    onClick: () -> Unit,
    modifier: Modifier = Modifier,
    content: @Composable RowScope.() -> Unit
) {
    Button(
        colors = ButtonDefaults.buttonColors(
            containerColor = CustomTheme.colors.component,
            contentColor = CustomTheme.colors.content,
            disabledContainerColor = CustomTheme.colors.content
                .copy(alpha = 0.12f)
                .compositeOver(CustomTheme.colors.component),
            disabledContentColor = CustomTheme.colors.content
                .copy(alpha = 0.38f)
        ),
        shape = ButtonShape,
        elevation = ButtonDefaults.elevatedButtonElevation(
            defaultElevation = CustomTheme.elevation.default,
            pressedElevation = CustomTheme.elevation.pressed
            /* disabledElevation = 0.dp */
        ),
        onClick = onClick,
        modifier = modifier,
        content = {
            ProvideTextStyle(
                value = CustomTheme.typography.body
            ) {
                content()
            }
        }
    )
}

val ButtonShape = RoundedCornerShape(percent = 50)CustomDesignSystem.kt

新しいクラス型を導入した場合（例: List<Color> でモデルを表すコンポーネントをゼロから実装する方がよい場合があります。考える必要があります例として、 JetsnackButton Jetsnack サンプルから抽出します。

あなたへのおすすめ

注: JavaScript がオフになっている場合はリンクテキストが表示されます
Compose のマテリアルデザイン 3
Compose でマテリアル 2 からマテリアル 3 に移行する
Compose のテーマの構造

Compose のカスタム デザイン システム

マテリアル テーマの拡張

マテリアル コンポーネントを使用する

マテリアル サブシステムの置き換え

マテリアル コンポーネントを使用する

フルカスタム デザイン システムを実装する

マテリアル コンポーネントを使用する

あなたへのおすすめ

Compose のカスタムデザインシステム

マテリアルテーマの拡張

マテリアルコンポーネントを使用する

マテリアルサブシステムの置き換え

マテリアルコンポーネントを使用する

フルカスタムデザインシステムを実装する

マテリアルコンポーネントを使用する