Site Search - Liferay Learn

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...

Object Validation Rule YAML Configuration Reference

Official Documentation

Object Validation Rule YAML Configuration Reference To define an Object Validation Rule client extension, add the objectValidationRule type to your client-extension.yaml file. Usage Details This...

CAPTCHA YAML Configuration Reference

Official Documentation

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

Using a Microservice Client Extension

Official Documentation

Using a Microservice Client Extension A microservice client extension is a standalone server process that relies on OAuth 2 for communication with Liferay. The microservice is a resource server and...

Workflow Action YAML Configuration Reference

Official Documentation

Workflow Action YAML Configuration Reference You can define a workflow action client extension with a client-extension.yaml file. Usage Details This client-extension.yaml file defines a workflow...

Setting the Order of Elements in a Fragment

Official Documentation

Setting the Order of Elements in a Fragment Liferay 7.4+ The Slider or Tab fragments are typically used to show different areas of information. Sliders present this information in a carousel of...

Using Custom Fields in Page Fragments

Official Documentation

Using Custom Fields in Page Fragments If you've added custom fields to Liferay's users or pages, you can access them in fragments. To get the value of a page custom field, use ...

Using the Fragments Editor

Official Documentation

Using the Fragments Editor Liferay DXP includes a built-in editor for developing content page fragments. To access the editor, open the Site Menu ( Site Menu ) and navigate to Design → Fragments....

Using the Fragments Toolkit

Official Documentation

Using the Fragments Toolkit The Fragments Toolkit is deprecated as of Liferay 2024.Q1+/Portal GA112+. See Alternatives for the Fragments Toolkit for more information. The Fragments Toolkit helps...

Validating Fragment Configurations

Official Documentation

Validating Fragment Configurations When defining fragment configuration options, you can add validation properties to text type fields that determine rules for valid entries. Determine what type of...

Creating a Basic Custom Element

Official Documentation

Creating a Basic Custom Element Liferay 7.4+ Custom element client extensions use Liferay's frontend infrastructure to register external, remote applications with the Liferay platform and render...

Marketplace

Official Documentation

Marketplace Liferay Marketplace is your central hub for downloadable Liferay themes, apps, and extensions. This centralized catalog showcases everything from global CSS themes, to connectors for...

Acquiring DXP Apps

Official Documentation

Acquiring DXP Apps There are two types of DXP apps in marketplace: free and paid. Free apps can be downloaded, deployed to Liferay DXP, and used immediately without deploying a license. Paid apps...

Acquiring Object Definitions from Marketplace

Official Documentation

Acquiring Object Definitions from Marketplace Object definitions package custom object configurations into applications. These apps are published as Client Extensions. After publication to Liferay...

Provisioning Cloud Apps

Official Documentation

Provisioning Cloud Apps You can provision cloud apps to your Liferay instance and start using them immediately. Unlike DXP apps, cloud apps integrate with Liferay SaaS directly and don't require...

Become a Publisher

Official Documentation

Become a Publisher To publish apps or solutions on Marketplace, you need a Liferay account with publisher permissions. Becoming a publisher is free, but you must submit a request with relevant...

Publishing Apps in Marketplace

Official Documentation

Publishing Apps in Marketplace The process of publishing a DXP app differs slightly from that of Cloud apps. Log into your Liferay account at marketplace.liferay.com. Open the Dashboard menu...

Publishable App Types in Marketplace

Official Documentation

Publishable App Types in Marketplace You can publish different types of applications in Marketplace. App TypeRuntime ArchitectureDeployment TypeTypical Complexity Cloud AppExternalLiferay SaaS /...

Publishing Object Definitions in Marketplace

Official Documentation

Publishing Object Definitions in Marketplace You can publish object definitions packaged as Client Extensions to Liferay Marketplace. Prerequisites: A valid Liferay Marketplace Publisher...

Publishing Solutions in Marketplace

Official Documentation

Publishing Solutions in Marketplace The Liferay Marketplace contains business solutions to improve productivity and reduce time to market. Currently, only existing Liferay partners can publish a...

Connecting Liferay DXP to Marketplace

Official Documentation

Connecting Liferay DXP to Marketplace Liferay DXP 2025.Q1+/GA132+ You can connect Liferay DXP to Marketplace in Instance Settings. With this integration, you can add supported apps from the...

Liferay Catalogs

Official Documentation

Liferay Catalogs Liferay Catalogs categorize applications in Marketplace. There are three catalogs developed and maintained by Liferay. Liferay Inc. Liferay Labs Liferay Community You can...

Tooling

Official Documentation

Tooling Liferay provides a variety of developer tools that include standard build scripting, lightweight CLI utilities, and full IDE based on Eclipse. This is to serve all developers, whether...

Blade CLI

Official Documentation

Blade CLI Blade CLI can be installed through a command line interface or a graphical installer. If you're behind a proxy, once it's installed you can configure it to operate through the proxy....

Generating Projects with Blade CLI

Official Documentation

Generating Projects with Blade CLI Blade CLI exists to create, build, and deploy Liferay projects in Liferay Workspaces. Once created, these projects can be imported into an IDE or worked on...

AI Tools in Workspace

Official Documentation

AI Tools in Workspace You can use the latest AI-based tools to jump start your projects in Liferay Workspace. Whether you prefer to code with Claude, Copilot, Cursor, Gemini, Windsurf, or any other...

Configuring a Liferay Docker Container

Official Documentation

Configuring a Liferay Docker Container Creating and deploying containers is an important part of the modern developer workflow. Liferay Workspace makes it easy to use Docker containers both for...

Liferay Developer Studio

Official Documentation

Liferay Developer Studio Liferay Developer Studio (LDS) is a Liferay-provided integrated development environment (IDE) for Liferay DXP. Built on the Eclipse platform, LDS inherits Eclipse's...

Updating Liferay Developer Studio

Official Documentation

Updating Liferay Developer Studio Apply Liferay Developer Studio (LDS) updates without reinstalling. Each Liferay IDE GitHub release ships an Eclipse updatesite archive...

Liferay Workspace

Official Documentation

Liferay Workspace Liferay Workspace is a set of folders and Gradle scripts that represents the Liferay-opinionated way of handling a full development life cycle: Creating projects Building...

Creating Code with Liferay Workspace

Official Documentation

Creating Code with Liferay Workspace Liferay Workspace is the developer's tool for creating and managing Liferay development projects. Creating Projects Blade CLI makes it easy to create projects...

Liferay Workspace Configuration Reference

Official Documentation

Liferay Workspace Configuration Reference Liferay Workspace has many options you can set. Here's a handy command and properties reference. Running Liferay DXP locally my-project $ blade gw...

Deploying Modules from Liferay Developer Studio

Official Documentation

Deploying Modules from Liferay Developer Studio Push a module from your Liferay Workspace to a running Liferay DXP server without leaving the IDE. Prerequisites A configured Liferay server in...

Installing a Liferay Server in Liferay Developer Studio

Official Documentation

Installing a Liferay Server in Liferay Developer Studio Register a Liferay DXP bundle with Liferay Developer Studio (LDS) so you can start, stop, debug, and deploy to it from the IDE. Each...

Troubleshooting Blade CLI

Official Documentation

Troubleshooting Blade CLI If Blade CLI isn't working as expected, you may find answers here. The blade command is not available in my CLI The Blade CLI installer adds the blade command to your...

Configuring Liferay Workspace

Official Documentation

Configuring Liferay Workspace Liferay Workspace is simple to use, and you can learn the basics by starting at the beginning. If you're happily creating projects, deploying code, or using a Docker...

Creating A Liferay Workspace

Official Documentation

Creating A Liferay Workspace You can create a Liferay Workspace manually or with Blade CLI. Creating a Liferay Workspace Manually To create a Liferay Workspace manually, you must have Gradle...

Creating Deployment Environments

Official Documentation

Creating Deployment Environments There comes a point when your code is ready to share. For that, you must build an environment. In the corporate world, there are usually three environments: ...

Upgrading Code with Liferay Workspace

Upgrading Code with Liferay Workspace When moving to a new release of Liferay, your code must move with it. Liferay Workspace has a dedicated Blade/Gradle command to help you migrate your code to...

Liferay CLI Tool

Official Documentation

Liferay CLI Tool The Liferay CLI tool is deprecated as of Liferay 2024.Q4/Portal GA129, and it's planned for future removal. The Liferay CLI tool makes it easy to create Angular, JavaScript,...

Upgrading to Jakarta

Official Documentation

Upgrading to Jakarta Liferay DXP 2025.Q3+ Liferay stepped into the future of enterprise Java when it moved to Jakarta EE starting with the DXP 2025 Q3 and the 2026 Q1 Portal releases. This frees...

Other Tools (Deprecated)

Official Documentation

Other Tools (Deprecated) These tools are deprecated as of Liferay 2024.Q4/Portal GA129, and they are planned for future removal. Modern browsers (and Liferay DXP) all support including JavaScript...

Liferay npm Bundler (Deprecated)

Official Documentation

Liferay npm Bundler (Deprecated) The Liferay npm bundler is deprecated of Liferay 2024.Q4/Portal GA129, and it's planned for future removal.

Bundler Migration Guide

Official Documentation

Bundler Migration Guide The Liferay npm bundler is deprecated of Liferay 2024.Q4/Portal GA129, and it's planned for future removal.

Migrating an Angular Project to Use Liferay npm Bundler 2.x

Official Documentation

Migrating an Angular Project to Use Liferay npm Bundler 2.x The Liferay npm bundler is deprecated of Liferay 2024.Q4/Portal GA129, and it's planned for future removal. Follow these steps to...

Migrating a liferay-npm-bundler Project from 1.x to 2.x

Official Documentation

Migrating a liferay-npm-bundler Project from 1.x to 2.x The Liferay npm bundler is deprecated of Liferay 2024.Q4/Portal GA129, and it's planned for future removal. liferay-npm-bundler 2.x offers...

Migrating Your Project to Use liferay-npm-bundler's New Mode

Official Documentation

Migrating Your Project to Use liferay-npm-bundler's New Mode The Liferay npm bundler is deprecated of Liferay 2024.Q4/Portal GA129, and it's planned for future removal. Since issue #303, two...

Migrating a Plain JavaScript, Billboard JS, JQuery, Metal JS, React, or Vue JS Project to Use Liferay npm Bundler 2.x

Official Documentation

Migrating a Plain JavaScript, Billboard JS, JQuery, Metal JS, React, or Vue JS Project to Use Liferay npm Bundler 2.x The Liferay npm bundler is deprecated of Liferay 2024.Q4/Portal GA129, and...

Changes Between Bundler 1.x and 2.x

Official Documentation

Changes Between Bundler 1.x and 2.x The Liferay npm bundler is deprecated of Liferay 2024.Q4/Portal GA129, and it's planned for future removal. This article outlines the key changes between...

Default Bundler Loaders

Official Documentation

Default Bundler Loaders The Liferay npm bundler is deprecated of Liferay 2024.Q4/Portal GA129, and it's planned for future removal. Several loaders are available for the liferay-npm-bundler by...

How AMD Loader Configuration is Exported

Official Documentation

How AMD Loader Configuration is Exported The Liferay npm bundler is deprecated of Liferay 2024.Q4/Portal GA129, and it's planned for future removal. If you don't understand how Liferay AMD...

How the Bundler Publishes npm Packages

Official Documentation

How the Bundler Publishes npm Packages The Liferay npm bundler is deprecated of Liferay 2024.Q4/Portal GA129, and it's planned for future removal. When you deploy an OSGi bundle with the...

How JavaScript Modules are Formatted for AMD

Official Documentation

How JavaScript Modules are Formatted for AMD The Liferay npm bundler is deprecated of Liferay 2024.Q4/Portal GA129, and it's planned for future removal. Liferay AMD Loader is based on the AMD...

Understanding Bundler Configuration Presets

Official Documentation

Understanding Bundler Configuration Presets The Liferay npm bundler is deprecated of Liferay 2024.Q4/Portal GA129, and it's planned for future removal. The liferay-npm-bundler comes with a...

Liferay npm Bundler

Official Documentation

Liferay npm Bundler The Liferay npm bundler is deprecated of Liferay 2024.Q4/Portal GA129, and it's planned for future removal. The liferay-npm-bundler is a bundler (like Webpack or Browserify)...

Understanding the Liferay npm Bundler Loader

Official Documentation

Understanding the Liferay npm Bundler Loader The Liferay npm bundler is deprecated of Liferay 2024.Q4/Portal GA129, and it's planned for future removal. liferay-npm-bundler's mechanism is...

Creating A Path File

Official Documentation

Creating A Path File Test Scenario Write your first path file using the test scenario below: You would like to test that your name does not appear on any learn.liferay.com article. The steps you...

Understanding the npmbundlerrc Structure

Official Documentation

Understanding the npmbundlerrc Structure The Liferay npm bundler is deprecated of Liferay 2024.Q4/Portal GA129, and it's planned for future removal. The liferay-npm-bundler is configured via a...

Poshi Test Automation

Official Documentation

Poshi Test Automation Poshi is a test automation framework that is simple, easy to understand, and does not require prior development experience to get started. Poshi tests can be written to...

OSGi Bundles and npm Package Structure

Official Documentation

OSGi Bundles and npm Package Structure The Liferay npm bundler is deprecated of Liferay 2024.Q4/Portal GA129, and it's planned for future removal. To deploy JavaScript modules, you must create an...

Search Results