Skip to content

Releases: Taocent/ComposeRichEditor

v0.1.0-alpha01

10 Jun 04:46
@Taocent Taocent
v0.1.0-alpha01
2544cc2

Choose a tag to compare

View all tags
v0.1.0-alpha01 Latest
Latest

ComposeRichEditor 0.1.0-alpha01

This is the first public alpha release of ComposeRichEditor, a Compose Multiplatform rich text editor library for Android, iOS, Desktop, JS, and Wasm JS.

Highlights

  • Provides three Maven artifacts:
    • io.github.taocent:compose-richtext-core:0.1.0-alpha01
    • io.github.taocent:compose-richtext:0.1.0-alpha01
    • io.github.taocent:compose-block-richtext:0.1.0-alpha01
  • Includes a ready-to-use rich text editor with formatting toolbar, emoji panel, hyperlink dialog, JSON export, undo/redo, and platform-specific input handling.
  • Includes an experimental block editor with text blocks, table editing, block navigation, and shared floating toolbar behavior.
  • Supports Android, iOS, Desktop JVM, JS, and Wasm JS targets.
  • Uses Apache-2.0 licensing.
  • Includes English and Chinese documentation.

Installation

Gradle dependencies:

implementation("io.github.taocent:compose-richtext-core:0.1.0-alpha01")
implementation("io.github.taocent:compose-richtext:0.1.0-alpha01")
implementation("io.github.taocent:compose-block-richtext:0.1.0-alpha01")

Use compose-richtext for the standard editor. Add compose-block-richtext only when block editing or table-block workflows are needed.

Experimental API Notice

The block editor APIs are experimental in this alpha release and require explicit opt-in.

Example:

import com.taocent.simple.compose.component.blockrichtext.ExperimentalBlockRichTextApi

@OptIn(ExperimentalBlockRichTextApi::class)
@Composable
fun BlockEditorScreen() {
    val state = rememberBlockState()
    BlockRichTextEditor(state = state)
}

The plain rich text editor APIs are intended to be more stable than blockrichtext, but all APIs may still change before 1.0.0.

Notable Changes

  • Standardized Maven group ID to io.github.taocent.
  • Added Maven Central publishing workflow through GitHub Actions.
  • Added automatic Maven version resolution from GitHub Release tags.
  • Added Maven publishing metadata, signing, and Central Portal bundle upload flow.
  • Moved CustomEmoji and DefaultCustomEmojis into the public richtext-core API package.
  • Marked block editor APIs with ExperimentalBlockRichTextApi.
  • Added English and Chinese README, changelog, contribution guide, security policy, and release draft documentation.

Verified

The release workflow validates:

  • richtext-core JVM tests
  • richtext JVM tests
  • blockrichtext JVM tests
  • common metadata compilation
  • JVM compilation
  • iOS Simulator Arm64 compilation
  • Maven publication artifacts

Local Maven publication has also been verified with publishToMavenLocal.

Known Limitations

  • This is an alpha release; public API names, packages, and behavior may change before stable release.
  • compose-block-richtext is experimental and may have breaking changes in future alpha versions.
  • Web support is experimental and may not fully match Android, iOS, and Desktop behavior.
  • Some package names still use the original project namespace and may be revised before 1.0.0.

中文说明

这是 ComposeRichEditor 的第一个公开 alpha 版本。ComposeRichEditor 是一个面向 Android、iOS、Desktop、JS 和 Wasm JS 的 Compose Multiplatform 富文本编辑器库。

主要内容：

  • 发布三个 Maven artifact：
    • io.github.taocent:compose-richtext-core:0.1.0-alpha01
    • io.github.taocent:compose-richtext:0.1.0-alpha01
    • io.github.taocent:compose-block-richtext:0.1.0-alpha01
  • 提供可直接使用的普通富文本编辑器。
  • 提供实验性的块级编辑器和表格块能力。
  • 支持 Android、iOS、Desktop JVM、JS 和 Wasm JS。
  • 使用 Apache-2.0 许可证。
  • 提供中英文文档。

注意：compose-block-richtext 当前仍是实验性 API，需要显式 opt-in ExperimentalBlockRichTextApi。

这是 alpha 版本，API 在 1.0.0 前仍可能变化。

Assets 2
Loading