README.md

Liferay Client Extensions Samples

Automatically mirror official client extensions samples you can find in the main repo here: https://github.com/liferay/liferay-portal/tree/master/workspaces/liferay-sample-workspace/client-extensions

The goal of this repository is to ease the process of trying out client extensions samples by removing the burden of cloning liferay-portal & by renaming ambiguous client extensions (e.g. custom-element-1).

The official readme file for those samples is mirrored in the HOW-TO.md.

The new naming is an arbitrary choice based on the description provided by Liferay in the readme file. Here's the correspondance for the renamed client extensions:

Original name	New name
liferay-sample-custom-element-1	liferay-sample-custom-element-vanilla-js
liferay-sample-custom-element-2	liferay-sample-custom-element-react-scripts
liferay-sample-custom-element-3	liferay-sample-custom-element-angular
liferay-sample-custom-element-4	liferay-sample-custom-element-react-dom
liferay-sample-custom-element-5	liferay-sample-custom-element-react-clayui
liferay-sample-etc-frontend	liferay-sample-etc-frontend-shared-import-map
liferay-sample-global-js-1	liferay-sample-global-js-page
liferay-sample-global-js-2	liferay-sample-global-js-page-with-attributes
liferay-sample-global-js-2	liferay-sample-global-js-instance
liferay-sample-iframe-1	liferay-sample-iframe-counter
liferay-sample-iframe-2	liferay-sample-iframe-wikipedia
liferay-sample-theme-css-1	liferay-sample-theme-css-styled
liferay-sample-theme-css-2	liferay-sample-theme-css-unstyled
liferay-sample-theme-css-3	liferay-sample-theme-css-token-definition
liferay-sample-theme-css-4	liferay-sample-theme-css-unstyled-token-definition
liferay-sample-theme-spritemap-1	liferay-sample-theme-spritemap-single-svg
liferay-sample-theme-spritemap-2	liferay-sample-theme-spritemap-multiple-svg

Aditional information

If the build fails because of the Node version, you can force the use of a specific version by changing the build.gradle with something like:

apply plugin: "com.liferay.node"

node {
	nodeVersion = "20.10.0"
	global = false
}

Note that you can apply this for a specific client extension or all client extensions if you change the value in the parent folder (client-extensions or your liferay workpace).