दो डाइमेंशन वाली स्क्रोलिंग: scrollable2D, draggable2D

Jetpack Compose में, scrollable2D और draggable2D, लो-लेवल मॉडिफ़ायर हैं. इन्हें दो डाइमेंशन में पॉइंटर इनपुट को मैनेज करने के लिए डिज़ाइन किया गया है. स्टैंडर्ड 1D मॉडिफ़ायर scrollable और draggable का इस्तेमाल सिर्फ़ एक ओरिएंटेशन के लिए किया जा सकता है. वहीं, 2D वैरिएंट, X और Y, दोनों ऐक्सिस पर एक साथ मूवमेंट को ट्रैक करते हैं.

उदाहरण के लिए, मौजूदा scrollable मॉडिफ़ायर का इस्तेमाल, एक ओरिएंटेशन में स्क्रोल करने और फ़्लिंग करने के लिए किया जाता है. वहीं, scrollable2d का इस्तेमाल 2D में स्क्रोल करने और फ़्लिंग करने के लिए किया जाता है. इससे आपको ऐसे ज़्यादा जटिल लेआउट बनाने की सुविधा मिलती है जो सभी दिशाओं में घूमते हैं. जैसे, स्प्रेडशीट या इमेज व्यूअर. scrollable2d मॉडिफ़ायर, 2D स्थितियों में नेस्टेड स्क्रोलिंग की सुविधा भी देता है.

पहली इमेज. मैप पर दोनों दिशाओं में पैन करने की सुविधा.

scrollable2D या draggable2D को चुनें

सही एपीआई चुनने के लिए, यह तय करना ज़रूरी है कि आपको किन यूज़र इंटरफ़ेस (यूआई) एलिमेंट को मूव करना है. साथ ही, इन एलिमेंट के लिए आपको किस तरह का फ़िज़िकल बिहेवियर चाहिए.

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

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

अगर आपको किसी कॉम्पोनेंट को ड्रैग करने की सुविधा देनी है, लेकिन आपको फ़्लिंग या नेस्टेड स्क्रोल की सुविधा नहीं चाहिए, तो draggable2D का इस्तेमाल करें.

2D मॉडिफ़ायर लागू करना

यहां दिए गए सेक्शन में, 2D मॉडिफ़ायर इस्तेमाल करने के तरीके के बारे में उदाहरण दिए गए हैं.

Modifier.scrollable2D लागू करना

इस मॉडिफ़ायर का इस्तेमाल उन कंटेनर के लिए करें जिनमें उपयोगकर्ता को कॉन्टेंट को सभी दिशाओं में ले जाना होता है.

2D मूवमेंट का डेटा कैप्चर करना

इस उदाहरण में, 2D मूवमेंट के रॉ डेटा को कैप्चर करने और X,Y ऑफ़सेट दिखाने का तरीका बताया गया है:

@Composable
private fun Scrollable2DSample() {
    // 1. Manually track the total distance the user has moved in both X and Y directions
    var offset by remember { mutableStateOf(Offset.Zero) }

    Box(
        modifier = Modifier
            .fillMaxSize()
            // ...
        contentAlignment = Alignment.Center
    ) {
        Box(
            modifier = Modifier
                .size(200.dp)
                // 2. Attach the 2D scroll logic to capture XY movement deltas
                .scrollable2D(
                    state = rememberScrollable2DState { delta ->
                        // 3. Update the cumulative offset state with the new movement delta
                        offset += delta

                        // Return the delta to indicate the entire movement was handled by this box
                        delta
                    }
                )
                // ...
            contentAlignment = Alignment.Center
        ) {
            Column(horizontalAlignment = Alignment.CenterHorizontally) {
                // 4. Display the current X and Y values from the offset state in real-time
                Text(
                    text = "X: ${offset.x.roundToInt()}",
                    // ...
                )
                Spacer(modifier = Modifier.height(8.dp))
                Text(
                    text = "Y: ${offset.y.roundToInt()}",
                    // ...
                )
            }
        }
    }
}

दूसरी इमेज. बैंगनी रंग का एक बॉक्स, जो उपयोगकर्ता के पॉइंटर को अपनी सतह पर खींचने पर, मौजूदा X और Y कोऑर्डिनेट ऑफ़सेट को ट्रैक करता है और दिखाता है.

ऊपर दिया गया स्निपेट ये काम करता है:

  • यह कुकी, offset का इस्तेमाल करती है. यह एक ऐसी स्थिति होती है जिसमें उपयोगकर्ता के स्क्रोल किए गए कुल डिस्टेंस को सेव किया जाता है.
  • rememberScrollable2DState के अंदर, एक लैम्डा फ़ंक्शन को हर डेल्टा को हैंडल करने के लिए तय किया जाता है. यह डेल्टा, उपयोगकर्ता की उंगली से जनरेट होता है. कोड offset.value += delta, मैन्युअल स्थिति को नई पोज़िशन के साथ अपडेट करता है.
  • Text कॉम्पोनेंट, उस offset स्टेट की मौजूदा X और Y वैल्यू दिखाते हैं. ये वैल्यू, उपयोगकर्ता के ड्रैग करने पर रीयल-टाइम में अपडेट होती हैं.

बड़े व्यूपोर्ट को पैन करना

इस उदाहरण में, कैप्चर किए गए 2D स्क्रोल किए जा सकने वाले डेटा को इस्तेमाल करने का तरीका दिखाया गया है. साथ ही, इसमें ऐसे कॉन्टेंट पर translationX और translationY लागू करने का तरीका दिखाया गया है जो पैरंट कंटेनर से बड़ा है:

@Composable
private fun Panning2DImage() {

    // Manually track the total distance the user has moved in both X and Y directions
    val offset = remember { mutableStateOf(Offset.Zero) }

    // Define how gestures are captured. The lambda is called for every finger movement
    val scrollState = rememberScrollable2DState { delta ->
        offset.value += delta
        delta
    }

    // The Viewport (Container): A fixed-size box that acts as a window into the larger content
    Box(
        modifier = Modifier
            .size(600.dp, 400.dp) // The visible area dimensions
            // ...
            // Hide any parts of the large content that sit outside this container's boundaries
            .clipToBounds()
            // Apply the 2D scroll modifier to intercept touch and fling gestures in all directions
            .scrollable2D(state = scrollState),
        contentAlignment = Alignment.Center,
    ) {
        // The Content: An image given a much larger size than the container viewport
        Image(
            painter = painterResource(R.drawable.cheese_5),
            contentDescription = null,
            modifier = Modifier
                .requiredSize(1200.dp, 800.dp)
                // Manual Scroll Effect: Since scrollable2D doesn't move content automatically,
                // we use graphicsLayer to shift the drawing position based on the tracked offset.
                .graphicsLayer {
                    translationX = offset.value.x
                    translationY = offset.value.y
                },
            contentScale = ContentScale.FillBounds
        )
    }
}

तीसरी इमेज. यह Modifier.scrollable2D की मदद से बनाया गया, दोनों दिशाओं में पैन करने वाला इमेज व्यूपोर्ट है.
चौथी इमेज. यह Modifier.scrollable2D की मदद से बनाया गया, दोनों दिशाओं में पैन होने वाला टेक्स्ट व्यूपोर्ट है.

ऊपर दिए गए स्निपेट में यह जानकारी शामिल है:

  • कंटेनर को एक तय साइज़ (600x400dp) पर सेट किया गया है, जबकि कॉन्टेंट को बहुत बड़ा साइज़ (1200x800dp) दिया गया है, ताकि वह अपने पैरंट के साइज़ के हिसाब से न बदले.
  • कंटेनर पर मौजूद clipToBounds() मॉडिफ़ायर यह पक्का करता है कि बड़े कॉन्टेंट का कोई भी हिस्सा, जो 600x400 बॉक्स के बाहर है वह छिपा रहे.
  • LazyColumn जैसे हाई-लेवल कॉम्पोनेंट के उलट, scrollable2D आपके लिए कॉन्टेंट को अपने-आप ट्रांसफ़र नहीं करता. इसके बजाय, आपको अपने कॉन्टेंट पर ट्रैक किया गया offset लागू करना होगा. इसके लिए, offset ट्रांसफ़ॉर्मेशन या लेआउट ऑफ़सेट का इस्तेमाल करें.graphicsLayer
  • graphicsLayer ब्लॉक में, translationX = offset.value.x और translationY = offset.value.y का इस्तेमाल करके, इमेज या टेक्स्ट की ड्रॉइंग की पोज़िशन को अपनी उंगली की गतिविधि के हिसाब से बदला जा सकता है. इससे स्क्रोलिंग का विज़ुअल इफ़ेक्ट मिलता है.

scrollable2D की मदद से नेस्टेड स्क्रोलिंग लागू करना

इस उदाहरण में दिखाया गया है कि किसी दो दिशाओं में काम करने वाले कॉम्पोनेंट को, एक स्टैंडर्ड एक-डाइमेंशनल पैरंट में कैसे इंटिग्रेट किया जा सकता है. जैसे, वर्टिकल न्यूज़ फ़ीड.

नेस्टेड स्क्रोलिंग लागू करते समय, इन बातों का ध्यान रखें:

  • rememberScrollable2DState के लिए लैंबडा को सिर्फ़ इस्तेमाल किया गया डेल्टा दिखाना चाहिए, ताकि जब बच्चा अपनी सीमा तक पहुंच जाए, तो पैरंट सूची अपने-आप लागू हो जाए.
  • जब कोई उपयोगकर्ता डाइनल फ़्लिंग करता है, तब 2D वेलोसिटी शेयर की जाती है. अगर ऐनिमेशन के दौरान चाइल्ड, बाउंड्री पर पहुंच जाता है, तो बची हुई गति को पैरंट पर भेज दिया जाता है, ताकि स्क्रोलिंग स्वाभाविक तरीके से जारी रहे.

@Composable
private fun NestedScrollable2DSample() {
    var offset by remember { mutableStateOf(Offset.Zero) }
    val maxScrollDp = 250.dp
    val maxScrollPx = with(LocalDensity.current) { maxScrollDp.toPx() }

    Column(
        modifier = Modifier
            .fillMaxSize()
            .verticalScroll(rememberScrollState())
            .background(Color(0xFFF5F5F5)),
        horizontalAlignment = Alignment.CenterHorizontally
    ) {
        Text(
            "Scroll down to find the 2D Box",
            modifier = Modifier.padding(top = 100.dp, bottom = 500.dp),
            style = TextStyle(fontSize = 18.sp, color = Color.Gray)
        )

        // The Child: A 2D scrollable box with nested scroll coordination
        Box(
            modifier = Modifier
                .size(250.dp)
                .scrollable2D(
                    state = rememberScrollable2DState { delta ->
                        val oldOffset = offset

                        // Calculate new potential offset and clamp it to our boundaries
                        val newX = (oldOffset.x + delta.x).coerceIn(-maxScrollPx, maxScrollPx)
                        val newY = (oldOffset.y + delta.y).coerceIn(-maxScrollPx, maxScrollPx)

                        val newOffset = Offset(newX, newY)

                        // Calculate exactly how much was consumed by the child
                        val consumed = newOffset - oldOffset

                        offset = newOffset

                        // IMPORTANT: Return ONLY the consumed delta.
                        // The remaining (unconsumed) delta propagates to the parent Column.
                        consumed
                    }
                )
                // ...
            contentAlignment = Alignment.Center
        ) {
            Column(horizontalAlignment = Alignment.CenterHorizontally) {
                val density = LocalDensity.current
                Text("2D Panning Zone", color = Color.White.copy(alpha = 0.7f), fontSize = 12.sp)
                Spacer(Modifier.height(8.dp))
                Text("X: ${with(density) { offset.x.toDp().value.roundToInt() }}dp", color = Color.White, fontWeight = FontWeight.Bold)
                Text("Y: ${with(density) { offset.y.toDp().value.roundToInt() }}dp", color = Color.White, fontWeight = FontWeight.Bold)
            }
        }

        Text(
            "Once the Purple Box hits Y: 250 or -250,\nthis parent list will take over the vertical scroll.",
            textAlign = TextAlign.Center,
            modifier = Modifier.padding(top = 40.dp, bottom = 800.dp),
            style = TextStyle(fontSize = 14.sp, color = Color.Gray)
        )
    }
}

पांचवीं इमेज. यह वर्टिकल स्क्रोलिंग वाली सूची में मौजूद बैंगनी रंग का बॉक्स है. इसमें 2D मूवमेंट की सुविधा मिलती है. हालांकि, जब बॉक्स का इंटरनल Y-ऑफ़सेट 300 पिक्सल की सीमा तक पहुंच जाता है, तो वर्टिकल स्क्रोल कंट्रोल को पैरंट सूची में पास कर दिया जाता है.

ऊपर दिए गए स्निपेट में:

  • 2D कॉम्पोनेंट, X ऐक्सिस के मूवमेंट का इस्तेमाल करके अंदर की ओर पैन कर सकता है. साथ ही, चाइल्ड कॉम्पोनेंट की वर्टिकल सीमाएं पूरी होने पर, Y ऐक्सिस के मूवमेंट को पैरंट लिस्ट में भेज सकता है.
  • सिस्टम, उपयोगकर्ता को 2D प्लैटफ़ॉर्म पर सीमित रखने के बजाय, इस्तेमाल किए गए डेल्टा की गिनती करता है. साथ ही, बचे हुए डेल्टा को हाइरार्की में ऊपर की ओर भेजता है. इससे यह पक्का होता है कि उपयोगकर्ता अपनी उंगली हटाए बिना, पेज के बाकी हिस्से को स्क्रोल कर सकता है.

Modifier.draggable2D लागू करना

अलग-अलग यूज़र इंटरफ़ेस (यूआई) एलिमेंट को मूव करने के लिए, draggable2D मॉडिफ़ायर का इस्तेमाल करें.

किसी कंपोज़ेबल एलिमेंट को खींचना

इस उदाहरण में, draggable2D के इस्तेमाल का सबसे सामान्य तरीका दिखाया गया है. इसमें किसी उपयोगकर्ता को यूज़र इंटरफ़ेस (यूआई) एलिमेंट को चुनने और उसे पैरंट कंटेनर में कहीं भी रखने की अनुमति दी जाती है.

@Composable
private fun DraggableComposableElement() {
    // 1. Track the position of the floating window
    var offset by remember { mutableStateOf(Offset.Zero) }

    Box(modifier = Modifier.fillMaxSize().background(Color(0xFFF5F5F5))) {
        Box(
            modifier = Modifier
                // 2. Apply the offset to the box's position
                .offset { IntOffset(offset.x.roundToInt(), offset.y.roundToInt()) }
                // ...
                // 3. Attach the 2D drag logic
                .draggable2D(
                    state = rememberDraggable2DState { delta ->
                        // 4. Update the position based on the movement delta
                        offset += delta
                    }
                ),
            contentAlignment = Alignment.Center
        ) {
            Text("Video Preview", color = Color.White, fontSize = 12.sp)
        }
    }
}

छठी इमेज. स्लेटी रंग के बैकग्राउंड पर, बैंगनी रंग के एक छोटे बॉक्स को दूसरी जगह ले जाते हुए दिखाया गया है. इसमें सीधे तौर पर 2D में ड्रैग करने की सुविधा दिखाई गई है. इसमें जैसे ही उपयोगकर्ता अपनी उंगली हटाता है वैसे ही एलिमेंट रुक जाता है.

ऊपर दिए गए कोड स्निपेट में ये शामिल हैं:

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

पैरंट के ड्रैग एरिया के आधार पर, चाइल्ड कंपोज़ेबल को ड्रैग करना

इस उदाहरण में बताया गया है कि draggable2D का इस्तेमाल करके, 2D इनपुट एरिया कैसे बनाया जाता है. इस एरिया में, सिलेक्टर नॉब को किसी खास जगह पर ही घुमाया जा सकता है. ड्रैग किए जा सकने वाले एलिमेंट के उदाहरण में, कॉम्पोनेंट को खुद ही मूव किया जाता है. हालांकि, इस उदाहरण में 2D डेल्टा का इस्तेमाल करके, चाइल्ड कंपोज़ेबल "selector" को कलर पिकर पर मूव किया जाता है:

@Composable
private fun ExampleColorSelector(
    // ...
)  {
    // 1. Maintain the 2D position of the selector in state.
    var selectorOffset by remember { mutableStateOf(Offset.Zero) }

    // 2. Track the size of the background container.
    var containerSize by remember { mutableStateOf(IntSize.Zero) }

    Box(
        modifier = Modifier
            .size(300.dp, 200.dp)
            // Capture the actual pixel dimensions of the container when it's laid out.
            .onSizeChanged { containerSize = it }
            .clip(RoundedCornerShape(12.dp))
            .background(
                brush = remember(hue) {
                    // Create a simple gradient representing Saturation and Value for the given Hue.
                    Brush.linearGradient(listOf(Color.White, Color.hsv(hue, 1f, 1f)))
                }
            )
    ) {
        Box(
            modifier = Modifier
                .size(24.dp)
                .graphicsLayer {
                    // Center the selector on the finger by subtracting half its size.
                    translationX = selectorOffset.x - (24.dp.toPx() / 2)
                    translationY = selectorOffset.y - (24.dp.toPx() / 2)
                }
                // ...
                // 3. Configure 2D touch dragging.
                .draggable2D(
                    state = rememberDraggable2DState { delta ->
                        // 4. Calculate the new position and clamp it to the container bounds
                        val newX = (selectorOffset.x + delta.x)
                            .coerceIn(0f, containerSize.width.toFloat())
                        val newY = (selectorOffset.y + delta.y)
                            .coerceIn(0f, containerSize.height.toFloat())

                        selectorOffset = Offset(newX, newY)
                    }
                )
        )
    }
}

सातवीं इमेज. यह इमेज, रंग के ग्रेडिएंट की है. इसमें एक सफ़ेद रंग का गोलाकार नॉब है. इसे किसी भी दिशा में खींचा जा सकता है. इससे पता चलता है कि चुनी गई रंग की वैल्यू को अपडेट करने के लिए, 2D डेल्टा को कंटेनर की सीमाओं से कैसे जोड़ा जाता है.

ऊपर दिए गए स्निपेट में यह जानकारी शामिल है:

  • यह onSizeChanged मॉडिफ़ायर का इस्तेमाल करके, ग्रेडिएंट कंटेनर के असली डाइमेंशन कैप्चर करता है. चुनने वाले टूल को पता होता है कि किनारे कहां हैं.
  • graphicsLayer के अंदर, यह translationX और translationY को अडजस्ट करता है, ताकि खींचते समय सिलेक्टर बीच में रहे.