Systemy niestandardowego projektowania elementów w Compose

Chociaż Material jest zalecanym przez nas systemem projektowania, a Jetpack Compose zawiera implementację Material, nie musisz go używać. Material opiera się wyłącznie na publicznych interfejsach API, więc możesz utworzyć własny system projektowania w ten sam sposób.

Możesz to zrobić na kilka sposobów:

Możesz też nadal używać komponentów Material Design z niestandardowym systemem projektowania. Jest to możliwe, ale musisz pamiętać o kilku kwestiach, które zależą od wybranego podejścia.

Aby dowiedzieć się więcej o konstrukcjach i interfejsach API niższego poziomu używanych przez MaterialTheme i niestandardowe systemy projektowania, zapoznaj się z przewodnikiem Anatomy of a theme in Compose (Anatomia motywu w Compose).

Rozszerzanie Material Theming

Compose Material ściśle odzwierciedla Material Theming, dzięki czemu przestrzeganie wytycznych Material Design jest proste i bezpieczne. Można jednak rozszerzyć zestawy kolorów, typografii i kształtów o dodatkowe wartości. Najprostszym sposobem jest dodanie właściwości rozszerzenia:

// 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)

Zapewnia to spójność z interfejsami API wykorzystania MaterialTheme. Przykładem takiego elementu zdefiniowanego przez Compose jest surfaceColorAtElevation, który określa kolor powierzchni, który powinien być używany w zależności od wysokości.

Innym podejściem jest zdefiniowanie rozszerzonego motywu, który „opakowuje” MaterialTheme i jego wartości.

Załóżmy, że chcesz dodać 2 dodatkowe kolory – caution i onCaution, czyli żółty kolor używany do działań, które są częściowo niebezpieczne – zachowując dotychczasowe kolory Material:

@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
}

Jest to podobne do interfejsów API wykorzystania MaterialTheme. Obsługuje też wiele motywów, ponieważ możesz zagnieżdżać ExtendedTheme w taki sam sposób jak MaterialTheme.

Używanie komponentów Material Design

Podczas rozszerzania Material Theming istniejące wartości MaterialTheme są zachowywane, a komponenty Material Design nadal mają odpowiednie wartości domyślne.

Jeśli chcesz używać rozszerzonych wartości w komponentach, umieść je we własnych funkcjach typu „composable”, bezpośrednio ustawiając wartości, które chcesz zmienić, i udostępniając inne jako parametry funkcji typu „composable”:

@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
    )
}

Następnie możesz zastąpić użycie Button przez ExtendedButton tam, gdzie jest to odpowiednie.

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

Zastępowanie podsystemów Material Design

Zamiast rozszerzać Material Theming, możesz zastąpić co najmniej jeden system (ColorScheme, Typography lub Shapes) niestandardową implementacją, zachowując pozostałe.

Załóżmy, że chcesz zastąpić systemy typów i kształtów, zachowując system kolorów:

@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
}

Używanie komponentów Material Design

Jeśli co najmniej 1 system MaterialTheme został zastąpiony, użycie komponentów Material Design w niezmienionej postaci może spowodować, że wartości kolorów, typów lub kształtów Material Design będą niepożądane.

Jeśli chcesz używać wartości zastępczych w komponentach, umieść je we własnych funkcjach typu „composable”, bezpośrednio ustawiając wartości dla odpowiedniego systemu i udostępniając inne jako parametry dla funkcji typu „composable”.

@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()
            }
        }
    )
}

Następnie możesz zastąpić użycie Button przez ReplacementButton tam, gdzie jest to odpowiednie.

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

Wdrażanie w pełni niestandardowego systemu projektowania

Możesz zastąpić Material Theming w pełni niestandardowym systemem projektowania. Załóżmy, że MaterialTheme udostępnia te systemy:

  • ColorScheme, Typography i Shapes: systemy Material Theming
  • TextSelectionColors: kolory używane do zaznaczania tekstu przez Text i TextField
  • ripple, podany jako LocalIndication: materialna implementacja Indication

Jeśli chcesz nadal używać komponentów Material, musisz zastąpić niektóre z tych systemów w motywach niestandardowych lub obsługiwać je w komponentach, aby uniknąć niepożądanego działania.

Systemy projektowania nie ograniczają się jednak do koncepcji, na których opiera się Material. Możesz modyfikować istniejące systemy i wprowadzać zupełnie nowe – z nowymi klasami i typami – aby inne koncepcje były zgodne z motywami.

W poniższym kodzie modelujemy niestandardowy system kolorów, który obejmuje gradienty (List<Color>), system typów i nowy system wysokości, a wyklucza inne systemy udostępniane przez MaterialTheme:

Zrzut ekranu interfejsu aplikacji mobilnej przedstawiający niestandardowy system projektowania z elementami wykorzystującymi gradienty kolorów, niestandardową typografię i wysokość. 

@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
}

Używanie komponentów Material Design

Jeśli nie ma MaterialTheme, użycie komponentów Material Design w obecnej postaci spowoduje, że wartości kolorów, typów i kształtów oraz zachowanie wskaźników będą niepożądane.

Jeśli chcesz używać wartości niestandardowych w komponentach, umieść je we własnych funkcjach typu „composable”, bezpośrednio ustawiając wartości dla odpowiedniego systemu i udostępniając inne jako parametry funkcji typu „composable”.

Zalecamy uzyskiwanie dostępu do wartości ustawionych w motywie niestandardowym. Jeśli Twój motyw nie obsługuje Color, TextStyle, Shape ani innych systemów, możesz zakodować je na stałe.

@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)

Jeśli wprowadzono nowe typy klas, np. List<Color> do reprezentowania gradientów, lepiej może być zaimplementować komponenty od podstaw, zamiast je opakowywać. Przykład znajdziesz w JetsnackButton w przykładowej aplikacji Jetsnack.