- Kotlin 99.9%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
10864a3357A style applied across part of an existing emphasis run serialized as crossing delimiters, `*hello ~~there*~~`, which no markdown parser reads back. The markers landed in the reloaded document as literal characters and the styling was lost. toMarkdown now builds typed runs, splits any partially overlapping pair at the crossing point, and emits through a stack so every close mirrors its open. Links are never split, since that would emit the destination twice. |
||
| .github/workflows | ||
| androidApp | ||
| ComposeTextEditor | ||
| ComposeTextEditorFind | ||
| ComposeTextEditorSpellCheck | ||
| docs | ||
| gradle | ||
| iosApp | ||
| kotlin-js-store/wasm | ||
| sampleApp | ||
| sampleAppiOS | ||
| testUtils/countingMeasurer/utils | ||
| .codacy.yaml | ||
| .gitignore | ||
| .markdownlint.json | ||
| build.gradle.kts | ||
| gradle.properties | ||
| gradlew | ||
| gradlew.bat | ||
| LICENSE | ||
| README.md | ||
| sample_screenshot_00.png | ||
| settings.gradle.kts | ||
Compose Text Editor
Compose has been missing a Rich Text Editor since its inception. I've taken a crack at this previously, as have others.
However, they have all suffered from fundamental limitations in BasicTextField, the foundation of
all text entry in Compose.
This project is an attempt to re-implement text entry from scratch to finally have a solution to the various problems.
Why?
I've been trying to implement a spell checking text
field in Compose, and keep running up against
the limitations of BasicTextField. Pretty much out of options, I decided to see what it might take
to replace BasicTextField with something that solved all of my needs.
And now, it's working, and at this point, working pretty well.
- ✅ 100% Compose Multiplatform
- ✅ Efficient rendering and editing of long-form text
- ✅ Rich text with custom spans
- ✅ Expose scroll state
- ✅ Spell checking
- ☑️ CommonMark Spec (partial)
- Inline styles (bold, italics, ect)
- Block styles (code fence, lists, images)
You can Give it a try here, or browse the API reference & recipes.
Features:
- Rich text rendering and editable
- Semi-efficient rendering for long form text (only renders what is visible)
- Semi-efficient data structure for text storage & editing. (but not nearly as efficient as the Gap Buffer BTF2 uses under the hood)
- Cursor movement, clicking, keyboard short cuts, ect
- Text selection (highlighting and edit ops)
- copy/cut/paste
- Exposed scroll state, so we can render scroll bars (BTF1 can't do this)
- Doesn't copy and return full contents on each edit, so again better for longer form text. (BTF2 also works this way, but BTF2 doesn't support AnnotatedString for rich content)
- Support custom Rich Span drawing (this allows us to render the traditional Spell Check red squiggle)
- Emits edit events: so if a single character is inserted, you can collect a Flow, and know exactly what change was made. This makes managing Spell Check much more efficient as you can just respell-check the single word that was changed, rather than everything. (BTF2 now finally offers this!)
- Find & Replace UI: Works exactly as you'd expect.
Platforms
Desktop (JVM), Android, iOS, WASM
Work left to do:
- Copy/Paste of rich text always strips the formatting (this is a Compose MP bug)
- Right-to-Left text is probably broken
- Sentence level spell checking is not working as expected
- Full CommonMark Spec compliance (nested lists)
Want to try it?
Text Editor:
implementation("com.darkrockstudios:composetexteditor:2.0.0")
Spell Checking addon:
implementation("com.darkrockstudios:composetexteditor-spellcheck:2.0.0")
Find & Replace addon:
implementation("com.darkrockstudios:composetexteditor-find:2.0.0")
Really?
I don't know. Maybe. It might not a permanent solution.
BasicTextField2's new state based approach and gap-buffer has reach maturity and includes a lot of what I would need
to replace this, but still cannot handle rich text rendering, still can't emit individual edit events.
So until those are solved, this is the only solution that I am aware of that ticks every box.