How Thymeleaf Templating Support Module support HST-2 Integration?
Thymeleaf Templating Support Module provides equivalent features to HST-2 JSP Tab Libraries.
Model
HstRequestContext can be accessed as follows:
<span class="thymeleaf-web-files" th:text="${hstRequestContext.getAttribute('contextUser').name}"></span>
Fragments
relative url (relative to current fragment)
<div th:insert="fragment/thymeleaf-footer-fragment :: footerFragment"></div>
absolute url
<div th:if="${cparam.showPagination}" th:insert="/thymeleaf/include/pagination :: pagination"></div>
Tags and attributes
Generating HST Link like <@hst.link /> tag
<a hst:link="${document}" th:text="${document.title}"></a>
| Attribute name |
Value |
| hst:link (required) |
HippoBean, HstLink, String (linkByPath) |
| hst:fullyQualified (optional) |
boolean, string(true/false) |
Generating HST WebFile Link like <@hst.webfile /> tag
<link hst:webfile="/thymeleaf/webfiles.css" />
or:
<link rel="stylesheet" th:href="@{webfile:/css/bootstrap.css}" type="text/css"/>
| Attribute name |
Value |
| hst:webfile (required) |
String, |
| hst:fullyQualified (optional) |
boolean, string(true/false) |
Rendering Hippo HTML Compound Bean like <@hst.html /> tag
<div hst:html="${document.html}" />
| Attribute name |
Value |
| hst:html (required) |
HippoHtml, |
| hst:fullyQualified (optional) |
boolean, string(true/false) |
| hst:imageVariantName (optional) |
string |
| hst:imageVariantReplaces (optional) |
string |
| hst:imageVariantFallback (optional) |
boolean, string(true/false) |
| hst:canonicalLinks (optional) |
boolean, string(true/false) |
| hst:contentRewriter (optional) |
ContentRewriter |
or by using tag:
<hst:html hst:htmlBean="${document.html}" />
| Attribute name |
Value |
| hst:htmlBean (required) |
HippoHtml, |
| hst:fullyQualified (optional) |
boolean, string(true/false) |
| hst:imageVariantName (optional) |
string |
| hst:imageVariantReplaces (optional) |
string |
| hst:imageVariantFallback (optional) |
boolean, string(true/false) |
| hst:canonicalLinks (optional) |
boolean, string(true/false) |
| hst:contentRewriter (optional) |
ContentRewriter |
Including Child HST Components like <@hst.include /> tag
<hst:include hst:ref="footer-thymeleaf"/>
| Attribute name |
Value |
| hst:ref (required) |
string(true/false) |
Generating HST Render URLs like <@hst.renderURL /> tag
<a hst:renderURL="a=1&b=2">renderURL</a>
| Attribute name |
Value |
| hst:renderURL (required) |
optional value (parameters e.g. a=1&b=2) |
Generating HST Action URLs like <@hst.actionURL /> tag
<a hst:actionURL="">actionURL</a>
| Attribute name |
Value |
| hst:actionURL (required) |
optional value (parameters e.g. a=1&b=2) |
Generating HST Resource URLs like <@hst.resourceURL /> tag
<a hst:resourceURL="">resourceURL</a>
| Attribute name |
Value |
| hst:resourceURL (required) |
String, resource id e.g. myResource |
| hst:params (optional) |
optional value (parameters e.g. a=1&b=2) |
Generating HST ComponentRendering URLs like <@hst.componentRenderingURL /> tag
<a hst:componentRenderingURL="">componentRenderingURL</a>
| Attribute name |
Value |
| hst:componentRenderingURL (required) |
no value (parameters e.g. a=1&b=2) |
Contributing HST Head Element like <@hst.headContribution /> tag
<hst:headContribution hst:category="thymeleafCategory">
<link hst:webfile="/thymeleaf/webfiles.css" />
</hst:headContribution>
| Attribute name |
Value |
| hst:category (optional) |
String |
| hst:keyHint (optional) |
String |
Writing All the Contributed HST Head Elements like <@hst.headContributions /> tag
<hst:headContributions hst:categoryIncludes="htmlBodyEnd, scripts" hst:xhtml="true"/>
<hst:headContributions hst:categoryExcludes="htmlBodyEnd, scripts" hst:xhtml="true" />
| Attribute name |
Value |
| hst:xhtml (optional) |
boolean, string(true/false) |
| hst:categoryIncludes (optional) |
String |
| hst:categoryExcludes (optional) |
String |
Message Replacing like <@hst.messagesReplace /> tag
This is implemented as Thymeleaf expression:
#messagesReplace.replaceByBundle(text, bundle)
#messagesReplace.replaceByBundle(html, fullyQualified, bundle)
#messagesReplace.replaceByBundleName(text, bundleName)
#messagesReplace.replaceByBundleName(html, fullyQualified, bundleName)
| Attribute name |
Value |
| text (required) |
String |
| bundleName (required) |
String |
| bundle (required) |
ResourceBundle |
| fullyQualified (required) |
boolean |
| html (required) |
HippoHtml |
hstFunctions
#hstFunctions.isReadable(bean, name)
#hstFunctions.isNodeType(node, name)
#hstFunctions.isBeanType(bean, name)
| Attribute name |
Value |
| name (required) |
String |
| bean (required) |
Object |
| node (required) |
javax.jcr.Node |
CMS edit link, like <@hst.cmsEditLink /> tag
<a hst:cmsEditLink="${document}">Link</a>
| Attribute name |
Value |
| hst:cmsEditLink (required) |
HippoBean |
CMS edit menu, like <@hst.cmseditmenu /> tag
<hst:cmseditmenu hst:menu="${menu}" />
| Attribute name |
Value |
| hst:menu (required) |
CommonMenu |
CMS menage content, like <@hst.manageContent /> tag
<hst:manageContent hst:hippobean="${document}" />
| Attribute name |
Value |
| hst:hippobean (required) |
CommonMenu |
Facet navigation link, like <@hst.facetNavigationLink /> tag
<a hst:facetNavigationLink="${facets}" hst:facetRemove="${item}">
<span th:text="${item.name +' remove'}" class="alert-danger"></span>
</a>
| Attribute name |
Value |
| hst:facetNavigationLink (required) |
HippoFacetSubNavigation |
| hst:facetRemove (optional) |
HippoFacetSubNavigation |
| hst:facetRemoveList (optional) |
List of HippoFacetSubNavigation |
HST linkByPath
<a hst:linkByPath="/news" >/news</a>
| Attribute name |
Value |
| hst:linkByPath (required) |
String |
| hst:fullyQualified (optional) |
boolean, string(true/false) |
HST linkBySiteMapItemRefId
<a hst:linkBySiteMapItemRefId="root">root</a>
| Attribute name |
Value |
| hst:linkBySiteMapItemRefId (required) |
String |
| hst:fullyQualified (optional) |
boolean, string(true/false) |
HST set bundle like <@hst.setBundle /> tag
<hst:setBundle hst:basename="essentials.facets"/>
read message from bundle: <strong th:text="#{results.indication}"></strong>
| Attribute name |
Value |
| hst:basename (required) |
String |
| hst:fallbackToJavaResourceBundle (optional) |
boolean, string(true/false) |
