An open API service indexing awesome lists of open source software.

https://github.com/tunjid/tiler

Experimental declaratively transparent kotlin multiplatform paging library
https://github.com/tunjid/tiler

android compose ios jetpack-compose kotlin kotlin-multiplatform kotlin-multiplatform-library kotlin-multiplatform-sample multiplatform pagination paging

Last synced: about 2 months ago
JSON representation

Experimental declaratively transparent kotlin multiplatform paging library

Awesome Lists containing this project

README

        

# Tiler

[![JVM Tests](https://github.com/tunjid/Tiler/actions/workflows/tests.yml/badge.svg)](https://github.com/tunjid/Tiler/actions/workflows/tests.yml)
![Tiler](https://img.shields.io/maven-central/v/com.tunjid.tiler/tiler?label=tiler)

![badge][badge-ios]
![badge][badge-js]
![badge][badge-jvm]
![badge][badge-linux]
![badge][badge-windows]
![badge][badge-mac]
![badge][badge-tvos]
![badge][badge-watchos]

Please note, this is not an official Google repository. It is a Kotlin multiplatform experiment that makes no guarantees
about API stability or long term support. None of the works presented here are production tested, and should not be
taken as anything more than its face value.

## Introduction

Tiling is a state based paging implementation that presents a sublist of paged dataset in a simple `List`.
It offers constant time access to items at indices, and the ability to introspect the items paged through.

The following are examples of paged UI/UX paradigms that were built using tiling:

| [Basic pagination](https://tunjid.github.io/Tiler/usecases/basic-example/) | [Pagination with sticky headers](https://tunjid.github.io/Tiler/usecases/compose/#sticky-headers) | [Pagination with search](https://tunjid.github.io/Tiler/usecases/search/) | [Pagination with placeholders](https://tunjid.github.io/Tiler/usecases/placeholders/) |
|----------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------:|:-------------------------------------------------------------------------------------:|
| ![Basic pagination](./docs/images/basic.gif) | ![Pagination with sticky headers](./docs/images/sticky.gif) | ![Pagination with search](./docs/images/search.gif) | ![Pagination with placeholders](./docs/images/placeholders.gif) |

For large screened devices:

| [Pagination with adaptive layouts](https://tunjid.github.io/Tiler/usecases/adaptive-paging/) | [Pagination with adaptive layouts, search and placeholders](https://tunjid.github.io/Tiler/usecases/complex-tiling/) |
|:--------------------------------------------------------------------------------------------:|:--------------------------------------------------------------------------------------------------------------------:|
| ![Pagination with adaptive layouts](./docs/images/adaptive.gif) | ![Pagination with adaptive layouts, search and placeholders](./docs/images/complex.gif) |

Please see the [documentation](https://tunjid.github.io/Tiler/) for more details.

## License

Copyright 2021 Google LLC

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

[badge-android]: http://img.shields.io/badge/-android-6EDB8D.svg?style=flat

[badge-jvm]: http://img.shields.io/badge/-jvm-DB413D.svg?style=flat

[badge-js]: http://img.shields.io/badge/-js-F8DB5D.svg?style=flat

[badge-js-ir]: https://img.shields.io/badge/support-[IR]-AAC4E0.svg?style=flat

[badge-nodejs]: https://img.shields.io/badge/-nodejs-68a063.svg?style=flat

[badge-linux]: http://img.shields.io/badge/-linux-2D3F6C.svg?style=flat

[badge-windows]: http://img.shields.io/badge/-windows-4D76CD.svg?style=flat

[badge-wasm]: https://img.shields.io/badge/-wasm-624FE8.svg?style=flat

[badge-apple-silicon]: http://img.shields.io/badge/support-[AppleSilicon]-43BBFF.svg?style=flat

[badge-ios]: http://img.shields.io/badge/-ios-CDCDCD.svg?style=flat

[badge-mac]: http://img.shields.io/badge/-macos-111111.svg?style=flat

[badge-watchos]: http://img.shields.io/badge/-watchos-C0C0C0.svg?style=flat

[badge-tvos]: http://img.shields.io/badge/-tvos-808080.svg?style=flat