README.md

This project has been archived.

Matrix Rich Text Editor is now actively maintained at element-hq/matrix-rich-text-editor

Matrix Rich Text Editor

A cross-platform rich text editor intended for use in Matrix clients including the Element clients.

Works on Web, Android and iOS using a cross-platform core written in Rust, and platform-specific wrappers.

Important note: This project is still in an early stage. Minor versions could bring breaking API changes, see CHANGELOG.md for details. Bugs and crashes may occur, please report them here.

Live demo

Try it out at matrix-org.github.io/matrix-rich-text-editor.

Building the code

Get the prerequisites for each platform by reading the READMEs for them:

• WASM/JavaScript: bindings/wysiwyg-wasm/README.md

• Android/Kotlin or iOS/Swift: bindings/wysiwyg-ffi/README.md

Now, to build all the bindings, try:

make

To build for a single platform, or to learn more, see the individual README files above.

Release the code

See RELEASE.md.

More info

For more detailed explanations and examples of platform-specific code to use Rust bindings like those generated here, see Building cross-platform Rust for Web, Android and iOS – a minimal example.

See also

• The Browser Selections Inventory
  • used while writing tests, to persuade the browser to select text in the same way as if it had been done manually.

License

Apache-2.0