hast-util-to-tiptap
v0.0.1
Published
hast utility to transform to be used by TipTap renderHTML
Downloads
20
Maintainers
Readme
hast-util-to-tiptap
hast utility to transform to a TipTap tree.
Contents
What is this?
This package is a utility that creates a TipTap tree.
When should I use this?
You can use this project when you want to turn hast into a TipTap node tree for renderHTML.
Install
This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:
npm install hast-util-to-tiptap
API
This package exports the identifier toTipTap
.
There is no default export.
toTipTap(node[, options])
Turn a hast tree into a DOM tree.
options
Configuration (optional).
options.namespace
namespace
to use to create elements (string?
, optional).
options.afterTransform
Called when a hast node was transformed into a DOM node
((HastNode, TipTapTree) => void?
, optional).
Returns
[TipTap
][tipTapTree].
Types
This package is fully typed with TypeScript.
It exports the additional type Options
.
Compatibility
Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 17.3.0. Our projects sometimes work with older versions, but this is not guaranteed.
Security
Use of hast-util-to-tiptap
can open you up to a
cross-site scripting (XSS) attack if the hast tree is unsafe.
Use hast-util-sanitize
to make the hast tree safe.
Related
hast-util-to-dom
— original repohast-util-sanitize
— sanitize hast nodeshast-util-to-html
— serialize as HTMLhast-util-from-dom
— create a hast tree from a DOM tree
Contribute
This project has a [code of conduct][coc]. By interacting with this repository, organisation, or community you agree to abide by its terms.