Development and tooling

Clay Form Elements

Clay Form Elements The Liferay Clay tag library provides several tags for creating form elements. An example of each tag is shown below. Checkbox Checkboxes give the user a true or false input. "...

Published Date: May 9, 2024 6:53 PM

Clay Navigation Bars

Clay Navigation Bars Similar to dropdown menus, navigation bars display a list of navigation items. The key difference is navigation bars are displayed in a horizontal bar with all navigation items...

Published Date: May 9, 2024 6:53 PM

Clay Alerts

Clay Alerts Clay alerts come in two types: embedded and stripe. Both types, along with several examples of each, are shown below. Embedded Alerts Embedded alerts are usually used inside forms. The...

Published Date: May 9, 2024 6:53 PM

Clay Badges

Clay Badges Badges help highlight important information such as notifications or new and unread messages. Badges have circular borders and are only used to specify a number. This covers the...

Published Date: May 9, 2024 6:53 PM

Clay Cards

Clay Cards Cards visually represent data. Use them for images, document libraries, user profiles and more. There are four main types of Cards: Image Cards File Cards User Cards Horizontal...

Published Date: May 9, 2024 6:53 PM

Clay Icons

Clay Icons The Liferay Clay taglibs provide several icons that you can use in your apps. Use the clay:icon tag and specify the icon with the symbol attribute: You can include icons in your app...

Published Date: May 9, 2024 6:53 PM

Clay Labels and Links

Clay Labels and Links Liferay Clay taglibs provide tags for creating labels and links in your app. Both of these elements are covered below. Labels The Liferay Clay taglibs provide a few different...

Published Date: May 9, 2024 6:53 PM

Clay Management Toolbar

Clay Management Toolbar The Management Toolbar gives administrators control over search container results in their apps. It lets you filter, sort, and choose a view type for search results, so you...

Published Date: May 9, 2024 6:53 PM

Clay Progress Bars

Clay Progress Bars You can add progress bars to your app with the clay:progressbar tag. These indicate the completion percentage of a task and come in three status styles: default (blue), warning...

Published Date: May 9, 2024 6:53 PM

Liferay Portlet Objects For JSPs

Liferay Portlet Objects For JSPs You may have noticed the tag in your JSPs. Similar to the theme:defineObjects tag, when you include this tag in your JSP, you gain access to several variables ...

Published Date: May 9, 2024 6:53 PM

Clay Stickers

Clay Stickers Whereas badges display numbers and labels display short information, stickers are small visual indicators of the content (usually the content type). They can include a small label or...

Published Date: May 9, 2024 6:53 PM

Liferay Theme Objects For JSPs

Liferay Theme Objects For JSPs When you include the tag in your JSP, you gain access to several Liferay theme objects via variables. These objects are described in the table below: ...

Published Date: May 9, 2024 6:53 PM

Liferay UI Tag Library

Liferay UI Tag Library The Liferay UI tag library provides tags that implement commonly used UI components. These tags make your markup consistent, responsive, and accessible. You can find a list...

Published Date: May 9, 2024 6:53 PM

Liferay UI Icon Help

Liferay UI Icon Help The icon help tag lets you communicate additional information to your users in an unobtrusive way. It renders as an iconic question mark that provides more information through...

Published Date: May 9, 2024 6:53 PM

Liferay UI Icon Lists

Liferay UI Icon Lists An icon list displays icons in a horizontal list, instead of in a pop-up navigation menu like an icon menu. You can see an example of an icon list menu in a message board...

Published Date: May 9, 2024 6:53 PM

Liferay UI Icon Menus

Liferay UI Icon Menus You can add a pop-up navigation menu to your app with the liferay-ui:icon-menu tag. Icon menus display menu options when needed, storing them away in a collapsed menu when...

Published Date: May 9, 2024 6:53 PM

Liferay UI Icons

Liferay UI Icons The Liferay UI taglibs provide several icons you can include in your apps. To add an icon to your app, use the liferay-ui:icon tag and specify the icon with either the icon,...

Published Date: May 9, 2024 6:53 PM

Liferay UI Tabs

Liferay UI Tabs Tabs create dividers that organize content into individual sections. Content can be embedded or included from another JSP. To add tabs to your app, use the tag and specify each...

Published Date: May 9, 2024 6:53 PM

Using Liferay Util Body Bottom

Using Liferay Util Body Bottom The body bottom tag is not a self-closing tag. It lets you add additional HTML or scripts to the bottom of the body tag. content placed between the opening and...

Published Date: May 9, 2024 6:53 PM

Using Liferay Util Get URL

Using Liferay Util Get URL The get URL tag scrapes the URL provided by the url attribute. If a value is provided for the var attribute, the content from the screen scrape is scoped to that...

Published Date: May 9, 2024 6:53 PM

Using Liferay Util Include

Using Liferay Util Include The include tag lets you include other JSP files in your portlet's JSP, theme, or web content. This can increase readability as well as provide separation of concerns for...

Published Date: May 9, 2024 6:53 PM

Liferay Util Tag Library

Liferay Util Tag Library The Liferay Util taglib is used to pull other resources into a portlet or theme. You can use it to specify which resources to insert at the bottom or top of the page's...

Published Date: May 9, 2024 6:53 PM

Using Liferay Util Body Top

Using Liferay Util Body Top The body top tag is not a self-closing tag. The content placed between the opening and closing of this tag is moved to the top of the body tag. When something is passed...

Published Date: May 9, 2024 6:53 PM

Using Liferay Util Buffer

Using Liferay Util Buffer The buffer tag is not a self-closing tag. The content placed between the opening and closing of this tag is saved to a buffer and its output is assigned to the Java...

Published Date: May 9, 2024 6:53 PM

Using Liferay Util Dynamic Include

Using Liferay Util Dynamic Include The dynamic include tag lets you specify a point or points in a JSP or theme where a developer can inject additional HTML, resources, or functionality, using the...

Published Date: May 9, 2024 6:53 PM

Using Liferay Util HTML Bottom

Using Liferay Util HTML Bottom The HTML bottom tag is not a self-closing tag. Content placed between the opening and closing of this tag is moved to the bottom of the tag. When something is passed...

Published Date: May 9, 2024 6:53 PM

Using Liferay Util HTML Top

Using Liferay Util HTML Top The HTML top tag is not a self-closing tag. The content placed between the opening and closing of this tag is moved to the tag. When something is passed using this...

Published Date: May 9, 2024 6:53 PM

Using Liferay Util Whitespace Remover

Using Liferay Util Whitespace Remover The whitespace remover tag removes line breaks and tabs from code blocks included between the opening and closing of the tag. Below is an example configuration...

Published Date: May 9, 2024 6:53 PM

Using a JSP and MVC Portlet

Using a JSP and MVC Portlet An easy way to start developing a web application is to add markup to a JSP file and render it using a portlet Java class. The W3E7 example application demonstrates...

Published Date: May 9, 2024 6:53 PM

Scoping Configurations

Scoping Configurations In Liferay DXP, you can set an application's configuration to different levels of scope: System, Instance, Site, or Portlet. For example, if you create an application to have...

Published Date: May 9, 2024 6:53 PM

Setting and Accessing Configurations

Setting and Accessing Configurations You can use Liferay's configuration framework to add a settings UI for a MVC Portlet. See the Example Portlet Then, follow these steps: Download and unzip...

Published Date: May 9, 2024 6:53 PM

Dependency Injection

Published Date: May 9, 2024 6:53 PM

Listening for Messages

Listening for Messages You can listen for messages sent to any registered Message Bus destination, whether it's built-in to DXP/Portal, defined by third-parties, or created by you. Messages sent to...

Published Date: May 9, 2024 6:53 PM

Tuning Messaging Performance

Tuning Messaging Performance Messaging performance is tuned at the destinations. Performance depends on the destination type, the amount of processing the message listeners require, and the thread...

Published Date: May 9, 2024 6:53 PM

Portlet Providers

Published Date: May 9, 2024 6:53 PM

Servlets

Published Date: May 9, 2024 6:54 PM

Client Extensions UI Reference

Client Extensions UI Reference Liferay's widget client extensions (custom element and iframe) register applications with Liferay, adding them as widgets to site pages. Additionally, you can style...

Published Date: May 9, 2024 6:54 PM

Message Bus

Message Bus The Message Bus provides a loosely coupled way to exchange messages. A class sending a message invokes the Message Bus to send the message to a destination, while other classes...

Published Date: May 9, 2024 6:53 PM

Using a CSS Client Extension

Using a CSS Client Extension Liferay 7.4+ CSS client extensions introduce new CSS styling to pages. A deployed CSS client extension on a page adds to the page's existing styling, including theme...

Published Date: May 9, 2024 6:54 PM

Using a JavaScript Client Extension

Using a JavaScript Client Extension Liferay 7.4+ With a JavaScript (JS) client extension, you can run your own JavaScript on any page in Liferay without worrying about dependencies on Liferay code...

Published Date: May 9, 2024 6:54 PM

CSS YAML Configuration Reference

CSS YAML Configuration Reference You can define a CSS client extension with a client-extension.yaml file. Usage Details This client-extension.yaml file defines a CSS client extension definition: ...

Published Date: May 9, 2024 6:54 PM

Theme CSS YAML Configuration Reference

Theme CSS YAML Configuration Reference You can define a theme CSS client extension with a client-extension.yaml file. Usage Details This client-extension.yaml file defines a theme CSS client...

Published Date: May 9, 2024 6:54 PM

Using a Theme Favicon Client Extension

Using a Theme Favicon Client Extension Liferay 7.4+ With a theme favicon client extension, you can override the theme's favicon on the selected page. Start with the sample workspace to build and...

Published Date: May 9, 2024 6:54 PM

Theme Favicon YAML Configuration Reference

Theme Favicon YAML Configuration Reference You can define a theme favicon client extension with a client-extension.yaml file. Usage Details This client-extension.yaml file defines a theme favicon...

Published Date: May 9, 2024 6:54 PM

Theme Sprite Map YAML Configuration Reference

Theme Sprite Map YAML Configuration Reference You can define a theme sprite map client extension with a client-extension.yaml file. Usage Details This client-extension.yaml defines a theme sprite...

Published Date: May 9, 2024 6:54 PM

JavaScript YAML Configuration Reference

JavaScript YAML Configuration Reference You can define a JavaScript client extension with a client-extension.yaml file. Usage Details This client-extension.yaml file defines a JavaScript client...

Published Date: May 9, 2024 6:54 PM

Using a Theme CSS Client Extension

Using a Theme CSS Client Extension Liferay 7.4+ With a theme CSS client extension, you can override the current theme's CSS files (main.css and clay.css) to change the look and feel of a page....

Published Date: May 9, 2024 6:54 PM

Using a Theme Sprite Map Client Extension

Using a Theme Sprite Map Client Extension Liferay DXP 2023.Q4+/Portal GA100+ With a theme sprite map client extension, you can override the default Clay sprite map used for icons on a page. Start...

Published Date: May 9, 2024 6:54 PM

Editor Config Contributor YAML Configuration Reference

Editor Config Contributor YAML Configuration Reference Liferay DXP 2024.Q1+/Portal GA112+ This feature is currently behind a release feature flag (LPS-186870). Read Release Feature Flags for more...

Published Date: May 9, 2024 6:54 PM

Using an Editor Config Contributor Client Extension

Using an Editor Config Contributor Client Extension Liferay DXP 2024.Q2+/Portal GA120+ Editor Config Contributor client extensions override existing CKEditor configuration in a...

Published Date: May 9, 2024 6:54 PM

Creating Data Sets

Creating Data Sets Liferay DXP 2024.Q1+/Portal GA112+ Currently, this feature is behind a release feature flag (LPS-164563). You can create data sets from different resources available through...

Published Date: May 9, 2024 6:54 PM

Using Data Set Actions

Using Data Set Actions Liferay DXP 2024.Q1/Portal GA112 Currently, this feature is behind a release feature flag (LPS-164563). Here are some examples for how to use data set actions and perform...

Published Date: May 9, 2024 6:54 PM

Batch YAML Configuration Reference

Batch YAML Configuration Reference Use a client-extension.yaml file to define a batch client extension. Usage Details This client-extension.yaml file defines a client extension of type batch: ...

Published Date: May 9, 2024 6:54 PM

Managing Data Sets

Managing Data Sets Liferay DXP 2024.Q1+/Portal GA112+ Currently, this feature is behind a release feature flag (LPS-164563). Once you create a data set, you can customize how users see it....

Published Date: May 9, 2024 6:54 PM

Data Set Visualization Modes

Data Set Visualization Modes Liferay DXP 2024.Q1+/Portal GA112+ Currently, this feature is behind a release feature flag (LPS-164563). To customize the data display in your data set, use the...

Published Date: May 9, 2024 6:54 PM

Importing/Exporting Data

Importing/Exporting Data Liferay Self-Hosted Liferay SaaS Liferay PaaS Liferay 7.4 If you want to import or export data from Liferay, you use batch client extensions. Use and reuse your data...

Published Date: May 9, 2024 6:54 PM

Integrating External Applications

Integrating External Applications Custom Element and IFrame client extensions register applications with Liferay and render them as widgets on site pages. When you create one of these frontend...

Published Date: May 9, 2024 6:54 PM

Integrating Microservices

Integrating Microservices Liferay Self-Hosted Liferay SaaS Liferay PaaS Liferay 7.4 You can define microservice client extensions to run your own code in response to events in your Liferay...

Published Date: May 9, 2024 6:54 PM

Notification Type YAML Configuration Reference

Notification Type YAML Configuration Reference You can define a notification type client extension with a client-extension.yaml file. Usage Details This client-extension.yaml file defines a...

Published Date: May 9, 2024 6:54 PM

Object Action YAML Configuration Reference

Object Action YAML Configuration Reference You can define an object action client extension with a client-extension.yaml file. Usage Details This client-extension.yaml defines an object action and...

Published Date: May 9, 2024 6:54 PM