html

html renders native HTML supplied as a string, CDATA section, or file.

XML Element

html

Java Class

Html

Basics

This element is designed for embedding HTML within an XML structure. It allows embedding separate HTML elements or blocks of HTML code. The block must consist of a single root element such as <header>, <footer>, <main>, or <div>. Within this root element can be any number of nested <div> elements to structure the content effectively.

Note that it is the developer’s responsibility to sanitize and remove any dangerous parts of the HTML before sending it to the user through this component. Passing raw input data to the user can possibly lead to cross-site scripting attacks.

Content from a Message Bundle

This example demonstrates how to add HTML content via a string in the message bundle:

<html content="msg://html.content"/>
messages.properties
com.company.onboarding.view.component.html/html.content=\
<main>\
  <h1>Main Content</h1>\
  <p>This is the main content area.</p>\
    <div>\
      <h2>Section 1</h2>\
      <p>This is the first section of the main content.</p> \
    </div>\
    <div>\
      <h2>Section 2</h2>\
      <p>This is the second section of the main content.</p>\
    </div>\
</main>

Inline Character Data

The same HTML block can be added within a CDATA (Character Data) section:

<html id="html">
    <content>
        <![CDATA[
        <main>
            <h1>Main Content</h1>
            <p>This is the main content area.</p>
            <div>
                <h2>Section 1</h2>
                <p>This is the first section of the main content.</p>
            </div>
            <div>
                <h2>Section 2</h2>
            <p>This is the second section of the main content.</p>
            </div>
        </main>
    ]]>
    </content>
</html>

File Content

LIVE DEMO

The code for HTML block can be also obtained from a file using one of the following methods.

Content from a Static Resource

The file can be served statically by the application. If your file is located at /src/main/resources/META-INF/resources/html/html-file.html, specify it as follows:

<layout classNames="html-component">
    <tabSheet id="tabSheet" width="100%">
        <tab id="declarativeTab" label="Declaratively added component">
            <html file="META-INF/resources/html/html-component.html"/>
        </tab>
    </tabSheet>
</layout>
By default, static content is served from /static, /public, /resources, or /META-INF/resources directories of the classpath. See details in the Spring Boot documentation.

Content from a Stream Resource

The HTML code can be supplied as a file through the InputStream, and then the component can be initialized by passing it in.

The component cannot be created using the UiComponents bean, as it does not provide a no-arguments constructor. 
protected static final String SRC_PATH = "META-INF/resources/html/html-component.html";

@ViewComponent
protected JmixTabSheet tabSheet;

@Autowired
protected Resources resources;

@Subscribe
protected void onInit(InitEvent event) {
    InputStream resourceAsStream = resources.getResourceAsStream(SRC_PATH);

    Html html = new Html(resourceAsStream);
    tabSheet.add("Programmatically added component", html);
}

Attributes

The following attributes are specific to html:

Name Description Default

content

Specifies the HTML content to be rendered by the component, either as a string in a message bundle or within a CDATA section.

—

file

Specifies the file path to retrieve the HTML code from.

—

The following shared attributes are supported by html:

id - alignSelf - classNames - colspan - css - visible

Handlers

The following shared handlers are supported by html:

AttachEvent - DetachEvent