@simtropolis/kg-lexical-html-renderer v0.1.1

Koenig Lexical Html Renderer

Renders a lexical editor state string to a HTML string.

This library differs from Lexical's own lexical-html package in a few ways:

1. it's output target is not an editor but rendered web pages or emails which means the handling of nodes (especially custom DecoratorNodes) will differ to the node's built-in editor-focused rendering
2. render output will vary based on supplied options and targets, e.g. when rendering for email the output may use <table> elements in place of modern HTML structure
3. it's primary usage environment is server-side

Install

npm install @simtropolis/kg-lexical-html-renderer --save

or

yarn add @simtropolis/kg-lexical-html-renderer

Usage

Basic usage:

const LexicalHTMLRenderer = require('@simtropolis/kg-lexical-html-renderer');
const renderer = new Renderer();

const lexicalState = '{...}';
const html = renderer.render(lexicalState);

Options can be passed in as the second argument to .render().

const html = renderer.render(lexicalState, {target: 'email'});

Develop

This is a mono repository, managed with lerna.

Follow the instructions for the top-level repo. 1. git clone this repo & cd into it as usual 2. Run yarn to install top-level dependencies.

Test

• yarn lint run just eslint
• yarn test run lint and tests

Copyright & License

Copyright (c) 2020-2022 Simtropolis - Released under the MIT license.