npm Vue.js Portlet Template

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

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

or

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

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

Note: The minifier fails on Liferay DXP 7.0 when JSDoc is present in a portlet. To resolve this, use Grunt uglify to remove the JSDoc comments. This process may take a long time, depending on the number of files that require an update.

The template for this kind of project is npm-vuejs-portlet. Suppose you want to create an npm Vue.js portlet project called my-npm-vuejs-portlet with a package name of com.liferay.npm.vuejs and a class name of MyNpmVuejsPortlet. 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-vuejs-portlet -v 7.0 -p com.liferay.npm.vuejs -c MyNpmVuejsPortlet my-npm-vuejs-portlet

or

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

Important: This sample works for Liferay DXP 7.0 Fix Pack 44+ and Liferay Portal CE GA7+.

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

• my-npm-vuejs-portlet
  • .mvn (only in Maven Blade CLI generated projects)
    • wrapper
      • maven-wrapper.jar
      • maven-wrapper.properties
  • src
    • main
      • java
        • com/liferay/npm/vuejs
          • constants
            • MyNpmVuejsPortletKeys.java
          • portlet
            • MyNpmVuejsPortlet.java
      • resources
        • content
          • Language.properties
        • META-INF
          • resources
            • lib
              • index.es.js
            • init.jsp
            • view.jsp
  • .babelrc
  • .npmbundlerrc
  • bnd.bnd
  • [build.gradle|pom.xml]
  • mvnw (only in Maven Blade CLI generated projects)
  • mvnw.cmd (only in Maven Blade CLI generated projects)
  • 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.