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 widgets. For applications that include multiple routes (e.g., React Router), you can define remote application properties to determine which routes are used for a widget at runtime. These properties can be set for an application via the Remote Apps menu in Liferay or the widget’s configuration options once deployed.
Deploying Custom elements or IFrames like other types of client extensions is a beta feature in Liferay 7.4. This tutorial deploys custom element remote applications differently, and it is still the recommended approach until a future update.
In this tutorial, you’ll create a basic React application using Liferay’s create_custom_element.sh
script, which generates a sample app with three routes: hello-world
, hello-foo
, hello-bar
. After compiling the application and hosting its .js
and .css
files, you’ll register the application with Liferay and deploy it as a page widget. Finally, you’ll configure it to use each of the alternative routes.
Custom element client extensions can use any technology, regardless of how it’s built, packaged, or hosted. This tutorial only offers a sample custom element application with basic routing.
Running create_custom_element.sh
requires the latest versions of Node.JS, NPM, and YARN. Before proceeding, ensure these tools are installed.
Creating, Building, and Hosting the React Application
-
Start a new Liferay DXP 7.4+ container. You can continue to the next steps while the container starts.
docker run -it -m 8g -p 8080:8080 liferay/dxp:2024.q1.1
-
Run this command in a separate terminal to generate the React application.
curl -Ls https://github.com/liferay/liferay-portal/raw/master/tools/create_custom_element.sh | bash -s j1v3-custom-element react
-
Verify the application was created successfully.
The script creates a new React application called
j1v3-custom-element
with these elements:j1v3-custom-element ├── node_modules ├── README.md ├── package.json ├── public │ └── index.html ├── src │ ├── common │ │ ├── services │ │ │ └── liferay │ │ │ ├── api.js │ │ │ └── liferay.js │ │ └── styles │ │ ├── hello-world.scss │ │ ├── index.scss │ │ └── variables.scss │ ├── index.js │ └── routes │ ├── hello-bar │ │ └── pages │ │ └── HelloBar.js │ ├── hello-foo │ │ └── pages │ │ └── HelloFoo.js │ └── hello-world │ └── pages │ └── HelloWorld.js └── yarn.lock
-
Navigate to the new
j1v3-custom-element
folder and build the application.cd j1v3-custom-element
yarn build
-
Verify the build succeeded and note the application’s
.js
and.css
files.Creating an optimized production build... Compiled successfully. File sizes after gzip: 43.51 kB build/static/js/main.114dde4a.js 121 B build/static/css/main.9877909d.css
-
Sign in to Liferay at
<http://localhost:8080>
using the email address test@liferay.com and the password test. When prompted, change the password to learn. -
Open the Site Menu (), expand Content & Data, and go to Documents and Media.
-
Click Add () and select Multiple Files Upload.
-
Drag and drop the
.js
and.css
files into the upload area. -
Click Publish.
This adds the files to the Liferay Document Library and assigns them unique WebDAV URLs, which you’ll use to create the remote application.
This tutorial hosts the application’s static resources in Liferay’s Document Library for demonstration purposes. In a production environment, you should host the application’s files on a server optimized for hosting static resources.
To view each file’s URL, click the Info icon () and select one of the files at a time. Copy each file’s WebDAV URL and save them for use in the next step.
For example,
http://localhost:8080/webdav/guest/document_library/main.114dde4a.js
http://localhost:8080/webdav/guest/document_library/main.9877909d.css
Registering and Deploying the Application
-
Open the Global Menu (), click on the Applications tab, and go to Remote Apps.
-
Click Add ().
-
Enter these values:
Field Value Name J1V3-Custom-Element Type Custom Element HTML Element Name j1v3-custom-element
URL WebDAV URL for the .js
fileCSS URL WebDAV URL for the .css
fileInstanceable ✔ Portlet Category Name Remote Apps -
Click Save.
Once saved, Liferay creates a widget named J1V3-Custom-Element, which you can deploy to Site Pages like any other Page widget. It appears under the selected Portlet Category Name.
Since J1V3-Custom-Element is instanceable, you can add many of them to a page, each with its own independent configuration. For this example, add the widget to a page twice.
Using the route
Property
The auto-generated app includes three routes: hello-world
, hello-foo
, hello-bar
. By default the application uses the hello-world
route. However, you can use remote application properties to configure it to use an alternate route. You can set these properties via the Remote Apps menu or a widget’s configuration options.
Defining a Route Property via the Remote Apps Menu
-
Open the Global Menu (), click on the Applications tab, and go to Remote Apps.
-
Select J1V3-Custom-Element.
-
Enter
route=hello-foo
into the Properties field. -
Click Publish.
-
Verify both deployed widgets use the
HelloFoo
route.
Defining a Route Property via Widget Configuration
-
Edit the Page containing the J1V3-Custom-Element widgets.
-
Click the Options button () for one of the widgets and select Configuration.
-
Enter
route=hello-bar
into the Properties field. -
Click Save.
-
Verify the configured widget uses the
hello-bar
route, while the other widget still uses thehello-foo
route.
Analyzing the Route Code
This index.js
file creates the WebComponent
class, which extends the HTMLElement
interface. This class implements the interface’s connectedCallback()
function, which calls ReactDOM.render
with App
as a parameter. When App
is called, it checks for any defined "route"
attribute and compares that value with the available routes. If it matches either hello-foo
or hello-bar
, it returns and renders the corresponding route. Otherwise, it returns and renders hello-world
.
Each of the routes is imported into the index.js
file from the routes
folder:
routes
├── hello-bar
│ └── pages
│ └── HelloBar.js
├── hello-foo
│ └── pages
│ └── HelloFoo.js
└── hello-world
└── pages
└── HelloWorld.js