npm React Portlet Template

In this article, you’ll learn how to create an npm React portlet as a Liferay module. To create an npm React portlet via the command line using Blade CLI or Maven, use one of the commands with the following parameters:

blade create -t npm-react-portlet -v 7.0 [-p packageName] [-c className] projectName


mvn archetype:generate \
    -DarchetypeGroupId=com.liferay \
    -DarchetypeArtifactId=com.liferay.project.templates.npm.react.portlet \
    -DartifactId=[projectName] \
    -Dpackage=[packageName] \
    -DclassName=[className] \

You can also insert the -b maven parameter in the Blade command to generate a Maven project using Blade CLI.

The template for this kind of project is npm-react-portlet. Suppose you want to create an npm React portlet project called my-npm-react-portlet with a package name of com.liferay.npm.react and a class name of MyNpmReactPortlet. Also, you’d like to create a service of type javax.portlet.Portlet that extends the com.liferay.portal.kernel.portlet.bridges.mvc.MVCPortlet class. Here, service means an OSGi service, not a Liferay API. Another way to say service type is to say component type. You could run the following command to accomplish this:

blade create -t npm-react-portlet -v 7.0 -p com.liferay.npm.react -c MyNpmReactPortlet my-npm-react-portlet


mvn archetype:generate \
    -DarchetypeGroupId=com.liferay \
    -DarchetypeArtifactId=com.liferay.project.templates.npm.react.portlet \
    -DgroupId=com.liferay \
    -DartifactId=my-npm-react-portlet \
    -Dpackage=com.liferay.npm.react \
    -Dversion=1.0 \
    -DclassName=MyNpmReactPortlet \
    -DpackageJsonVersion=1.0.0 \

After running the command above, your project’s directory structure looks like this:

  • my-npm-react-portlet
    • [gradle|.mvn]
      • wrapper
        • [gradle|maven]-wrapper.jar
        • [gradle|maven]
    • src
      • main
        • java
          • com/liferay/npm/react
            • constants
            • portlet
        • resources
          • content
          • META-INF
            • resources
              • js
              • init.jsp
              • view.jsp
    • .babelrc
    • .npmbundlerrc
    • bnd.bnd
    • [build.gradle|pom.xml]
    • [gradlew|mvnw]
    • package.json

The generated module is a working application and is deployable to a Liferay DXP instance. To build upon the generated portlet, modify the project by adding logic and additional files to the folders outlined above.

« npm Portlet Templatenpm Vue.js Portlet Template »