https://github.com/sunny-chung/composable-table

A multiplatform Jetpack Compose library that provides a `@Composable` table with automatic layouts.
https://github.com/sunny-chung/composable-table

android android-library compose-multiplatform-library ios jetpack-compose linux macos wasm windows

Last synced: 5 days ago
JSON representation

A multiplatform Jetpack Compose library that provides a `@Composable` table with automatic layouts.

• Host: GitHub
• URL: https://github.com/sunny-chung/composable-table
• Owner: sunny-chung
• License: mit
• Created: 2023-09-02T04:06:41.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-12-29T06:05:56.000Z (about 1 month ago)
• Last Synced: 2025-01-26T03:04:11.034Z (12 days ago)
• Topics: android, android-library, compose-multiplatform-library, ios, jetpack-compose, linux, macos, wasm, windows
• Language: Kotlin
• Homepage:
• Size: 4.79 MB
• Stars: 90
• Watchers: 3
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Composable Table

![Maven Central](https://img.shields.io/maven-central/v/io.github.sunny-chung/composable-table)

A multiplaform Jetpack Compose library that provides a `@Composable` table

with automatic layouts.

![Demo Video](media/composable-table-demo.gif)

## Features

- 2-dimension scrolling

- Automatic cell width and height calculation using the largest one

- Maximum cell width/height could be optionally specified 

- Allowing custom composable and action listeners (e.g. clickable) for each cell

- Infinite table width and height

- Sticky rows and columns

- Straight-forward to use

## What is NOT included

- Lazy cells

- Grid lines (have to be implemented by users themselves inside cells)

## Supported Platforms

- Android

- Desktop (JVM - Windows/MacOS/Linux)

- iOS

- WASM (JS)

## Setup

For multiplatform:

```kotlin

kotlin {

    sourceSets {

        commonMain.dependencies {

            implementation("io.github.sunny-chung:composable-table:")

            

            // ...

```

For single platform:

```kotlin

    dependencies {

        // ...

        implementation("io.github.sunny-chung:composable-table:")

    }

```

## Usage

Below shows an example of minimal usage.

```kotlin

    Table(

        rowCount = 100,

        columnCount = 10

    ) { rowIndex, columnIndex ->

        Text("($rowIndex, $columnIndex)")

    }

```

Please read the [demo app](demo/multiplatform-app/shared/src/commonMain/kotlin/com/sunnychung/lib/android/composabletable/demo/ux/AppView.kt) for a practical usage example.

There is a demo app for each platform.

## Migration notes

Since v1.2.0, Composable Table moves to Maven Central to provide multiplatform support.

Dependency identifier is changed from `com.github.sunny-chung:composable-table` to

`io.github.sunny-chung:composable-table`.

Users using old version can stay at v1.1.0 because no other change is introduced. You can upgrade to

v1.2.0 by changing the dependency identifier and version name to enjoy multiplatform support.

## Troubleshooting

If `maxCellWidthDp` or `maxCellHeightDp` is specified, please do not use `fillMaxXXX` modifiers

in the root composable of cells, or the cell would occupy maximum size unconditionally.

This behaviour is [documented](https://developer.android.com/reference/kotlin/androidx/compose/ui/Modifier#(androidx.compose.ui.Modifier).fillMaxWidth(kotlin.Float)) in the `fillMaxXXX` methods of the Compose Foundation library.

## Contribution

Contributions are welcomed!

Please also raise an issue if you think a must-have feature is missing!