CoTexts
Jazz provides two CoValue types for collaborative text editing, collectively referred to as "CoText" values:
- CoPlainText for simple text editing without formatting
- CoRichText for rich text with HTML-based formatting (extends CoPlainText)
Both types enable real-time collaborative editing of text content while maintaining consistency across multiple users.
Note: If you're looking for a quick way to add rich text editing to your app, check out jazz-richtext-prosemirror.
const
const note: CoPlainText
note =class CoPlainText
CoPlainText.
CoPlainText.create<CoPlainText>(this: CoValueClass<...>, text: string, options?: { owner: Account | Group; } | Account | Group): CoPlainText
Create a new `CoPlainText` with the given text and owner. The owner (a Group or Account) determines access rights to the CoPlainText. The CoPlainText will immediately be persisted and synced to connected peers.create("Meeting notes", {owner: Account | Group
owner:const me: Account
me }); // Update the textconst note: CoPlainText
note.CoPlainText.applyDiff(other: string): void
Apply text, modifying the text in place. Calculates the diff and applies it to the CoValue.applyDiff("Meeting notes for Tuesday");var console: Console
The `console` module provides a simple debugging console that is similar to the JavaScript console mechanism provided by web browsers. The module exports two specific components: * A `Console` class with methods such as `console.log()`, `console.error()` and `console.warn()` that can be used to write to any Node.js stream. * A global `console` instance configured to write to [`process.stdout`](https://nodejs.org/docs/latest-v20.x/api/process.html#processstdout) and [`process.stderr`](https://nodejs.org/docs/latest-v20.x/api/process.html#processstderr). The global `console` can be used without calling `require('console')`. _**Warning**_: The global console object's methods are neither consistently synchronous like the browser APIs they resemble, nor are they consistently asynchronous like all other Node.js streams. See the [`note on process I/O`](https://nodejs.org/docs/latest-v20.x/api/process.html#a-note-on-process-io) for more information. Example using the global `console`: ```js console.log('hello world'); // Prints: hello world, to stdout console.log('hello %s', 'world'); // Prints: hello world, to stdout console.error(new Error('Whoops, something bad happened')); // Prints error message and stack trace to stderr: // Error: Whoops, something bad happened // at [eval]:5:15 // at Script.runInThisContext (node:vm:132:18) // at Object.runInThisContext (node:vm:309:38) // at node:internal/process/execution:77:19 // at [eval]-wrapper:6:22 // at evalScript (node:internal/process/execution:76:60) // at node:internal/main/eval_string:23:3 const name = 'Will Robinson'; console.warn(`Danger ${name}! Danger!`); // Prints: Danger Will Robinson! Danger!, to stderr ``` Example using the `Console` class: ```js const out = getStreamSomehow(); const err = getStreamSomehow(); const myConsole = new console.Console(out, err); myConsole.log('hello world'); // Prints: hello world, to out myConsole.log('hello %s', 'world'); // Prints: hello world, to out myConsole.error(new Error('Whoops, something bad happened')); // Prints: [Error: Whoops, something bad happened], to err const name = 'Will Robinson'; myConsole.warn(`Danger ${name}! Danger!`); // Prints: Danger Will Robinson! Danger!, to err ```console.Console.log(message?: any, ...optionalParams: any[]): void (+1 overload)
Prints to `stdout` with newline. Multiple arguments can be passed, with the first used as the primary message and all additional used as substitution values similar to [`printf(3)`](http://man7.org/linux/man-pages/man3/printf.3.html) (the arguments are all passed to [`util.format()`](https://nodejs.org/docs/latest-v20.x/api/util.html#utilformatformat-args)). ```js const count = 5; console.log('count: %d', count); // Prints: count: 5, to stdout console.log('count:', count); // Prints: count: 5, to stdout ``` See [`util.format()`](https://nodejs.org/docs/latest-v20.x/api/util.html#utilformatformat-args) for more information.log(const note: CoPlainText
note.CoPlainText.toString(): string
Returns a string representation of a string.toString()); // "Meeting notes for Tuesday"
For a full example of CoTexts in action, see our Richtext example app, which shows plain text and rich text editing.
CoPlainText vs co.string
While co.string
is perfect for simple text fields, CoPlainText
is the right choice when you need:
- Multiple users editing the same text simultaneously
- Fine-grained control over text edits (inserting, deleting at specific positions)
- Character-by-character collaboration
- Efficient merging of concurrent changes
Both support real-time updates, but CoPlainText
provides specialized tools for collaborative editing scenarios.
Creating CoText Values
CoText values are typically used as fields in your schemas:
class
class Profile
Profile extendsclass CoMap
CoMaps are collaborative versions of plain objects, mapping string-like keys to values.CoMap {Profile.name: co<string>
name =co.
const co: { string: co<string>; number: co<number>; boolean: co<boolean>; null: co<null>; Date: co<Date>; literal<T extends (string | number | boolean)[]>(..._lit: T): co<T[number]>; json<T extends CojsonInternalTypes.CoJsonValue<T>>(): co<T>; encoded<T>(arg: Encoder<T>): co<T>; ref: { ...; }; items: ItemsSym; optional: { ref: <C extends CoValueClass>(arg: C | ((_raw: InstanceType<C>["_raw"]) => C)) => co<InstanceType<C> | null | undefined>; json<T extends CojsonInternalTypes.CoJsonValue<T>>(): co<T | undefined>; encoded<T>(arg: OptionalEncoder<T>): co<T | undefined>; string: co<string | undefined>; number: co<number | undefined>; boolean: co<boolean | undefined>; null: co<null | undefined>; Date: co<Date | undefined>; literal<T extends (string | number | boolean)[]>(..._lit: T): co<T[number] | undefined>; }; }
string: co<string>
string;Profile.bio: co<CoPlainText | null>
bio =co.
const co: { string: co<string>; number: co<number>; boolean: co<boolean>; null: co<null>; Date: co<Date>; literal<T extends (string | number | boolean)[]>(..._lit: T): co<T[number]>; json<T extends CojsonInternalTypes.CoJsonValue<T>>(): co<T>; encoded<T>(arg: Encoder<T>): co<T>; ref: { ...; }; items: ItemsSym; optional: { ref: <C extends CoValueClass>(arg: C | ((_raw: InstanceType<C>["_raw"]) => C)) => co<InstanceType<C> | null | undefined>; json<T extends CojsonInternalTypes.CoJsonValue<T>>(): co<T | undefined>; encoded<T>(arg: OptionalEncoder<T>): co<T | undefined>; string: co<string | undefined>; number: co<number | undefined>; boolean: co<boolean | undefined>; null: co<null | undefined>; Date: co<Date | undefined>; literal<T extends (string | number | boolean)[]>(..._lit: T): co<T[number] | undefined>; }; }
ref: <typeof CoPlainText>(arg: typeof CoPlainText | ((_raw: RawCoPlainText<JsonObject | null>) => typeof CoPlainText), options?: never) => co<...> (+1 overload)
ref(class CoPlainText
CoPlainText); // Plain text fieldProfile.description: co<CoRichText | null>
description =co.
const co: { string: co<string>; number: co<number>; boolean: co<boolean>; null: co<null>; Date: co<Date>; literal<T extends (string | number | boolean)[]>(..._lit: T): co<T[number]>; json<T extends CojsonInternalTypes.CoJsonValue<T>>(): co<T>; encoded<T>(arg: Encoder<T>): co<T>; ref: { ...; }; items: ItemsSym; optional: { ref: <C extends CoValueClass>(arg: C | ((_raw: InstanceType<C>["_raw"]) => C)) => co<InstanceType<C> | null | undefined>; json<T extends CojsonInternalTypes.CoJsonValue<T>>(): co<T | undefined>; encoded<T>(arg: OptionalEncoder<T>): co<T | undefined>; string: co<string | undefined>; number: co<number | undefined>; boolean: co<boolean | undefined>; null: co<null | undefined>; Date: co<Date | undefined>; literal<T extends (string | number | boolean)[]>(..._lit: T): co<T[number] | undefined>; }; }
ref: <typeof CoRichText>(arg: typeof CoRichText | ((_raw: RawCoPlainText<JsonObject | null>) => typeof CoRichText), options?: never) => co<...> (+1 overload)
ref(class CoRichText
CoRichText); // Rich text with formatting }
Create a CoText value with a simple string:
// Create plaintext with default ownership (current user) const
const note: CoPlainText
note =class CoPlainText
CoPlainText.
CoPlainText.create<CoPlainText>(this: CoValueClass<CoPlainText>, text: string, options?: { owner: Account | Group; } | Account | Group): CoPlainText
Create a new `CoPlainText` with the given text and owner. The owner (a Group or Account) determines access rights to the CoPlainText. The CoPlainText will immediately be persisted and synced to connected peers.create("Meeting notes", {owner: Account | Group
owner:const me: Account
me }); // Create rich text with HTML content constconst document: CoRichText
document =class CoRichText
CoRichText.
CoPlainText.create<CoRichText>(this: CoValueClass<CoRichText>, text: string, options?: { owner: Account | Group; } | Account | Group): CoRichText
Create a new `CoPlainText` with the given text and owner. The owner (a Group or Account) determines access rights to the CoPlainText. The CoPlainText will immediately be persisted and synced to connected peers.create("<p>Project <strong>overview</strong></p>", {owner: Account | Group
owner:const me: Account
me } );
Ownership
Like other CoValues, you can specify ownership when creating CoTexts.
// Create with shared ownership const
const teamGroup: Group
teamGroup =class Group
Group.create();
Group.create<Group>(this: CoValueClass<Group>, options?: { owner: Account; } | Account): Group
const teamGroup: Group
teamGroup.Group.addMember(member: Account, role: AccountRole): void (+1 overload)
addMember(const colleagueAccount: Account
colleagueAccount, "writer"); constconst teamNote: CoPlainText
teamNote =class CoPlainText
CoPlainText.
CoPlainText.create<CoPlainText>(this: CoValueClass<CoPlainText>, text: string, options?: { owner: Account | Group; } | Account | Group): CoPlainText
Create a new `CoPlainText` with the given text and owner. The owner (a Group or Account) determines access rights to the CoPlainText. The CoPlainText will immediately be persisted and synced to connected peers.create("Team updates", {owner: Group | Account
owner:const teamGroup: Group
teamGroup });
See Groups as permission scopes for more information on how to use groups to control access to CoText values.
Reading Text
CoText values work like JavaScript strings:
// Get the text content
var console: Console
The `console` module provides a simple debugging console that is similar to the JavaScript console mechanism provided by web browsers. The module exports two specific components: * A `Console` class with methods such as `console.log()`, `console.error()` and `console.warn()` that can be used to write to any Node.js stream. * A global `console` instance configured to write to [`process.stdout`](https://nodejs.org/docs/latest-v20.x/api/process.html#processstdout) and [`process.stderr`](https://nodejs.org/docs/latest-v20.x/api/process.html#processstderr). The global `console` can be used without calling `require('console')`. _**Warning**_: The global console object's methods are neither consistently synchronous like the browser APIs they resemble, nor are they consistently asynchronous like all other Node.js streams. See the [`note on process I/O`](https://nodejs.org/docs/latest-v20.x/api/process.html#a-note-on-process-io) for more information. Example using the global `console`: ```js console.log('hello world'); // Prints: hello world, to stdout console.log('hello %s', 'world'); // Prints: hello world, to stdout console.error(new Error('Whoops, something bad happened')); // Prints error message and stack trace to stderr: // Error: Whoops, something bad happened // at [eval]:5:15 // at Script.runInThisContext (node:vm:132:18) // at Object.runInThisContext (node:vm:309:38) // at node:internal/process/execution:77:19 // at [eval]-wrapper:6:22 // at evalScript (node:internal/process/execution:76:60) // at node:internal/main/eval_string:23:3 const name = 'Will Robinson'; console.warn(`Danger ${name}! Danger!`); // Prints: Danger Will Robinson! Danger!, to stderr ``` Example using the `Console` class: ```js const out = getStreamSomehow(); const err = getStreamSomehow(); const myConsole = new console.Console(out, err); myConsole.log('hello world'); // Prints: hello world, to out myConsole.log('hello %s', 'world'); // Prints: hello world, to out myConsole.error(new Error('Whoops, something bad happened')); // Prints: [Error: Whoops, something bad happened], to err const name = 'Will Robinson'; myConsole.warn(`Danger ${name}! Danger!`); // Prints: Danger Will Robinson! Danger!, to err ```console.Console.log(message?: any, ...optionalParams: any[]): void (+1 overload)
Prints to `stdout` with newline. Multiple arguments can be passed, with the first used as the primary message and all additional used as substitution values similar to [`printf(3)`](http://man7.org/linux/man-pages/man3/printf.3.html) (the arguments are all passed to [`util.format()`](https://nodejs.org/docs/latest-v20.x/api/util.html#utilformatformat-args)). ```js const count = 5; console.log('count: %d', count); // Prints: count: 5, to stdout console.log('count:', count); // Prints: count: 5, to stdout ``` See [`util.format()`](https://nodejs.org/docs/latest-v20.x/api/util.html#utilformatformat-args) for more information.log(const note: CoPlainText
note.CoPlainText.toString(): string
Returns a string representation of a string.toString()); // "Meeting notes" // Check the text lengthvar console: Console
The `console` module provides a simple debugging console that is similar to the JavaScript console mechanism provided by web browsers. The module exports two specific components: * A `Console` class with methods such as `console.log()`, `console.error()` and `console.warn()` that can be used to write to any Node.js stream. * A global `console` instance configured to write to [`process.stdout`](https://nodejs.org/docs/latest-v20.x/api/process.html#processstdout) and [`process.stderr`](https://nodejs.org/docs/latest-v20.x/api/process.html#processstderr). The global `console` can be used without calling `require('console')`. _**Warning**_: The global console object's methods are neither consistently synchronous like the browser APIs they resemble, nor are they consistently asynchronous like all other Node.js streams. See the [`note on process I/O`](https://nodejs.org/docs/latest-v20.x/api/process.html#a-note-on-process-io) for more information. Example using the global `console`: ```js console.log('hello world'); // Prints: hello world, to stdout console.log('hello %s', 'world'); // Prints: hello world, to stdout console.error(new Error('Whoops, something bad happened')); // Prints error message and stack trace to stderr: // Error: Whoops, something bad happened // at [eval]:5:15 // at Script.runInThisContext (node:vm:132:18) // at Object.runInThisContext (node:vm:309:38) // at node:internal/process/execution:77:19 // at [eval]-wrapper:6:22 // at evalScript (node:internal/process/execution:76:60) // at node:internal/main/eval_string:23:3 const name = 'Will Robinson'; console.warn(`Danger ${name}! Danger!`); // Prints: Danger Will Robinson! Danger!, to stderr ``` Example using the `Console` class: ```js const out = getStreamSomehow(); const err = getStreamSomehow(); const myConsole = new console.Console(out, err); myConsole.log('hello world'); // Prints: hello world, to out myConsole.log('hello %s', 'world'); // Prints: hello world, to out myConsole.error(new Error('Whoops, something bad happened')); // Prints: [Error: Whoops, something bad happened], to err const name = 'Will Robinson'; myConsole.warn(`Danger ${name}! Danger!`); // Prints: Danger Will Robinson! Danger!, to err ```console.Console.log(message?: any, ...optionalParams: any[]): void (+1 overload)
Prints to `stdout` with newline. Multiple arguments can be passed, with the first used as the primary message and all additional used as substitution values similar to [`printf(3)`](http://man7.org/linux/man-pages/man3/printf.3.html) (the arguments are all passed to [`util.format()`](https://nodejs.org/docs/latest-v20.x/api/util.html#utilformatformat-args)). ```js const count = 5; console.log('count: %d', count); // Prints: count: 5, to stdout console.log('count:', count); // Prints: count: 5, to stdout ``` See [`util.format()`](https://nodejs.org/docs/latest-v20.x/api/util.html#utilformatformat-args) for more information.log(const note: CoPlainText
note.CoPlainText.length: number
Returns the length of a String object.length); // 14
Making Edits
Insert and delete text with intuitive methods:
// Insert text at a specific position
const note: CoPlainText
note.CoPlainText.insertBefore(idx: number, text: string): void
insertBefore(8, "weekly "); // "Meeting weekly notes" // Insert after a positionconst note: CoPlainText
note.CoPlainText.insertAfter(idx: number, text: string): void
insertAfter(21, " for Monday"); // "Meeting weekly notes for Monday" // Delete a range of textconst note: CoPlainText
note.deleteRange({
CoPlainText.deleteRange(range: { from: number; to: number; }): void
from: number
from: 8,to: number
to: 15 }); // "Meeting notes for Monday" // Apply a diff to update the entire textconst note: CoPlainText
note.CoPlainText.applyDiff(other: string): void
Apply text, modifying the text in place. Calculates the diff and applies it to the CoValue.applyDiff("Team meeting notes for Tuesday");
Applying Diffs
Use applyDiff
to efficiently update text with minimal changes:
// Original text: "Team status update" const
const minutes: CoPlainText
minutes =class CoPlainText
CoPlainText.
CoPlainText.create<CoPlainText>(this: CoValueClass<CoPlainText>, text: string, options?: { owner: Account | Group; } | Account | Group): CoPlainText
Create a new `CoPlainText` with the given text and owner. The owner (a Group or Account) determines access rights to the CoPlainText. The CoPlainText will immediately be persisted and synced to connected peers.create("Team status update", {owner: Account | Group
owner:const me: Account
me }); // Replace the entire text with a new versionconst minutes: CoPlainText
minutes.CoPlainText.applyDiff(other: string): void
Apply text, modifying the text in place. Calculates the diff and applies it to the CoValue.applyDiff("Weekly team status update for Project X"); // Make partial changes letlet text: string
text =const minutes: CoPlainText
minutes.CoPlainText.toString(): string
Returns a string representation of a string.toString();let text: string
text =let text: string
text.String.replace(searchValue: string | RegExp, replaceValue: string): string (+3 overloads)
Replaces text in a string, using a regular expression or search string.replace("Weekly", "Monday");const minutes: CoPlainText
minutes.CoPlainText.applyDiff(other: string): void
Apply text, modifying the text in place. Calculates the diff and applies it to the CoValue.applyDiff(let text: string
text); // Efficiently updates only what changed
Perfect for handling user input in form controls:
Using Rich Text with ProseMirror
Jazz provides a dedicated plugin for integrating CoRichText with the popular ProseMirror editor. This plugin, jazz-richtext-prosemirror
, enables bidirectional synchronization between your CoRichText instances and ProseMirror editors.
ProseMirror Plugin Features
- Bidirectional Sync: Changes in the editor automatically update the CoRichText and vice versa
- Real-time Collaboration: Multiple users can edit the same document simultaneously
- HTML Conversion: Automatically converts between HTML (used by CoRichText) and ProseMirror's document model
Installation
pnpm add jazz-richtext-prosemirror \ prosemirror-view \ prosemirror-state \ prosemirror-schema-basic
Integration
We don't currently have a React Native-specific example, but you need help you can request one, or ask on Discord.
For use with React:
// RichTextEditor.tsx import {
function createJazzPlugin(coRichText: CoRichText | undefined, config?: JazzPluginConfig): Plugin<{ coRichText: CoRichText | undefined; }>
Creates a ProseMirror plugin that synchronizes a CoRichText instance with a ProseMirror editor. This plugin enables bidirectional synchronization between a CoRichText instance and a ProseMirror editor. It handles: - Initializing the editor with CoRichText content - Updating the editor when CoRichText changes - Updating CoRichText when the editor changes - Managing the editor view lifecyclecreateJazzPlugin } from "jazz-richtext-prosemirror"; import {
function exampleSetup(options: { schema: Schema; mapKeys?: { [key: string]: string | false; }; menuBar?: boolean; history?: boolean; floatingMenu?: boolean; menuContent?: MenuElement[][]; }): (Plugin<any> | Plugin<{ transform: Transaction; from: number; to: number; text: string; } | null>)[]
Create an array of plugins pre-configured for the given schema. The resulting array will include the following plugins: Input rules for smart quotes and creating the block types in the schema using markdown conventions (say `"> "` to create a blockquote) A keymap that defines keys to create and manipulate the nodes in the schema A keymap binding the default keys provided by the prosemirror-commands module The undo history plugin The drop cursor plugin The gap cursor plugin A custom plugin that adds a `menuContent` prop for the prosemirror-menu wrapper, and a CSS class that enables the additional styling defined in `style/style.css` in this package Probably only useful for quickly setting up a passable editor—you'll need more control over your settings in most real-world situations.exampleSetup } from "prosemirror-example-setup"; import {const schema: Schema<"blockquote" | "image" | "text" | "doc" | "paragraph" | "horizontal_rule" | "heading" | "code_block" | "hard_break", "link" | "code" | "em" | "strong">
This schema roughly corresponds to the document schema used by [CommonMark](http://commonmark.org/), minus the list elements, which are defined in the [`prosemirror-schema-list`](https://prosemirror.net/docs/ref/#schema-list) module. To reuse elements from this schema, extend or read from its `spec.nodes` and `spec.marks` [properties](https://prosemirror.net/docs/ref/#model.Schema.spec).schema } from "prosemirror-schema-basic"; import {class EditorState
The state of a ProseMirror editor is represented by an object of this type. A state is a persistent data structure—it isn't updated, but rather a new state value is computed from an old one using the [`apply`](https://prosemirror.net/docs/ref/#state.EditorState.apply) method. A state holds a number of built-in fields, and plugins can [define](https://prosemirror.net/docs/ref/#state.PluginSpec.state) additional fields.EditorState } from "prosemirror-state"; import {class EditorView
An editor view manages the DOM structure that represents an editable document. Its state and behavior are determined by its [props](https://prosemirror.net/docs/ref/#view.DirectEditorProps).EditorView } from "prosemirror-view"; functionfunction RichTextEditor(): React.JSX.Element | null
RichTextEditor() { const {me } =
const me: ({ profile: JazzProfile; } & JazzAccount) | null | undefined
useAccount({
useAccount<JazzAccount, { profile: true; }>(options?: { resolve?: RefsToResolve<JazzAccount, 10, []> | undefined; } | undefined): { me: ({ profile: JazzProfile; } & JazzAccount) | null | undefined; logOut: () => void; } (+1 overload)
resolve?: RefsToResolve<JazzAccount, 10, []> | undefined
resolve: {profile?: RefsToResolve<JazzProfile, 10, [0]> | undefined
profile: true } }); constconst editorRef: React.RefObject<HTMLDivElement>
editorRef =useRef<HTMLDivElement>(initialValue: HTMLDivElement | null): React.RefObject<HTMLDivElement> (+2 overloads)
`useRef` returns a mutable ref object whose `.current` property is initialized to the passed argument (`initialValue`). The returned object will persist for the full lifetime of the component. Note that `useRef()` is useful for more than the `ref` attribute. It’s handy for keeping any mutable value around similar to how you’d use instance fields in classes. Usage note: if you need the result of useRef to be directly mutable, include `| null` in the type of the generic argument.useRef<HTMLDivElement>(null); constconst viewRef: React.MutableRefObject<EditorView | null>
viewRef =useRef<EditorView | null>(initialValue: EditorView | null): React.MutableRefObject<EditorView | null> (+2 overloads)
`useRef` returns a mutable ref object whose `.current` property is initialized to the passed argument (`initialValue`). The returned object will persist for the full lifetime of the component. Note that `useRef()` is useful for more than the `ref` attribute. It’s handy for keeping any mutable value around similar to how you’d use instance fields in classes.useRef<class EditorView
An editor view manages the DOM structure that represents an editable document. Its state and behavior are determined by its [props](https://prosemirror.net/docs/ref/#view.DirectEditorProps).EditorView | null>(null);function useEffect(effect: React.EffectCallback, deps?: React.DependencyList): void
Accepts a function that contains imperative, possibly effectful code.useEffect(() => { if (!me?.
const me: ({ profile: JazzProfile; } & JazzAccount) | null | undefined
JazzAccount.profile: JazzProfile & co<JazzProfile | null>
profile.JazzProfile.bio: co<CoRichText | null> | undefined
bio || !const editorRef: React.RefObject<HTMLDivElement>
editorRef.React.RefObject<HTMLDivElement>.current: HTMLDivElement | null
The current value of the ref.current) return; // Create the Jazz plugin for ProseMirror // Providing a CoRichText instance to the plugin to automatically sync changes constjazzPlugin =
const jazzPlugin: Plugin<{ coRichText: CoRichText | undefined; }>
function createJazzPlugin(coRichText: CoRichText | undefined, config?: JazzPluginConfig): Plugin<{ coRichText: CoRichText | undefined; }>
Creates a ProseMirror plugin that synchronizes a CoRichText instance with a ProseMirror editor. This plugin enables bidirectional synchronization between a CoRichText instance and a ProseMirror editor. It handles: - Initializing the editor with CoRichText content - Updating the editor when CoRichText changes - Updating CoRichText when the editor changes - Managing the editor view lifecyclecreateJazzPlugin(me.
const me: { profile: JazzProfile; } & JazzAccount
JazzAccount.profile: JazzProfile & co<JazzProfile | null>
profile.JazzProfile.bio: CoRichText | (CoRichText & CoMarker)
bio); // Set up ProseMirror with the Jazz plugin if (!const viewRef: React.MutableRefObject<EditorView | null>
viewRef.React.MutableRefObject<EditorView | null>.current: EditorView | null
current) {const viewRef: React.MutableRefObject<EditorView | null>
viewRef.React.MutableRefObject<EditorView | null>.current: EditorView | null
current = new
new EditorView(place: null | Node | ((editor: HTMLElement) => void) | { mount: HTMLElement; }, props: DirectEditorProps): EditorView
Create a view. `place` may be a DOM node that the editor should be appended to, a function that will place it into the document, or an object whose `mount` property holds the node to use as the document container. If it is `null`, the editor will not be added to the document.EditorView(const editorRef: React.RefObject<HTMLDivElement>
editorRef.React.RefObject<HTMLDivElement>.current: HTMLDivElement
The current value of the ref.current, {DirectEditorProps.state: EditorState
The current state of the editor.state:class EditorState
The state of a ProseMirror editor is represented by an object of this type. A state is a persistent data structure—it isn't updated, but rather a new state value is computed from an old one using the [`apply`](https://prosemirror.net/docs/ref/#state.EditorState.apply) method. A state holds a number of built-in fields, and plugins can [define](https://prosemirror.net/docs/ref/#state.PluginSpec.state) additional fields.EditorState.EditorState.create(config: EditorStateConfig): EditorState
Create a new state.create({EditorStateConfig.schema?: Schema<any, any> | undefined
The schema to use (only relevant if no `doc` is specified).schema,EditorStateConfig.plugins?: readonly Plugin<any>[] | undefined
The plugins that should be active in this state.plugins: [ ...
function exampleSetup(options: { schema: Schema; mapKeys?: { [key: string]: string | false; }; menuBar?: boolean; history?: boolean; floatingMenu?: boolean; menuContent?: MenuElement[][]; }): (Plugin<any> | Plugin<{ transform: Transaction; from: number; to: number; text: string; } | null>)[]
Create an array of plugins pre-configured for the given schema. The resulting array will include the following plugins: Input rules for smart quotes and creating the block types in the schema using markdown conventions (say `"> "` to create a blockquote) A keymap that defines keys to create and manipulate the nodes in the schema A keymap binding the default keys provided by the prosemirror-commands module The undo history plugin The drop cursor plugin The gap cursor plugin A custom plugin that adds a `menuContent` prop for the prosemirror-menu wrapper, and a CSS class that enables the additional styling defined in `style/style.css` in this package Probably only useful for quickly setting up a passable editor—you'll need more control over your settings in most real-world situations.exampleSetup({schema: Schema<any, any>
The schema to generate key bindings and menu items for.schema }),jazzPlugin, ], }), }); } return () => { if (
const jazzPlugin: Plugin<{ coRichText: CoRichText | undefined; }>
const viewRef: React.MutableRefObject<EditorView | null>
viewRef.React.MutableRefObject<EditorView | null>.current: EditorView | null
current) {const viewRef: React.MutableRefObject<EditorView | null>
viewRef.React.MutableRefObject<EditorView | null>.current: EditorView
current.EditorView.destroy(): void
Removes the editor from the DOM and destroys all [node views](https://prosemirror.net/docs/ref/#view.NodeView).destroy();const viewRef: React.MutableRefObject<EditorView | null>
viewRef.React.MutableRefObject<EditorView | null>.current: EditorView | null
current = null; } }; }, [me?.
const me: ({ profile: JazzProfile; } & JazzAccount) | null | undefined
JazzAccount.profile: JazzProfile & co<JazzProfile | null>
profile.JazzProfile.bio: co<CoRichText | null> | undefined
bio?.CoPlainText.id: ID<CoRichText> | ID<CoRichText & CoMarker> | undefined
id]); if (!me) return null; return ( <
const me: ({ profile: JazzProfile; } & JazzAccount) | null | undefined
JSX.IntrinsicElements.div: React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>
divReact.HTMLAttributes<HTMLDivElement>.className?: string | undefined
className="border rounded"> <JSX.IntrinsicElements.div: React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>
divReact.RefAttributes<HTMLDivElement>.ref?: React.LegacyRef<HTMLDivElement> | undefined
Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).ref={const editorRef: React.RefObject<HTMLDivElement>
editorRef}React.HTMLAttributes<HTMLDivElement>.className?: string | undefined
className="p-2" /> </JSX.IntrinsicElements.div: React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>
div> ); }
For use without a framework:
import { CoRichText } from "jazz-tools"; import { createJazzPlugin } from "jazz-richtext-prosemirror"; import { exampleSetup } from "prosemirror-example-setup"; import { schema } from "prosemirror-schema-basic"; import { EditorState } from "prosemirror-state"; import { EditorView } from "prosemirror-view"; function setupRichTextEditor(coRichText, container) { // Create the Jazz plugin for ProseMirror // Providing a CoRichText instance to the plugin to automatically sync changes const jazzPlugin = createJazzPlugin(coRichText); // Set up ProseMirror with Jazz plugin const view = new EditorView(container, { state: EditorState.create({ schema, plugins: [ ...exampleSetup({ schema }), jazzPlugin, ], }), }); // Return cleanup function return () => { view.destroy(); }; } // Usage const document = CoRichText.create("<p>Initial content</p>", { owner: me }); const editorContainer = document.getElementById("editor"); const cleanup = setupRichTextEditor(document, editorContainer); // Later when done with the editor cleanup();