type
HtmlRendererBuilder
src
@Js
class HtmlRendererBuilder : Obj
Builder for configuring an HtmlRenderer
.
methods
attrProviderFactory |
Add a factory for an attribute provider for adding/changing HTML attributes to the rendered tags. |
---|---|
build |
Get the configured |
extensions |
Configure the given extensions on this this renderer |
nodeRendererFactory |
Add a factory for instantiating a node renderer (done when rendering). |
withEscapeHtml |
Whether |
withOmitSingleParagraphP |
Whether documents that only contain a single paragraph shoudl be rendered without the |
withPercentEncodeUrls |
Whether URLs of link or images should be percent-encoded, defaults to |
withSanitizeUrls |
Whether |
withSoftBreak |
The HTML to use for rendering a softbreak, default to |
Slot Details
attrProviderFactory
src
This attrProviderFactory(|HtmlContext->AttrProvider| factory)
Add a factory for an attribute provider for adding/changing HTML attributes to the rendered tags.
build
src
HtmlRenderer build()
Get the configured HtmlRenderer
extensions
src
This extensions(MarkdownExt[] exts)
Configure the given extensions on this this renderer
nodeRendererFactory
src
This nodeRendererFactory(|HtmlContext->NodeRenderer| factory)
Add a factory for instantiating a node renderer (done when rendering). This allows to override the rendering of node types or define rendering for custom node types.
If multiple node renderers for the same node type are created, the one from the factory that was added first "wins". (This is how rendering for core node types can be overriden; the default rendering comes last).
withEscapeHtml
src
This withEscapeHtml(Bool val := true)
Whether HtmlInline
and HtmlBlock
should be escaped, defaults to false
.
Note that HtmlInline
is only a tag itself, not the text between an opening tag and closing tag. So markup in the text will be parsed as normal and is not affected by this option.
withOmitSingleParagraphP
withPercentEncodeUrls
src
This withPercentEncodeUrls(Bool val := true)
Whether URLs of link or images should be percent-encoded, defaults to false
.
If enabled, the following is done:
- Existing percent-encoded parts are preserved (e.g. "%20" is kept as "%20")
- Reserved characters such as "/" are preserved, except for "[" and "]" (see encodeURL in JS).
- Other characters such as umlauts are percent-encoded