Compose में कस्टम डिज़ाइन सिस्टम जोड़ना

Material हमारा सुझाया गया डिज़ाइन सिस्टम है और Jetpack Compose मटीरियल को लागू करने की सुविधा देता है. हालांकि, आपको इसे इस्तेमाल करने के लिए मजबूर नहीं किया जाता है. Material पूरी तरह से सार्वजनिक एपीआई पर आधारित है. इसलिए, इसी तरह से अपना डिज़ाइन सिस्टम बनाया जा सकता है.

इसके लिए, ये तरीके अपनाए जा सकते हैं:

• थीम वाली अन्य वैल्यू के साथ MaterialTheme को बढ़ाया जा रहा है
• एक या उससे ज़्यादा Material सिस्टम — Colors, Typography या Shapes — को कस्टम तरीके से लागू करके बदलना, जबकि बाकी सिस्टम को बनाए रखना
• MaterialTheme को बदलने के लिए, पूरी तरह से कस्टम डिज़ाइन सिस्टम लागू करना

आपके पास कस्टम डिज़ाइन सिस्टम के साथ, Material कॉम्पोनेंट का इस्तेमाल जारी रखने का विकल्प भी है. ऐसा करना मुमकिन है, लेकिन आपने जो तरीका अपनाया है, उसके हिसाब से कुछ चीज़ों का ध्यान रखना ज़रूरी है.

MaterialTheme और कस्टम डिज़ाइन सिस्टम के इस्तेमाल किए जाने वाले लोअर-लेवल कॉन्स्ट्रक्ट और एपीआई के बारे में ज़्यादा जानने के लिए, Compose में थीम के बारे में जानकारी गाइड देखें.

मटीरियल थीम को एक्सटेंड करना

Compose Material, Material थीम के मॉडल के हिसाब से काम करता है. इससे, 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 के इस्तेमाल से जुड़े एपीआई के साथ एक जैसी सुविधा मिलती है. Compose के मुताबिक, surfaceColorAtElevation इसका एक उदाहरण है. इससे, ऊंचाई के हिसाब से इस्तेमाल किए जाने वाले सतह के रंग का पता चलता है.

ध्यान दें: इस तरीके का सुझाव सिर्फ़ थीम की वैल्यू जोड़ने या ऐसी वैल्यू के लिए दिया जाता है जो अलग-अलग थीम में एक जैसी होती हैं. अगर आपके पास एक से ज़्यादा थीम हैं, तो नई प्रॉपर्टी के साथ क्लास तय करना बेहतर होता है.

दूसरा तरीका, एक ऐसी एक्सटेंडेड थीम तय करना है जो MaterialTheme और उसकी वैल्यू को "रैप" करती है.

मान लें कि आपको दो और रंग जोड़ने हैं — caution और onCaution, एक पीला रंग, जिसका इस्तेमाल थोड़ी खतरनाक कार्रवाइयों के लिए किया जाता है — और साथ ही, मौजूदा मटीरियल कलर बनाए रखना है:

@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 के इस्तेमाल से जुड़े एपीआई जैसा ही है. इसमें एक से ज़्यादा थीम भी काम करती हैं, क्योंकि ExtendedTheme को MaterialTheme की तरह ही नेस्ट किया जा सकता है.

Material Components का इस्तेमाल करना

Material थीमिंग को एक्सटेंड करने पर, मौजूदा MaterialTheme वैल्यू बरकरार रहती हैं और Material कॉम्पोनेंट के लिए अब भी डिफ़ॉल्ट वैल्यू का इस्तेमाल किया जाता है.

अगर आपको कॉम्पोनेंट में एक्सटेंड की गई वैल्यू का इस्तेमाल करना है, तो उन्हें अपने कॉम्पोज़ेबल फ़ंक्शन में रैप करें. इसके बाद, उन वैल्यू को सीधे सेट करें जिनमें बदलाव करना है. साथ ही, अन्य वैल्यू को पैरामीटर के तौर पर कॉम्पोज़ेबल में दिखाएं:

@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

Material के सब-सिस्टम बदलें

हो सकता है कि आप Material थीमिंग को बढ़ाने के बजाय, एक या उससे ज़्यादा सिस्टम — Colors, Typography या Shapes — को पसंद के मुताबिक लागू करने के साथ बदलना चाहें. ऐसा करने पर, अन्य सिस्टम पहले की तरह ही काम करते रहेंगे.

मान लें कि आपको कलर सिस्टम को बनाए रखते हुए, टाइप और शेप सिस्टम बदलने हैं, तो:

@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 के एक या एक से ज़्यादा सिस्टम बदल दिए जाते हैं, तो Material कॉम्पोनेंट को बिना बदलाव के इस्तेमाल करने पर, Material के रंग, टाइप या आकार की गलत वैल्यू दिख सकती हैं.

अगर आपको कॉम्पोनेंट में बदली गई वैल्यू का इस्तेमाल करना है, तो उन्हें अपने कॉम्पोज़ेबल फ़ंक्शन में रैप करें. इसके बाद, सीधे तौर पर काम के सिस्टम के लिए वैल्यू सेट करें और अन्य वैल्यू को पैरामीटर के तौर पर कॉम्पोज़ेबल में दिखाएं.

ध्यान दें: ऐसा हो सकता है कि मटीरियल कंपोज़ेबल में सभी वैल्यू, पैरामीटर के तौर पर न दिखें, खास तौर पर CompositionLocal कंपोज़ेबल (जैसे, LocalTextStyle) के साथ. ऐसे मामलों में, आपको content lambdas को, सेवा देने वाले के फ़ंक्शन (जैसे ProvideTextStyle) में रैप करना पड़ सकता है.

@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 को लागू किया गया

अगर आपको Material कॉम्पोनेंट का इस्तेमाल जारी रखना है, तो आपको अपनी कस्टम थीम या थीम में इनमें से कुछ सिस्टम बदलने होंगे. इसके अलावा, अनचाहे व्यवहार से बचने के लिए, अपने कॉम्पोनेंट में सिस्टम मैनेज करने होंगे.

हालांकि, डिज़ाइन सिस्टम सिर्फ़ उन कॉन्सेप्ट तक सीमित नहीं हैं जिन पर Material डिज़ाइन फ़्रेमवर्क आधारित है. आपके पास मौजूदा सिस्टम में बदलाव करने और नई क्लास और टाइप के साथ पूरी तरह से नए सिस्टम बनाने का विकल्प है. इससे, अन्य कॉन्सेप्ट को थीम के साथ काम करने लायक बनाया जा सकता है.

नीचे दिए गए कोड में, हम एक कस्टम कलर सिस्टम मॉडल करते हैं, जिसमें ग्रेडिएंट (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

Material Components का इस्तेमाल करना

अगर कोई MaterialTheme मौजूद नहीं है, तो Material कॉम्पोनेंट को बिना बदलाव के इस्तेमाल करने पर, आपको अनचाहे Material कलर, टाइप, और शेप की वैल्यू दिखेंगी. साथ ही, इंडिकेशन का व्यवहार भी गलत होगा.

अगर आपको कॉम्पोनेंट में कस्टम वैल्यू का इस्तेमाल करना है, तो उन्हें अपने कंपोज़ेबल फ़ंक्शन में रैप करें और सीधे संबंधित सिस्टम के लिए वैल्यू सेट करें. साथ ही, कंपोज़ेबल में अन्य वैल्यू को पैरामीटर के तौर पर दिखाएं.

हमारा सुझाव है कि आप अपनी कस्टम थीम से सेट की गई वैल्यू को ऐक्सेस करें. इसके अलावा, अगर आपकी थीम में 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

ध्यान दें: Button, Ripple Indication उपलब्ध कराने के लिए, rememberRipple() का इंटरनल तौर पर इस्तेमाल करता है. मौजूदा कॉम्पोनेंट को रैप करने वाले दूसरे कस्टम कॉम्पोनेंट को लागू करते समय, सोर्स कोड की जांच करना एक अच्छा आइडिया है.

अगर आपने ग्रेडिएंट दिखाने के लिए, List<Color> जैसी नई क्लास टाइप को शामिल किया है, तो कॉम्पोनेंट को रैप करने के बजाय, उन्हें शुरू से लागू करना बेहतर होगा. उदाहरण के लिए, Jetsnack के सैंपल में JetsnackButton देखें.