https://github.com/halilozercan/compose-richtext

A collection of Compose libraries for advanced text formatting and alternative display types.
https://github.com/halilozercan/compose-richtext

android compose jetpack-compose kotlin

Last synced: 3 months ago
JSON representation

A collection of Compose libraries for advanced text formatting and alternative display types.

• Host: GitHub
• URL: https://github.com/halilozercan/compose-richtext
• Owner: halilozercan
• License: apache-2.0
• Created: 2020-03-08T02:22:55.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-06-13T07:20:15.000Z (5 months ago)
• Last Synced: 2024-07-12T19:01:46.579Z (4 months ago)
• Topics: android, compose, jetpack-compose, kotlin
• Language: Kotlin
• Homepage: https://halilibo.com/compose-richtext
• Size: 6.73 MB
• Stars: 751
• Watchers: 9
• Forks: 60
• Open Issues: 29
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• mobile-awesome - compose-richtext - A collection of Compose libraries for advanced text formatting and alternative display types. (Multiplatform / Android samples)

README

        
# compose-richtext

[![Maven Central](https://img.shields.io/maven-central/v/com.halilibo.compose-richtext/richtext-ui.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22com.halilibo.compose-richtext%22)

[![GitHub license](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat)](https://www.apache.org/licenses/LICENSE-2.0)

> **Warning**

> compose-richtext library and all its modules are very experimental and undermaintained. The roadmap is unclear at the moment. Thanks for your patience. Fork option is available as always.

A collection of Compose libraries for working with rich text formatting and documents.

`richtext-ui`, `richtext-commonmark`, and `richtext-material-ui` are Kotlin Multiplatform Compose Libraries.

This repo is currently very experimental and really just proofs-of-concept: there are no tests and some things

might be broken or very non-performant.

----

**Documentation is available at [halilibo.com/compose-richtext](https://halilibo.com/compose-richtext).**

----

```kotlin

@Composable fun App() {

  val printController = rememberPrintableController()

  Printable(printController) {

    RichText(Modifier.background(color = Color.White)) {

      Heading(0, "Title")

      Text("Summary paragraph.")

      HorizontalRule()

      BlockQuote {

        Text("A wise person once said…")

      }

    }

  }

  Button(onClick = { printController.print("README") }) {

    Text("PRINT ME")

  }

}

```

## License

```

Copyright 2022 Halil Ozercan

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

   http://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.

```