Add separator in LazyColum in jetpack compose

Question

I am learning LazyColum in jetpack compose. I want to add Separator in my each item in some condition, please have a look on below MessageList() function. Also I'll add a screenshot to clearly understand what I want. Please make a function reusable. Condions are as follow:-

1. Top and Bottom Separator.

2 Without separator in both Top and Bottom

But problem is that I don't know in idiomatic way in jetpack compose. I did this in Xml using Recyclerview.

import androidx.compose.foundation.lazy.items

@Composable
fun MessageList(messages: List<Message>) {
    LazyColumn {
        items(messages) { message ->
            MessageRow(message)
        }
    }
}

Can you guys help me on this? Many Thanks

Answer 1

Just make it part of your item

LazyColumn {

    items(messages) { message ->
        MessageRow(message)
        Box(Modifier.fillMaxWidth().height(1.dp).background(Color.Red)) //for after every element
    }
}

If you want to add it only on the top/bottom of the list you can use item:

LazyColumn {
    item { Box(Modifier.fillMaxWidth().height(1.dp).background(Color.Red)) }
    items(messages) { message ->
        MessageRow(message)
    }
}

To make it conditional use itemsIndexed

LazyColumn {
    itemsIndexed(messages) { index, message ->
        if(index == 0) {
        //First element, either show divider or don't
        }
        ....
        MessageRow(message)
        ....
        if (index == messages.size) {
        // last item, show divider or don't
        }
    }
}

Answer 2

You just have to add Divider composable to your MessageRow :

@Composable
fun MessageRow(message:Message){
    Column(){
        Divider(Modifier.fillMaxWidth(), thickness = 1.dp, color = Color.LightGray) //above your row
        Row(Modifier.fillMaxWidth){
            
        }
    }
}

Answer 3

I solve like this to show border or hide border.

package com.abc.app.common.composables

import androidx.compose.foundation.layout.*
import androidx.compose.foundation.lazy.LazyColumn
import androidx.compose.foundation.lazy.itemsIndexed
import androidx.compose.material.Divider
import androidx.compose.material.Text
import androidx.compose.runtime.Composable
import androidx.compose.ui.Modifier
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.res.dimensionResource
import androidx.compose.ui.tooling.preview.Preview
import com.abc.app.R
import com.abc.app.theme.Cloudy
import com.abc.app.theme.AbcTheme
import com.abc.app.theme.Red

@Composable
fun <T : Any> LazyListScopeColumn(
    itemList: List<T>,
    content: @Composable (T: Any) -> Unit,
    dividerColor: Color = Cloudy,
    dividerThickness: Int = R.dimen.separator_height_width,
    showDivider: Boolean = true,
) {
    LazyColumn(modifier = Modifier.fillMaxWidth()) {
        itemsIndexed(itemList) { index, item ->
            if (index == 0 && showDivider) {
                Divider(color = dividerColor, thickness = dimensionResource(dividerThickness))
            }
            content(item)
            if (index <= itemList.lastIndex && showDivider) {
                Divider(color = dividerColor, thickness = dimensionResource(dividerThickness))
            }
        }
    }
}

@Preview(showBackground = true)
@Composable
fun LazyColumnListScopePreview() {
    AbcTheme {
        Column {
            Spacer(modifier = Modifier.height(10.dp)
            LazyListScopeColumn(
                listOf("item 1", "item 2"),
                content = { item ->
                    Text(
                        text = "$item",
                        modifier = Modifier.padding(vertical = 10.dp)
                    )
                },
                dividerColor = Red,
            )
            Spacer(modifier = Modifier.height(10.dp))
        }
    }
}

@Preview(showBackground = true)
@Composable
fun LazyColumnListScopePreviewNoBorder() {
    AbcTheme {
        Column {
            Spacer(modifier = Modifier.height(10.dp)
            LazyListScopeColumn(
                listOf("item 1", "item 2"),
                content = { item ->
                    Text(
                        text = "$item",
                        modifier = modifier = Modifier.padding(vertical = 10.dp))
                },
                dividerColor = Red,
                showDivider = false,
            )
            Spacer(modifier = Modifier.height(10.dp))
        }
    }
}