Skip to content

A Multiplatform Jetpack Compose Table Component Implementation

License

Notifications You must be signed in to change notification settings

windedge/compose-table

Repository files navigation

Compose Table

This is a Compose Multiplatform table library that supports both Material and Material3 designs.

screen

Supported Platforms

  • Android
  • Desktop
  • iOS
  • WasmJS

Usage

Setup

Add the MavenCentral repository to your build file

repositories {
    ...
    mavenCentral()
}

Add dependency

implementation("io.github.windedge.table:table-m2:<version>")
// or
implementation("io.github.windedge.table:table-m3:<version>")

Static Data Table

import androidx.compose.material3.Text
import io.github.windedge.table.DataTable

val data = listOf(
    mapOf("Name" to "John Doe", "Age" to "30", "Email" to "john.doe@example.com"),
    mapOf("Name" to "Jane Doe", "Age" to "25", "Email" to "jane.doe@example.com")
)

DataTable(
    columns = {
        headerBackground {
            Box(modifier = Modifier.background(color = Color.LightGray))
        }
        column { Text("Name") }
        column { Text("Age") }
        column { Text("Email") }
    }
) {
    data.forEach { record ->
        row(modifier = Modifier) {
            cell { Text(record["Name"] ?: "") }
            cell { Text(record["Age"] ?: "") }
            cell { Text(record["Email"] ?: "") }
        }
    }
}

Paginated Data Table

import androidx.compose.material3.Text
import io.github.windedge.table.m3.PaginatedDataTable
import io.github.windedge.table.rememberPaginationState

val data = List(50) {
    mapOf("Column 1" to "Item $it", "Column 2" to "Item $it", "Column 3" to "Item $it")
}
val paginationState = rememberPaginationState(data.size, pageSize = 5)

PaginatedDataTable(
    columns = {
        headerBackground {
            Box(Modifier.background(colorScheme.primary))
        }
        column { Text("Column 1") }
        column { Text("Column 2") }
        column { Text("Column 3") }
    },
    paginationState = paginationState,
    onPageChanged = {
        data.chunked(it.pageSize)[it.pageIndex - 1]
    }
) { item: Map<String, String> ->
    row(modifier = Modifier) {
        cell { Text(item["Column 1"] ?: "") }
        cell { Text(item["Column 2"] ?: "") }
        cell { Text(item["Column 3"] ?: "") }
    }
}

Please check the sample app for a more detailed showcase.

Known Issues

Since the Compose Resources is relatively new and still under development, a bug in the WASM platform is causing the paginator icons to fail to load as expected.

Credits

This project is inspired by compose-data-table.

License

This project is licensed under the MIT License.

About

A Multiplatform Jetpack Compose Table Component Implementation

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages