नेविगेशन रेल

रेल की मदद से, बड़ी स्क्रीन वाले डिवाइसों पर चलने वाले ऐप्लिकेशन में मौजूद डेस्टिनेशन को ऐक्सेस किया जा सकता है. नेविगेशन रेल का इस्तेमाल इनके लिए किया जाना चाहिए:

  • ऐसे टॉप-लेवल डेस्टिनेशन जिन्हें ऐप्लिकेशन में कहीं से भी ऐक्सेस किया जा सकता है
  • तीन से सात मुख्य जगहें
  • टैबलेट या डेस्कटॉप लेआउट
स्क्रीन की बाईं ओर वर्टिकल नेविगेशन रेल है. इसमें चार डेस्टिनेशन (सभी फ़ाइलें, हाल ही में, फ़ोटो, और लाइब्रेरी) हैं. हर डेस्टिनेशन के साथ एक आइकॉन और फ़्लोटिंग ऐक्शन बटन जुड़ा हुआ है.
पहली इमेज. चार डेस्टिनेशन और फ़्लोटिंग ऐक्शन बटन वाली नेविगेशन रेल.

इस पेज पर, आपके ऐप्लिकेशन में मिलती-जुलती स्क्रीन और बुनियादी नेविगेशन के साथ रेल दिखाने का तरीका बताया गया है.

एपीआई सरफ़ेस

अपने ऐप्लिकेशन में रेल लागू करने के लिए, NavigationRailItem के साथ NavigationRail कंपोज़ेबल का इस्तेमाल करें. NavigationRailItem, रेल कॉलम में मौजूद किसी रेल आइटम को दिखाता है.

NavigationRailItem में ये मुख्य पैरामीटर शामिल हैं:

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

उदाहरण: रेल-आधारित नेविगेशन

नीचे दिए गए स्निपेट में, नेविगेशन रेल को लागू किया गया है, ताकि उपयोगकर्ता ऐप्लिकेशन में अलग-अलग स्क्रीन के बीच नेविगेट कर सकें:

@Composable
fun NavigationRailExample(modifier: Modifier = Modifier) {
    val navController = rememberNavController()
    val startDestination = Destination.SONGS
    var selectedDestination by rememberSaveable { mutableIntStateOf(startDestination.ordinal) }

    Scaffold(modifier = modifier) { contentPadding ->
        NavigationRail(modifier = Modifier.padding(contentPadding)) {
            Destination.entries.forEachIndexed { index, destination ->
                NavigationRailItem(
                    selected = selectedDestination == index,
                    onClick = {
                        navController.navigate(route = destination.route)
                        selectedDestination = index
                    },
                    icon = {
                        Icon(
                            destination.icon,
                            contentDescription = destination.contentDescription
                        )
                    },
                    label = { Text(destination.label) }
                )
            }
        }
        AppNavHost(navController, startDestination)
    }
}

खास बातें

  • NavigationRail में रेल आइटम का वर्टिकल कॉलम दिखता है. इसमें हर आइटम, Destination से मेल खाता है.
  • val navController = rememberNavController(), NavHostController का एक इंस्टेंस बनाता है और उसे सेव करता है. यह इंस्टेंस, NavHost में नेविगेशन को मैनेज करता है.
  • var selectedDestination by rememberSaveable { mutableIntStateOf(startDestination.ordinal) }, चुने गए रेल आइटम की स्थिति को मैनेज करता है.
    • startDestination.ordinal, Destination.SONGS enum एंट्री का संख्यात्मक इंडेक्स (पोजीशन) दिखाता है.
  • जब किसी रेल आइटम पर क्लिक किया जाता है, तो उससे जुड़ी स्क्रीन पर जाने के लिए navController.navigate(route = destination.route) को कॉल किया जाता है.
  • onClick का लैम्डा, NavigationRailItem selectedDestination की स्थिति को अपडेट करता है, ताकि क्लिक किए गए रेल आइटम को हाइलाइट किया जा सके.
  • यह AppNavHost कंपोज़ेबल को कॉल करता है और navController और startDestination को पास करता है, ताकि चुनी गई स्क्रीन का असली कॉन्टेंट दिखाया जा सके.

नतीजा

नीचे दी गई इमेज में, पिछले स्निपेट का नतीजा दिखाया गया है:

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

अन्य संसाधन