आइकॉन बटन, ऐसी कार्रवाइयां दिखाते हैं जो उपयोगकर्ता कर सकते हैं. आइकॉन बटन में, साफ़ तौर पर समझ आने वाले आइकॉन का इस्तेमाल किया जाना चाहिए. आम तौर पर, ये आइकॉन सामान्य या अक्सर इस्तेमाल की जाने वाली कार्रवाइयों को दिखाते हैं.
आइकॉन बटन दो तरह के होते हैं:
- डिफ़ॉल्ट: इन बटन से अन्य एलिमेंट खोले जा सकते हैं. जैसे, कोई मेन्यू या खोज.
- टॉगल: ये बटन, बाइनरी कार्रवाइयों को दिखा सकते हैं. इन्हें चालू या बंद किया जा सकता है. जैसे, "पसंदीदा" या "बुकमार्क".
एपीआई सरफ़ेस
स्टैंडर्ड आइकॉन बटन लागू करने के लिए, IconButton कंपोज़ेबल का इस्तेमाल करें. साथ ही, चुने गए और नहीं चुने गए स्टेटस के बीच टॉगल करने वाले बटन के लिए, IconToggleButton का इस्तेमाल करें. फ़िल्ड, फ़िल्ड टोनल या आउटलाइन जैसी अलग-अलग विज़ुअल स्टाइल बनाने के लिए, FilledIconButton, FilledTonalIconButton, और OutlinedIconButton या उनके टॉगल किए जा सकने वाले काउंटरपार्ट FilledIconToggleButton, FilledTonalIconToggleButton, और OutlinedIconToggleButton का इस्तेमाल करें.
IconButton के लिए मुख्य पैरामीटर में ये शामिल हैं:
onClick: एक लैम्ब्डा फ़ंक्शन, जो उपयोगकर्ता के आइकॉन बटन पर टैप करने पर लागू होता है.enabled: यह एक बूलियन है, जो बटन के चालू होने की स्थिति को कंट्रोल करता है.falseहोने पर, बटन उपयोगकर्ता के इनपुट का जवाब नहीं देता.content: बटन के अंदर मौजूद कंपोज़ेबल कॉन्टेंट, आम तौर पर एकIcon.
IconToggleButton के लिए मुख्य पैरामीटर में ये शामिल हैं:
checked: यह एक बूलियन है, जो बटन की चुनी गई स्थिति को कंट्रोल करता है.onCheckedChange: एक लैम्ब्डा फ़ंक्शन, जो उपयोगकर्ता के बटन पर टैप करने पर लागू होता है. इससे, नई स्थिति की जानकारी मिलती है.enabled: यह एक बूलियन है, जो बटन के चालू होने की स्थिति को कंट्रोल करता है.falseहोने पर, बटन उपयोगकर्ता के इनपुट का जवाब नहीं देता.
बुनियादी उदाहरण: टॉगल आइकॉन बटन
टॉगल आइकॉन बटन की मदद से, किसी एक विकल्प को चुना जा सकता है या चुने हुए का निशान हटाया जा सकता है. जैसे, पसंदीदा आइटम की सूची में कुछ जोड़ना या हटाना. IconToggleButton और इसके वैरिएंट इसी मकसद से डिज़ाइन किए गए हैं.
यहां दिए गए उदाहरण में, टॉगल आइकॉन बटन को लागू करने का तरीका बताया गया है. यह बटन, चुने जाने या न चुने जाने के आधार पर अपना लुक बदलता है. इसके लिए, IconButton की मदद से इसकी स्थिति को मैनेज किया जाता है:
@Preview @Composable fun ToggleIconButtonExample() { // isToggled initial value should be read from a view model or persistent storage. var isToggled by rememberSaveable { mutableStateOf(false) } IconButton( onClick = { isToggled = !isToggled } ) { Icon( painter = if (isToggled) painterResource(R.drawable.favorite_filled) else painterResource(R.drawable.favorite), contentDescription = if (isToggled) "Selected icon button" else "Unselected icon button." ) } }
कोड के बारे में अहम बातें
ToggleIconButtonExampleकंपोज़ेबल, टॉगल किए जा सकने वालेIconButtonको तय करता है.mutableStateOf(false),MutableStateऑब्जेक्ट बनाता है, जिसमें बूलियन वैल्यू होती है. शुरुआत में यह वैल्यूfalseहोती है. इससेisToggledएक स्टेट होल्डर बन जाता है. इसका मतलब है कि जब भी इसकी वैल्यू बदलती है, तो Compose यूज़र इंटरफ़ेस (यूआई) को फिर से कंपोज़ करता है.rememberSaveableयह पक्का करता है कि कॉन्फ़िगरेशन में बदलाव होने पर भी,isToggledकी स्थिति बनी रहे. जैसे, स्क्रीन रोटेशन.
IconButtonकाonClickलैम्डा, बटन पर क्लिक करने पर उसके काम करने का तरीका तय करता है. इससे, स्टेटसtrueऔरfalseके बीच टॉगल होता है.Iconकंपोज़ेबल काpainterपैरामीटर,isToggledकी स्थिति के आधार पर, शर्त के मुताबिक अलग-अलगpainterResourceलोड करता है. इससे आइकॉन का विज़ुअल लुक बदल जाता है.- अगर
isToggled,trueहै, तो यह भरा हुआ दिल वाला ड्रॉएबल लोड करता है. - अगर
isToggled,falseहै, तो यह आउटलाइन वाले दिल के ड्रॉएबल को लोड करता है.
- अगर
IconकाcontentDescriptionभीisToggledकी स्थिति के आधार पर अपडेट होता है, ताकि सुलभता से जुड़ी सही जानकारी दी जा सके.
नतीजा
इस इमेज में, ऊपर दिए गए स्निपेट से टॉगल आइकॉन बटन को चुना गया है:
ऐडवांस उदाहरण: बटन दबाने पर बार-बार होने वाली कार्रवाइयां
इस सेक्शन में, आइकॉन वाले ऐसे बटन बनाने का तरीका बताया गया है जो उपयोगकर्ता के उन्हें दबाकर रखने पर, लगातार कोई कार्रवाई ट्रिगर करते हैं. ऐसा करने पर, हर क्लिक पर सिर्फ़ एक बार कार्रवाई ट्रिगर नहीं होती.
@Composable fun MomentaryIconButton( unselectedImage: Int, selectedImage: Int, contentDescription: String, modifier: Modifier = Modifier, stepDelay: Long = 100L, // Minimum value is 1L milliseconds. onClick: () -> Unit ) { val interactionSource = remember { MutableInteractionSource() } val isPressed by interactionSource.collectIsPressedAsState() val pressedListener by rememberUpdatedState(onClick) LaunchedEffect(isPressed) { while (isPressed) { delay(stepDelay.coerceIn(1L, Long.MAX_VALUE)) pressedListener() } } IconButton( modifier = modifier, onClick = onClick, interactionSource = interactionSource ) { Icon( painter = if (isPressed) painterResource(id = selectedImage) else painterResource(id = unselectedImage), contentDescription = contentDescription, ) } }
कोड के बारे में अहम बातें
MomentaryIconButton,unselectedImage: Intको लेता है. यह बटन न दबाए जाने पर, आइकॉन के लिए ड्रॉ करने लायक संसाधन का आईडी होता है. साथ ही,selectedImage: Intको लेता है. यह बटन दबाए जाने पर, आइकॉन के लिए ड्रॉ करने लायक संसाधन का आईडी होता है.- यह
interactionSourceका इस्तेमाल करके, उपयोगकर्ता के "दबाएं" इंटरैक्शन को ट्रैक करता है. - बटन को दबाए रखने पर,
isPressedकी वैल्यू true होती है. बटन को दबाए न रखने पर, इसकी वैल्यू false होती है. जबisPressed,trueहोता है, तोLaunchedEffectएक लूप में चला जाता है.- इस लूप के अंदर, यह
delay(stepDelayके साथ) का इस्तेमाल करता है, ताकि ट्रिगर होने वाली कार्रवाइयों के बीच कुछ समय का गैप रहे.coerceInयह पक्का करता है कि इनफ़ाइनाइट लूप को रोकने के लिए, देरी कम से कम एक मिलीसेकंड की हो. - लूप में हर बार देरी होने के बाद,
pressedListenerको शुरू किया जाता है. इससे कार्रवाई दोहराई जाती है.
- इस लूप के अंदर, यह
pressedListener,rememberUpdatedStateका इस्तेमाल करता है, ताकि यह पक्का किया जा सके किonClickलैम्ब्डा (परफ़ॉर्म की जाने वाली कार्रवाई) हमेशा सबसे नए कंपोज़िशन के हिसाब से अप-टू-डेट हो.Icon, बटन को दबाए जाने या न दबाए जाने के आधार पर, दिखाई गई इमेज को बदलता है.- अगर
isPressedसही है, तोselectedImageदिखता है. - ऐसा न होने पर,
unselectedImageदिखाया जाता है.
- अगर
इसके बाद, इस MomentaryIconButton का इस्तेमाल करके एक उदाहरण दें. यहां दिए गए स्निपेट में,
काउंटर को कंट्रोल करने वाले दो आइकॉन बटन दिखाए गए हैं:
@Preview() @Composable fun MomentaryIconButtonExample() { var pressedCount by remember { mutableIntStateOf(0) } Row( modifier = Modifier.fillMaxWidth(), verticalAlignment = Alignment.CenterVertically ) { MomentaryIconButton( unselectedImage = R.drawable.fast_rewind, selectedImage = R.drawable.fast_rewind_filled, stepDelay = 100L, onClick = { pressedCount -= 1 }, contentDescription = "Decrease count button" ) Spacer(modifier = Modifier) Text("advanced by $pressedCount frames") Spacer(modifier = Modifier) MomentaryIconButton( unselectedImage = R.drawable.fast_forward, selectedImage = R.drawable.fast_forward_filled, contentDescription = "Increase count button", stepDelay = 100L, onClick = { pressedCount += 1 } ) } }
कोड के बारे में अहम बातें
MomentaryIconButtonExampleकंपोज़ेबल, एकRowदिखाता है. इसमें दोMomentaryIconButtonइंस्टेंस और एकTextकंपोज़ेबल होता है. इससे काउंटर को बढ़ाने और घटाने के लिए यूज़र इंटरफ़ेस (यूआई) बनाया जाता है.- यह
rememberऔरmutableIntStateOfका इस्तेमाल करके,pressedCountके लिए म्यूटेबल स्टेट वैरिएबल को बनाए रखता है. इसे 0 पर शुरू किया जाता है.pressedCountमें बदलाव होने पर, उसे मॉनिटर करने वाले सभी कंपोज़ेबल (जैसे,Textकंपोज़ेबल) फिर से कंपोज़ होते हैं, ताकि नई वैल्यू दिख सके. - क्लिक करने या दबाकर रखने पर, पहले
MomentaryIconButtonकी वैल्यूpressedCountकम हो जाती है. MomentaryIconButtonपर क्लिक करने या उसे दबाकर रखने पर, सेकंडpressedCountबढ़ जाते हैं.- दोनों बटन 100 मिलीसेकंड के
stepDelayका इस्तेमाल करते हैं. इसका मतलब है कि बटन को दबाकर रखने पर,onClickकार्रवाई हर 100 मिलीसेकंड में दोहराई जाती है.
नतीजा
इस वीडियो में, आइकॉन बटन और काउंटर वाला यूज़र इंटरफ़ेस (यूआई) दिखाया गया है:
M3 Expressive अपडेट
M3 Expressive के अपडेट के साथ, आइकॉन बटन में साइज़, कोने, और चौड़ाई के ज़्यादा विकल्प मिलते हैं. साथ ही, आइकॉन बटन को दबाने या चुनने पर, उसका आकार बदला जा सकता है. स्टैंडर्ड बटन ग्रुप में रखे जाने पर, आइकॉन बटन दबाने से आस-पास के बटन भी इंटरैक्ट करते हैं.
ऐनिमेटेड शेप
आइकॉन बटन दबाने पर, उनका आकार ऐनिमेट हो सकता है. साथ ही, टॉगल आइकॉन बटन, चुने गए स्टेटस के आधार पर अपने आकार को ऐनिमेट कर सकते हैं. शेप ऐनिमेशन की सुविधा चालू करने के लिए, IconButtonDefaults.shapes() या IconButtonDefaults.toggleableShapes() को IconButton या IconToggleButton के shapes पैरामीटर में पास करें.
आइकॉन बटन
यहां दिए गए स्निपेट में, आइकॉन बटन को लागू करने का तरीका बताया गया है. इस बटन को दबाने पर, इसके आकार में ऐनिमेशन दिखता है:
@Composable fun IconButtonWithAnimatedShapeSample() { IconButton( onClick = { /* doSomething() */ }, shapes = IconButtonDefaults.shapes(), ) { Icon(painter = rememberVectorPainter(AppIcons.LockFilled), contentDescription = "Localized description") } }
टॉगल आइकॉन बटन
यहां दिए गए स्निपेट में, टॉगल आइकॉन बटन को लागू करने का तरीका बताया गया है. यह बटन, अपनी चुनी गई स्थिति के आधार पर अपने आकार को ऐनिमेट करता है:
@Composable fun IconToggleButtonWithAnimatedShapeSample() { var checked by remember { mutableStateOf(false) } IconToggleButton( checked = checked, onCheckedChange = { checked = it }, shapes = IconButtonDefaults.toggleableShapes(), ) { if (checked) { Icon(painter = rememberVectorPainter(AppIcons.LockFilled), contentDescription = "Localized description") } else { Icon(painter = rememberVectorPainter(AppIcons.Lock), contentDescription = "Localized description") } } }
साइज़, चौड़ाई, और आकार के वैरिएंट
आइकॉन बटन, गोल और स्क्वेयर शेप, पांच साइज़, और तीन चौड़ाई में उपलब्ध हैं.
आइकॉन बटन के लिए, M3 एक्सप्रेसिव अपडेट के बारे में ज़्यादा जानने के लिए, मटीरियल डिज़ाइन 3 के आइकॉन बटन से जुड़े दिशा-निर्देश देखें.
आइकॉन बटन के साइज़ के पांच वैरिएंट होते हैं: बहुत छोटा, छोटा, मीडियम, बड़ा, और बहुत बड़ा. हर साइज़ के लिए, चौड़ाई के तीन विकल्प उपलब्ध हैं: यूनिफ़ॉर्म (डिफ़ॉल्ट), नैरो, और वाइड.
आइकॉन बटन, गोल या चौकोर कोने वाले वैरिएंट में उपलब्ध होते हैं. साथ ही, टॉगल आइकॉन बटन को दबाने या चुनने पर, उनका आकार बदल जाता है.
कॉर्नर वैरिएंट में से चुनने के बारे में दिशा-निर्देश पाने के लिए, मटीरियल डिज़ाइन 3 के आइकॉन बटन से जुड़े दिशा-निर्देश देखें.