Capability

Development and Tooling

Liferay offers a comprehensive toolkit to extend or customize your digital experience. Build applications quickly with low-code/no-code features like Objects, or leverage developer tools like Liferay Workspace and Blade CLI for further customizations.

For users on PaaS or running Self-Hosted, Liferay also offers tools deploying customizations.

Feature
Deployment Approach
Capability
Auto-Deploying Fragments
Official Documentation
Auto-Deploying Fragments Liferay Portal 7.3 GA1+ or Liferay DXP 7.3+ If you're developing page fragments with your own tooling, you can deploy them by packaging them in ZIP files for importing via...
Published Date: May 9, 2024 6:57 PM
Fragment Configuration Types Reference
Official Documentation
Fragment Configuration Types Reference Below are the available configuration types for fragments. See Adding Configuration Options to Fragments for more on how to make a fragment configurable. ...
Published Date: May 9, 2024 6:57 PM
Fragment Specific Tags and Attributes Reference
Official Documentation
Fragment Specific Tags and Attributes Reference Along with standard HTML, CSS, and JavaScript, you can use Liferay-specific tags and attributes to define editable sections, embed widgets, and more....
Published Date: May 9, 2024 6:57 PM
Best Practices for Using Fragment Configurations
Official Documentation
Best Practices for Using Fragment Configurations When you are creating page fragments for your site with your own configurations, it's your responsibility to use them in their HTML presentation...
Published Date: May 9, 2024 6:57 PM
Including Default Resources in Fragments
Official Documentation
Including Default Resources in Fragments You can include images files (e.g. .gif, .jpg, .jpeg, or .png) direct in your fragment sets. Keeping images with your fragments, rather than in other...
Published Date: May 9, 2024 6:57 PM
Theme CSS YAML Configuration Reference
Official Documentation
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
Developing Page Fragments
Official Documentation
Developing Page Fragments Page fragments are the building blocks for content pages. They're made from the three components of web pages: CSS, HTML, and JavaScript. To create a page you combine...
Published Date: May 9, 2024 6:57 PM
Using a Theme CSS Client Extension
Official Documentation
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
Developing Page Fragments Reference
Official Documentation
Developing Page Fragments Reference The Developing Fragments Reference provides essential information on key aspects of fragment development in Liferay. It covers command references, configuration...
Published Date: May 9, 2024 6:57 PM
Page Fragment Editor Interface Reference
Official Documentation
Page Fragment Editor Interface Reference The page fragment editor's interface is organized into two tabs: Code Editor Configuration The sections below cover how to use these portions of the...
Published Date: May 9, 2024 6:57 PM
Fragments Toolkit Command Reference
Official Documentation
Fragments Toolkit Command Reference The Fragments Toolkit is deprecated as of Liferay 2024.Q1+/Portal GA112+. See Alternatives for the Fragments Toolkit for more information. The Fragments...
Published Date: May 9, 2024 6:57 PM
Fragment Specific Tags and Attributes Reference for Liferay 7.3 and Earlier Versions
Official Documentation
Fragment Specific Tags and Attributes Reference for Liferay 7.3 and Earlier Versions Along with standard HTML, CSS, and JavaScript, you can use Liferay-specific tags and attributes to define...
Published Date: Nov 22, 2024 10:52 PM
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...
Published Date: May 9, 2024 6:57 PM
Importing/Exporting Data
Official Documentation
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
Using a Site Initializer Client Extension
Official Documentation
Using a Site Initializer Client Extension Liferay DXP 2023.Q4+/Portal GA100+ Site Initializer client extensions can quickly create or update a site, complete with configurations and content. Start...
Published Date: Oct 16, 2024 4:13 PM
Batch YAML Configuration Reference
Official Documentation
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
Site Initializer YAML Configuration Reference
Official Documentation
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
Official Documentation
Site Initializers Liferay DXP 2023.Q4+/Portal 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...
Published Date: Oct 16, 2024 4:33 PM
Integrating External Applications
Official Documentation
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
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...
Published Date: May 9, 2024 6:54 PM
Custom Element YAML Configuration Reference
Official Documentation
Custom Element YAML Configuration Reference You can define a custom element client extension with a client-extension.yaml file. Usage Details This client-extension.yaml file defines a custom...
Published Date: May 9, 2024 6:54 PM
JavaScript YAML Configuration Reference
Official Documentation
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 Favicon Client Extension
Official Documentation
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 Sprite Map YAML Configuration Reference
Official Documentation
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
Using an Editor Config Contributor Client Extension
Official Documentation
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
Editor Config Contributor YAML Configuration Reference
Official Documentation
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
Theme Favicon YAML Configuration Reference
Official Documentation
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
Using a Theme Sprite Map Client Extension
Official Documentation
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
Applying Styles to Fragments
Official Documentation
Applying Styles to Fragments When you add a fragment to a page, you can use the sidebar menu to configure the fragment, including the Styles configuration tab. Use the Styles tab in the sidebar...
Published Date: May 9, 2024 6:57 PM
Adding Configuration Options to Fragments
Official Documentation
Adding Configuration Options to Fragments Liferay DXP 7.2 SP1 Configurable options make your fragments flexible, minimizing the maintenance of similar fragments. For example, instead of creating...
Published Date: May 9, 2024 6:57 PM
Creating a Contributed Fragment Set
Official Documentation
Creating a Contributed Fragment Set Contributed fragment sets are deployable modules containing page fragments. Fragments in a contributed set can be used like regular fragments, but aren't...
Published Date: May 9, 2024 6:57 PM
Defining Fragment Drop Zones
Official Documentation
Defining Fragment Drop Zones Drop zones are integral to building your content pages. With them, you can create unique page layouts and dynamic displays by defining areas within fragments where...
Published Date: May 9, 2024 6:57 PM
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 ...
Published Date: May 9, 2024 6:57 PM
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....
Published Date: May 9, 2024 6:57 PM
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...
Published Date: May 9, 2024 6:57 PM
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...
Published Date: May 9, 2024 6:57 PM
Using Routes with Custom Elements
Official Documentation
Using Routes with Custom Elements Liferay 7.4+ Custom element client extensions use Liferay's frontend infrastructure to register external applications with the Liferay platform and render them as...
Published Date: May 9, 2024 6:54 PM
IFrame YAML Configuration Reference
Official Documentation
IFrame YAML Configuration Reference You can define an IFrame client extension with a client-extension.yaml file. Data Usage This client-extension.yaml file defines an IFrame client extension: ...
Published Date: May 9, 2024 6:54 PM
Using an IFrame Client Extension
Official Documentation
Using an IFrame Client Extension Liferay 7.4+ IFrame client extensions use Liferay's frontend infrastructure to register external applications as HTML elements. They're added to Liferay pages as...
Published Date: May 9, 2024 6:54 PM
Notification Type YAML Configuration Reference
Official Documentation
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