@tryghost/kg-lexical-html-renderer v1.0.11
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:
- 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
- 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 - it's primary usage environment is server-side
Install
npm install @tryghost/kg-lexical-html-renderer --save
or
yarn add @tryghost/kg-lexical-html-renderer
Usage
Basic usage:
const LexicalHTMLRenderer = require('@tryghost/kg-lexical-html-renderer');
const renderer = new Renderer();
const lexicalState = '{...}';
const html = await renderer.render(lexicalState);
Options can be passed in as the second argument to .render()
.
const html = await renderer.render(lexicalState, {target: 'email'});
Option | Values |
---|---|
target | 'html' (default), '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 eslintyarn test
run lint and tests
Running in Ghost Admin
In order to run local changes, perform the following:
1. Run yarn link
within kg-lexical-html-renderer
2. Run yarn link @tryghost/kg-lexical-html-renderer
within ghost/core
kg-default-nodes
must also be linked when linking this package as they are codependencies.
Copyright & License
Copyright (c) 2013-2023 Ghost Foundation - Released under the MIT license.
19 days ago
21 days ago
3 months ago
3 months ago
3 months ago
4 months ago
4 months ago
4 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
10 months ago
10 months ago
10 months ago
9 months ago
9 months ago
10 months ago
10 months ago
10 months ago
10 months ago
6 months ago
7 months ago
7 months ago
7 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
7 months ago
8 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
8 months ago
9 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
10 months ago
10 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
12 months ago
12 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
12 months ago
12 months ago
12 months ago
1 year ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago