Development and tooling

Packaging Client Extensions

Packaging Client Extensions Liferay Self-Hosted Liferay SaaS Liferay PaaS Liferay 7.4 Client extension projects are built as deployable archives called Liferay Universal File Format Archives...

Published Date: May 9, 24, 6:53 PM

PortletMVC4Spring Project Anatomy

PortletMVC4Spring Project Anatomy PortletMVC4Spring portlets are packaged in WARs. Liferay provides Maven archetypes for creating projects configured to use JSP/JSPX and Thymeleaf templates. Their...

Published Date: May 9, 24, 6:53 PM

Using React

Using React Build your own solutions using Liferay and React.

Published Date: May 9, 24, 6:53 PM

React Component Utilities Reference

React Component Utilities Reference Several useful tools are available to help you build high-performance components and applications in Liferay DXP using React: frontend-js-react-web module ...

Published Date: May 9, 24, 6:53 PM

Remote Applications with Headless APIs

Remote Applications with Headless APIs Available 7.4+ After creating and publishing objects, headless REST APIs are automatically generated. Here you'll see how to integrate these endpoints to...

Published Date: May 9, 24, 6:53 PM

Client Extension Reference

Client Extension Reference Liferay Self-Hosted Liferay SaaS Liferay PaaS Liferay 7.4 You can find code examples for all types of client extensions in liferay-portal Frontend Client Extensions ...

Published Date: Jun 21, 24, 3:41 PM

Working with Client Extensions

Working with Client Extensions Liferay Self-Hosted Liferay SaaS Liferay PaaS Liferay 7.4 Using client extensions, you can extend Liferay without deploying OSGi modules. Just like traditional...

Published Date: May 9, 24, 6:53 PM

Configuration as Code

Configuration as Code Liferay Self-Hosted Liferay SaaS Liferay PaaS Liferay 7.4 Liferay instance configurations are deployable with client extensions. For example, you can deploy OAuth2...

Published Date: May 9, 24, 6:53 PM

Instance Settings YAML Configuration Reference

Instance Settings YAML Configuration Reference You can use an instance settings client extension to configure a wide variety of Liferay configurations. Each configuration is referenced by its PID...

Published Date: May 9, 24, 6:53 PM

OAuth Headless Server YAML Configuration Reference

OAuth Headless Server YAML Configuration Reference You can define an OAuth headless server client extension with a client-extension.yaml file. Usage Details This client-extension.yaml file defines...

Published Date: May 9, 24, 6:53 PM

Categorizing a Configuration

Categorizing a Configuration When you register a configuration interface, the UI for your application is generated in System Settings → Platform → Third Party. If you prefer a different section and...

Published Date: May 9, 24, 6:53 PM

Configuration Form Renderer

Configuration Form Renderer When you create a configuration interface, a configuration UI is automatically generated. But in some cases you want customize the look and feel of the UI. For example,...

Published Date: May 9, 24, 6:53 PM

OAuth User Agent YAML Configuration Reference

OAuth User Agent YAML Configuration Reference You can define an OAuth user agent client extension with a client-extension.yaml file. Usage Details This client-extension.yaml file defines an OAuth...

Published Date: May 9, 24, 6:53 PM

Core Frameworks

Published Date: May 9, 24, 6:53 PM

Configuration Framework

Configuration Framework Setting and Accessing Configurations Categorizing a Configuration Scoping Configurations Portlet Level Configuration Configuration Form Renderer DDM Form Annotations ...

Published Date: May 9, 24, 6:53 PM

Completely Custom Configuration

Completely Custom Configuration A configuration UI is generated automatically when you create a configuration interface. But in some cases you want a completely custom UI for your configuration....

Published Date: May 9, 24, 6:53 PM

Configuration Model Listener Reference

Configuration Model Listener Reference Use model listeners in your own configurations to listen for events and execute code in response. Creating a model listener requires only three steps: ...

Published Date: May 9, 24, 6:53 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, 24, 6:53 PM

DDM Form Annotations

DDM Form Annotations The auto-generated configuration interface UI may be too simplistic for some configurations. You can use the Dynamic Data Mapping (DDM) form annotations to customize your...

Published Date: May 9, 24, 6:53 PM

Field Options Provider

Field Options Provider You can populate a drop-down list manually in the @Meta.AD annotation of the configuration interface. But you can also populate the option labels and values automatically...

Published Date: May 9, 24, 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, 24, 6:53 PM

Hiding the Configuration UI

Hiding the Configuration UI Liferay generates a configuration UI automatically after a configuration interface deploys. But you may have certain use cases where you want to hide the UI. For...

Published Date: May 9, 24, 6:53 PM

Portlet Level Configuration

Portlet Level Configuration With the configuration framework, you can set your application's configuration for different levels of scope. Where Instance and Site-scoped configurations use...

Published Date: May 9, 24, 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, 24, 6:53 PM

Dependency Injection

Published Date: May 9, 24, 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, 24, 6:53 PM

Listening for Registration Events

Listening for Registration Events Liferay DXP 2023.Q3/Portal 7.4 GA92 and Below The messaging API supports listening for destination and message listener registration events. Here are some reasons...

Published Date: May 9, 24, 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, 24, 6:53 PM

Using Asynchronous Messaging

Using Asynchronous Messaging Message Bus's asynchronous option provides fire and forget behavior; send a message and continue processing without waiting for a response. An asynchronous message is...

Published Date: May 9, 24, 6:53 PM

Using Default Synchronous Messaging in Previous Versions

Using Default Synchronous Messaging in Previous Versions Synchronous messaging was removed and is no longer supported for Liferay DXP 7.4 U49/Liferay Portal 7.4 GA49 and above. In default...

Published Date: May 9, 24, 6:53 PM

Using Direct Synchronous Messaging in Previous Versions

Using Direct Synchronous Messaging in Previous Versions Synchronous messaging was removed and is no longer supported for Liferay DXP 7.4 U49/Liferay Portal 7.4 GA49 and above. Direct synchronous...

Published Date: May 9, 24, 6:53 PM

Portlet Providers

Published Date: May 9, 24, 6:53 PM

Customizing Liferay's Look and Feel

Customizing Liferay's Look and Feel One of the easiest ways to get started developing on Liferay's platform is to modify its look and feel. You can change everything from its favicon to its entire...

Published Date: May 9, 24, 6:54 PM

Servlets

Published Date: May 9, 24, 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, 24, 6:54 PM

Micro Frontends

Micro Frontends Micro frontends extend the concept of microservices to the frontend side of development. You can build a fully-featured and powerful browser application that uses a microservice...

Published Date: May 9, 24, 6:55 PM

Bundling Resources in a JavaScript Import Map Entry Client Extension

Bundling Resources in a JavaScript Import Map Entry Client Extension Liferay 7.4 2023.Q1+/GA92+ JavaScript import map entry client extensions make JavaScript code or resources available to any...

Published Date: Sep 14, 24, 3:48 PM

JavaScript Import Map Entry YAML Configuration Reference

JavaScript Import Map Entry YAML Configuration Reference Usage Details This client-extension.yaml file defines a JavaScript import map entry client extension: assemble: - from: build/static ...

Published Date: Sep 14, 24, 3:48 PM

Frontend Data Set Cell Renderer YAML Reference

Frontend Data Set Cell Renderer YAML Reference You can define a Frontend Data Set cell renderer client extension with a client-extension.yaml file. Usage Details The client-extension.yaml file...

Published Date: Aug 15, 24, 3:42 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, 24, 6:54 PM