Tyler Forge™ Rich Text Editor

A rich text editor Web Component library for Tyler Forge™, built on Tiptap.

Installation

npm install @tylertech/forge-rich-text-editor

@tylertech/forge is a peer dependency and must be installed alongside this package.

Usage

import '@tylertech/forge-rich-text-editor';

<forge-rich-text-editor>
  <forge-rte-standard-tools></forge-rte-standard-tools>
</forge-rich-text-editor>

Development

pnpm dev     # serve a scratch page at localhost:3460
pnpm test    # run the suite in a real browser
pnpm build   # rollup ESM, custom elements manifest and types

src/dev is a page for looking at the components in a real browser. It is never published, and it imports the built esm/ output rather than source, so it exercises the same artifact a consumer gets.

forge-rich-text-editor takes content as an HTML string or a ProseMirror document, while forge-rich-text-renderer takes only a document — the shape the editor's change event emits.

To give the renderer HTML, convert it first with toRichTextDocument(html). It sanitizes the HTML and returns the document an editor with forge-rte-standard-tools would produce from it. Pass features to match a different editor, for example toRichTextDocument(html, [...RICH_TEXT_STANDARD_FEATURES, 'link']). RICH_TEXT_FEATURES lists every feature name, and unknown names are skipped with a warning. It parses with DOMParser, so it needs a browser or a DOM shim such as jsdom or happy-dom.

Document input is stricter than HTML input: ProseMirror rejects a mark it has no extension for and discards the whole document, whereas HTML parsing drops the unknown formatting and keeps the text. Slot the features providing the marks your content uses.

When a document is rejected the editor dispatches its error event with { context: 'Invalid document content', error }, where the message names the offending mark, and logs the same through console.error. The content is still discarded — this only reports it, since TipTap alone logs a warning that an application cannot react to. HTML input is deliberately not reported, because dropping unsupported formatting there is expected behaviour rather than a fault.

License

Apache-2.0