Interface CustomElementWebRenderingContext

All Superinterfaces:

WebRenderingContext

@Experimental
@NonExtendable
public interface CustomElementWebRenderingContext
extends WebRenderingContext

Context for rendering a custom element with CustomElementWebRenderer.

Method Summary

Modifier and Type	Method	Description
HtmlFragment	compileChildren()	Returns the children of the element being compiled, compiled to HTML.
guideme.libs.mdast.mdx.model.MdxJsxElementFields	element()	Returns the element being compiled.
<T extends Record> T	map(Class<T> modelClass)	Maps between a JSX tags attributes and a given record that models these attributes.
String	tagName()	Returns the name of the tag being compiled.

Methods inherited from interface WebRenderingContext

compile, compileChildren, compileError, fluidIcon, getAssetUrl, getAssetUrl, getPageUrl, guide, itemIcon, itemLink, requireScript, requireStylesheet

Method Details

tagName

String tagName()

Returns the name of the tag being compiled.

Returns:

the name of the tag being compiled

element

guideme.libs.mdast.mdx.model.MdxJsxElementFields element()

Returns the element being compiled.

Returns:

the element being compiled

compileChildren

HtmlFragment compileChildren()

Returns the children of the element being compiled, compiled to HTML.

Returns:

the children of the element being compiled, compiled to HTML

map

<T extends Record> T map(Class<T> modelClass)

Maps between a JSX tags attributes and a given record that models these attributes.

Record components that are annotated with Nullable are considered optional. Record components can be annotated with DefaultValue to give them a default value.

See Also:

• DefaultValue
• Nullable