Skip to main content

Crate proseframe

Crate proseframe 

Source
Expand description

§proseframe

A rich text editor for Rust that is built on what an editor needs, not on one document model or one GUI framework.

Pre-release. 0.1.0 reserves the name and states the direction. It contains no editor code yet, and every API that follows in the 0.x series is unstable. The editor itself exists and is in daily use inside a commercial product; it is being separated from that product’s document store and GUI framework before it is published here.

§What it is going to be

  • Bring your own document model. The editor talks to a document store through a small interface: a sequence of text, formatting ranges, labelled side objects, and a feed of changes. Tables, inline atoms (mentions, citations, images), annotations and an open block and mark schema are written once on top of that interface, so every store gets them. Automerge is the first-class store, maintained by us. A plain in-memory store comes with it. Stores such as Yrs, Loro or a rope are meant to be adapters someone can write in a week or two, checked by a conformance suite.
  • Bring your own GUI framework. Layout, virtualization, hit testing, caret and selection geometry, and table layout are headless and sit behind a text shaping interface. A front end supplies shaping, painting, input and accessibility. GPUI is the first-class front end, maintained by us; egui and Iced are the adapters we want to be easy to write.
  • Collaboration-safe structure, as a stance. A position in a document is one number: an index into a single sequence in which a block boundary is one position. That is what makes concurrent paragraph splits and joins merge correctly, and a document store has to be able to present itself that way.

§Status

Follow https://github.com/proseframe/proseframe.rs and https://proseframe.rs.

§License

Licensed under either of

at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.