Development and tooling

Using a Frontend Data Set Cell Renderer Client Extension

Using a Frontend Data Set Cell Renderer Client Extension Liferay 7.4+ You can use Frontend Data Set (FDS) cell renderer client extensions to customize the display for your data set. Use this type...

Published Date: Aug 15, 2024 3:42 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, 2024 3:42 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, 2024 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, 2024 3:48 PM

Using a Site Initializer Client Extension

Using a Site Initializer Client Extension Liferay 7.4 2023.Q4+/GA100+ Site Initializer client extensions can quickly create a site, complete with configurations and content. Start with the sample...

Published Date: Oct 16, 2024 4:13 PM

Site Initializer YAML Configuration Reference

Site Initializer YAML Configuration Reference Liferay Self-Hosted Liferay SaaS Liferay PaaS Liferay 7.4 Use a client-extension.yaml file to define a Site Initializer client extension. Usage...

Published Date: Oct 16, 2024 4:13 PM

Site Initializers

Site Initializers Liferay 2023.Q4+/GA100+ Site Initializers package pages, content, and configurations to help you jump-start a new site with much of the site already built. You can reuse them...

Published Date: Oct 16, 2024 4:33 PM

Using Liferay Util Param

Using Liferay Util Param The param tag lets you set a parameter for an included JSP page. This configuration requires two JSPs. JSP A, the main view of the app, includes JSP B and sets its...

Published Date: Nov 22, 2024 10:50 PM

Using Localized Messages in an MVC Portlet

Using Localized Messages in an MVC Portlet Liferay's localization framework is for creating localized messages in your MVC portlet. Deploy the Sample Code Then, follow these steps: Download...

Published Date: Nov 22, 2024 10:50 PM

PortletMVC4Spring Configuration Files

PortletMVC4Spring Configuration Files A PortletMVC4Spring application has these descriptors, Spring contexts, and properties files in its WEB-INF folder: web.xml → Web application descriptor ...

Published Date: Nov 22, 2024 10:50 PM

Client Extensions

Client Extensions Liferay Self-Hosted Liferay SaaS Liferay PaaS Liferay 7.4 When you want to extend Liferay, either by modifying its look and feel or by calling functions outside of Liferay, you...

Published Date: Nov 22, 2024 10:50 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: Nov 22, 2024 10:50 PM

Using Spring

Using Spring PortletMVC4Spring is deprecated due to a future migration to Jakarta EE 10. Instead, use client extensions or Liferay Objects if possible. Alternatively, use Liferay's MVC Portlet. ...

Published Date: Nov 22, 2024 10:50 PM

Reference

Reference PortletMVC4Spring integrates Spring, the Spring Web Framework, and the MVC design pattern with portlet development. As such, it uses configuration files from each of these areas and...

Published Date: Nov 22, 2024 10:50 PM

PortletMVC4Spring Annotations

PortletMVC4Spring Annotations PortletMVC4Spring provides several annotations for mapping requests to controller classes and controller methods. @RenderMapping Annotation Examples The following...

Published Date: Nov 22, 2024 10:50 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: Nov 22, 2024 10:50 PM

Using React

Using React Build your own solutions using Liferay and React.

Published Date: Nov 22, 2024 10:50 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: Nov 22, 2024 10:50 PM

Using Object Data with React Charts

Using Object Data with React Charts Here you'll use Objects, Headless APIs, and custom element remote applications to create a dynamic chart for data dashboards. First, you'll set up a new DXP...

Published Date: Nov 22, 2024 10:50 PM

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: Nov 22, 2024 10:50 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: Nov 22, 2024 10:50 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: Nov 22, 2024 10:50 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: Nov 22, 2024 10:50 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: Nov 22, 2024 10:50 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: Nov 22, 2024 10:50 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: Nov 22, 2024 10:50 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: Nov 22, 2024 10:50 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: Nov 22, 2024 10:50 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: Nov 22, 2024 10:50 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: Nov 22, 2024 10:50 PM

Data Set Sorting

Data Set Sorting Liferay DXP 2024.Q1 U112 [Beta Feature](../../../system-administration/configuring-liferay/feature-flags.md#beta-feature-flags) While managing data sets, you can set default...

Published Date: Nov 22, 2024 10:50 PM

Contributing to Liferay Development

Contributing to Liferay Development The first thing to do in learning to fix bugs or contributing a feature is to become familiar with how to build the system. The Liferay Portal build system now...

Published Date: Nov 22, 2024 10:50 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: Nov 22, 2024 10:50 PM

APIs as OSGi Services

APIs as OSGi Services After you've learned what a module is and how to deploy one, you can use modules to define APIs and implement them. Liferay APIs are OSGi services, defined by Java interfaces...

Published Date: Nov 22, 2024 10:50 PM

Configuring Dependencies

Configuring Dependencies Liferay provides a container where modules can publish and consume functionality through their Java packages. Modules can leverage packages from other modules or...

Published Date: Nov 22, 2024 10:50 PM

Finding Artifacts

Finding Artifacts To use external artifacts in your project, you must configure their dependencies in your build.gradle Gradle script. Before specifying an artifact as a dependency, you must first...

Published Date: Nov 22, 2024 10:50 PM

Resolving Third Party Library Package Dependencies

Resolving Third Party Library Package Dependencies An application can rely on multiple OSGi modules. Resolving their Java package dependencies can be challenging. In a perfect world, every package...

Published Date: Nov 22, 2024 10:50 PM

Exporting Packages

Exporting Packages In OSGi, packages are private by default. You must explicitly exporting a package so other modules can import and use them. Here's how to export packages: Open your bnd.bnd...

Published Date: Nov 22, 2024 10:50 PM

Importing Packages

Importing Packages You often find yourself in a position of needing functionality provided by another module. To access this functionality, you must import packages from other modules into your...

Published Date: Nov 22, 2024 10:50 PM

Module Projects

Module Projects Liferay applications and customizations are OSGi modules: .jar files containing Java code and some extra configuration for publishing and consuming APIs. A module project comprises...

Published Date: Nov 22, 2024 10:50 PM