RichTextDocuments

An interface for retrieving and managing rich text documents.

Hooks provide access to rich text documents and related data from inside React components. Unlike data accessed using static methods, hooks will cause the component to rerender when the data changes.

Returns a rich text document by ID or null if it does not exist.

useRichTextDocument(documentId: string): RTDocument | null;

Retrieves rich text documents by ID. If provided a single ID string, returns the matching rich text document. If provided an array of IDs, returns a { [id]: RTDocument } map of the corresponding rich text documents.

• Throws a RichTextDocumentNotFoundError if a document does not exist.

// Get a single rich text document
RichTextDocuments.get(documentId: string): RTDocument

// Get multiple rich text documents
RichTextDocuments.get(documentId: string[]): RTDocumentMap

Retrieves all rich text documents as a { [id]: RTDocument } map.

RichTextDocuments.getAll(): RTDocumentMap

Creates a new rich text document and dispaches a rich-text-document:create event. Returns the new rich text document.

Adds the document as a parent on all rich text block elements listen in children.

• Throws a RichTextElementNotFoundError if any of the rich text elements listed in children do not exist.

• Throws a RichTextElementTypeNotRegistered if any of the rich text elements listed in children are of an unregistered type.

• Throws a RichTextDocumentValidationError if any of the elements listen in children are not block level elements.

RichTextDocuments.create(core: Core, data?: CreateRTDocumentData): RTDocument;

CreateRTDocumentData

Data used to create a rich text document.

Deletes a rich text document and dispaches a rich-text-document:delete event. Returns the deleted document.

Deleted rich text documents can be restored using the RichTextDocuments.restore method.

• Throws a RichTextDocumentNotFoundError if the document does not exist.

RichTextDocuments.delete(core: Core, documentId: string): RTDocument

Restores a deleted rich text document and dispatches a rich-text-document:restore event. Returns the restored document.

• Throws a RichTextDocumentNotFoundError if the document does not exist.

RichTextDocuments.restore(core: Core, documentId: string): RTDocument

Permanently deletes a rich text document and dispatches a rich-text-document:delete-permanently event. Returns the deleted document.

Permanently deleted rich text documents cannot be restored.

• Throws a RichTextDocumentNotFoundError if the document does not exist.

RichTextDocuments.deletePermanently(core: Core, documentId: string): RTDocument

Sets the child elements of a rich text document and dispatches a rich-text-document:set-children event. Returns the updated document.

Adds the document as a parent on any added child elements and removes the document as a parent from any removed child elements. Optionally, a new revision ID can be passed to update the document's revision.

• Throws a RichTextDocumentNotFoundError if the rich text document does not exist.

• Throws a RichTextElementNotFoundError if any of the rich text block elements do not exist.

• Throws a RichTextDocumentValidationError if any of the added elements are not block level elements.

RichTextDocuments.setChildren(
  core: Core,
  documentId: string,
  children: string[],
  revision?: string
): RTDocument

Sets a new reivsion on the document and dispaches a rich-text-document:update event. Returns the updated document.

• Throws a RichTextDocumentNotFoundError if the rich text document does not exist.

RichTextDocuments.setRevision(
  core: Core,
  documentId: string,
  revision: string
): RTDocument

Adds parent references to a rich text document and dispatches a rich-text-document:add-parents event. Returns the updated rich text document.

• Throws a RichTextDocumentNotFoundError if the document does not exist.

• Throws a ParentReferenceValidationError if any of the parent references are invalid.

RichTextDocuments.addParents(
  core: Core,
  documentId: string,
  parentReferences: ParentReference[],
): RTDocument

Remove parents references from a rich text document and dispaches a rich-text-document:remove-parents event. Returns the updated rich text document.

• Throws a RichTextDocumentNotFoundError if the document does not exist.

RichTextDocuments.removeParents(
  core: Core,
  documentId: string,
  parentReferences: ParentReference[],
): RTDocument

Converts a rich text document to a plain text string. Void elements are converted using their toPlainText method. If they do not have such a method, they are omited.

• Throws a RichTextElementNotFoundError if any of the document's rich text elements do no exist.

toPlainText(document: RTDocument): string

Loads rich text documents into the store and dispatches a rich-text-document:load event.

RichTextDocuments.load(core: Core, documents: RTDocument[]): void

Clears all rich text documents from the store. This method is only intended for use in tests, do not use within your extension code.

RichTextDocuments.clear(): void

See below the table for more details on the data passed by rich text document related events.

RichTextDocument events are dispatched with one of the following types of data.

RichTextDocument

See the RichTextDocument interface page.

ParentReference

See the ParentReference interface page.

UpdateRTDocumentEventData

RTDocumentChanges

SetRTDocumentChildrenEventData

AddParentsToRTDocumentEventData

RemoveParentsFromRTDocumentEventData