Using the Fragments Toolkit

Note

The Fragments Toolkit is deprecated as of Liferay 2024.Q1+/Portal 7.4 GA112+. See Alternatives for the Fragments Toolkit for more information.

The Fragments Toolkit helps you develop and manage Fragments locally, using your favorite tools. Here you’ll use the toolkit to generate a Fragments Project with sample Fragments, deploy it, and add your own Fragments Set to it.

Note

For Liferay DXP 7.4+, Fragment Collections are called Fragment Sets in the Liferay UI.

Setting Up the Toolkit

The toolkit requires this software:

NPM and Yarn are package managers that you’ll use to install the toolkit and modules it depends on.

Start with installing an NPM and Node.js via a Node.js LTS.

Download and unzip the example JavaScript project ZIP file.

curl https://resources.learn.liferay.com/dxp/latest/en/site-building/developer-guide/developing-page-fragments/liferay-x2y6.zip -O

unzip liferay-x2y6.zip

Set up the Fragments Toolkit and its dependencies using the setup_tutorial.sh script.
```
cd liferay-x2y6
```
```
./setup_tutorial.sh
```
Note

The setup_tutorial.sh script provides commands for setting up Yeoman, Yarn, and the toolkit. The script is available in the example project’s ZIP file.

Resolve all unmet requirements reported by the script and rerun the script until it reports that your environment is ready.

Create a Fragments Project

The Fragments Toolkit’s yo liferay-fragments command launches an interface for generating a Fragments Project.

Warning

Don’t nest Fragments projects. Make sure to create new Fragments projects in their own location, outside of any existing Fragments projects.

If you’re in the liferay-x2y6 project folder, exit it (e.g., cd ..).

Here’s how to generate a Fragments Project:

Launch the project generator by executing the yo liferay-fragments command:
```
yo liferay-fragments
```
Name your project. For this example, accept the default project name by clicking enter.
```
? Project name (Sample Liferay Fragments)
```

Indicate whether to add sample content. For this example, enter Yes.

? Add sample content? Yes
Creating directory
   force .yo-rc.json
create src/.gitkeep
create .editorconfig
create .gitignore
create liferay-npm-bundler.config.js
create package.json
create README.md
Adding sample content...
Warning: some of these fragments are not compatible all
portal versions, please check the generator documentation before using them:
https://www.npmjs.com/package/generator-liferay-fragments#creating-new-fragments
Running yarn...
Done!
You're ready to create fragments.
create src/sample-collection/collection.json
create src/sample-collection/sample-fragment/index.html
create src/sample-collection/sample-fragment/main.js
create src/sample-collection/sample-fragment/styles.css
create src/sample-collection/sample-fragment/fragment.json
create src/sample-collection/sample-fragment/configuration.json
create src/sample-collection/sample-fragment-with-new-editables/index.html
create src/sample-collection/sample-fragment-with-new-editables/main.js
create src/sample-collection/sample-fragment-with-new-editables/styles.css
create src/sample-collection/sample-fragment-with-new-editables/fragment.json
create src/sample-collection/sample-fragment-with-new-editables/configuration.json
create src/sample-collection/sample-fragment-with-react/index.html
create src/sample-collection/sample-fragment-with-react/main.js
create src/sample-collection/sample-fragment-with-react/styles.css
create src/sample-collection/sample-fragment-with-react/fragment.json
create src/sample-collection/sample-fragment-with-react/configuration.json

Congratulations on generating your Fragments Project!

The generator creates each project in a folder derived from the project name. For example, since you named the project Sample Liferay Fragments, the generator created a project folder called sample-liferay-fragments.

Import the Sample Fragment Set

Start a new Liferay instance by running

docker run -it -m 8g -p 8080:8080 liferay/portal:7.4.3.120-ga120

Sign in to Liferay at http://localhost:8080. Use the email address test@liferay.com and the password test. When prompted, change the password to learn.

Then, follow these steps to import the sample Fragment Set to Liferay:

Import the Fragment Set to your Liferay instance by invoking the yarn run import command in the project’s root folder (e.g., sample-liferay-fragments). Alternatively, you can import the Fragment Set manually.
```
cd sample-liferay-fragments
```
```
yarn run import
```

Answer the prompts.

$ yo liferay-fragments:import
? Liferay host & port http://localhost:8080
? Username test@liferay.com
? Password [hidden]
Checking connection...
Connection successful

? Company ID liferay.com
? Group ID Liferay DXP
Building project...
Importing project...
Project imported
   force .yo-rc.json
   force ../../.yo-rc-global.json
Done in 21.43s.

Verify the Fragment Set is available. Open the Site Menu () and go to Design → Fragments. The Set should appear in the list.

Note

For Liferay DXP 7.1 and 7.2, instead navigate to Site → Site Builder → Page Fragments under the Product Menu to get to the Fragments page.

Great! You successfully deployed a Fragment Set.

Fragment Set Structure

Each Fragment Set uses this structure:

collection.json: a text file that describes the Fragment Set.

{
   "description": "Optional description",
   "name": "Fragment Set Name"
}

language.properties (optional): language keys defined for the Fragment Set.
[fragment-name]/: a folder containing all of the files for a Fragment.
- configuration.json(optional): a JSON file that defines the Fragment’s configuration. See Adding Configuration Options to Fragments for more information.
- fragment.json: a JSON file that describes the Fragment. See Modifying fragment.json for more information.
resources/ (optional): a folder containing any additional images or files the Fragments need. See Including Default Resources in Fragments for more information.

You can use the Fragments Toolkit to create projects quickly with this structure.

Modifying fragment.json

fragment.json contains fragment attributes that can be modified to enhance the functionality and usability of fragments.

Key	Description
`cssPath`	Specifies .css, .scss, or .sass files.
`configurationPath`	Specifies the configuration source for the fragment.
`htmlPath`	Specifies the HTML source for the fragment.
`jsPath`	Specifies the JavaScript source for the fragment.
`name`	The name of the fragment.
`type`	Specifies a component or React fragment.
`icon`	Adds a clay icon to imported fragments. See the Clay Icon List for available icons.
`sass {loadPaths:[]}}`	Specifies external dependencies.

{
   "cssPath": "styles.css",
   "configurationPath": "configuration.json",
   "htmlPath": "index.html",
   "jsPath": "main.js",
   "name": "Fragment name",
   "type": "[component|react]",
   "icon": "adjust"

   // This configuration is optional and can be removed
   "sass": {
         "loadPaths": [
            "../../../node_modules"
         ]
   }
}

Add a Fragment Set to the Project

Use the add-collection command to add a Fragment Set to your project.

Navigate to your project’s root folder and run this command.
```
yarn run add-collection
```

When prompted, enter a name and description for the Fragment Set.

> yo liferay-fragments:collection
? Collection name (required) My Set
? Collection description (optional) This is my new Fragment Set.
create src/my-set/collection.json

Verify your new Fragment Set was created successfully in the project’s src folder. It should only include a collection.json file:
```
{
   "description": "This is my new Fragment Set.",
   "name": "My Set"
}
```

Create a New Fragment

Use the add-fragment command to add a new Fragment to the Set.

Navigate to your project’s root folder and run this command.
```
yarn run add-fragment
```
The CLI starts the process:
```
> yo liferay-fragments:fragment
```

Name your Fragment.

? Fragment name (required) My Jumbotron

Choose whether to use React or another JavaScript framework. React requires Liferay 7.3+. For this tutorial, please decline using React.
```
? Use React (or other JS framework)? No
```
Use the new editable element syntax for Liferay 7.3+.
```
? Use new data-lfr editable syntax? Yes
```
Note

If you accepted using React in your fragment, the toolkit assumes you’re on Liferay 7.3+ and configures the new editable element syntax. See Fragment-Specific Tags for more information on Liferay’s editable data syntax.
Select the Fragment Set you just created (My Set).
```
? Choose a collection
   My Set
   Sample Set
   + New Collection
```
Note

The fragment.json defines the paths to the Fragment’s CSS, HTML, and JavaScript. If you change any of these file names, update their paths in the fragment.json.

Here is the Fragment’s index.html:

<div class="my-jumbotron">
    <h1 data-lfr-editable-id="title" data-lfr-editable-type="text">
        My Jumbotron
    </h1>
</div>

The Fragment HTML uses the new data-lfr editable syntax.

Edit Your Fragment

Modify any part of your Fragment.

HTML (index.html)
CSS (styles.css)
JavaScript (main.js)
Fragment Attributes (fragment.json)
Configuration options (configuration.json).

For example, you can build off of the above HTML and use Clay’s Bootstrap-based components to create Fragment with an attention-getting headline and description, as demonstrated in this index.html:

<div class="component-my-jumbotron">
    <div class="jumbotron">
        <h1
            class="display-4"
            data-lfr-editable-id="01-title"
            data-lfr-editable-type="rich-text"
        >
            Editable Jumbotron Headline
        </h1>

        <p
            class="lead"
            data-lfr-editable-id="02-lead"
            data-lfr-editable-type="rich-text"
        >
            Edit this text to call extra attention to featured content or information.
        </p>

        <hr />

        <p
            data-lfr-editable-id="03-text"
            data-lfr-editable-type="rich-text"
        >
            Edit this text to provide more information.
        </p>

        <a
            class="btn btn-primary btn-lg"
            data-lfr-editable-id="04-label"
            data-lfr-editable-type="link"
            href="#"
        >
            Editable Link
        </a>
    </div>
</div>

Note

If you are using Liferay 7.2 or below, remove the data-lfr-editable-[id|type] attributes and wrap the content elements in lfr-editable elements as described in Fragment-Specific Tags.

The first div element’s class="component-my-jumbotron" attribute attempts to uniquely identify this Fragment on a page.

Tip

In your Fragment’s HTML file, use the main wrapper element (the <div> in the example above) to uniquely identify the Fragment so it doesn’t conflict with other components on a page.

Next the <div class="jumbotron"/> element wraps the content, applying Bootstrap’s jumbotron component. This component makes the content stand out. Here are the content elements:

<h1 class="display-4" ...>Editable Jumbotron ... creates the Fragment’s heading. It uses Bootstrap’s display-4 size style. The data-lfr-editable- attributes make the heading text editable. The data-lfr-editable-id="03-text" attribute identifies the element and the data-lfr-editable-type="rich-text" attribute declares the content type.
<p class="lead" ...>Edit this text ... is the lead body text distinguished by Clay’s lead style component. The data-lfr-editable- attributes make the paragraph editable.
The <hr/> and next <p ... elements produce a horizontal rule and another editable paragraph, respectively.
<a class="btn btn-primary btn-lg" ... specifies a modifiable link. The btn-primary class styles it as a main button and btn-lg makes it large. The href="#" attribute takes the user to the top of the page when the link is clicked. The data-lfr-editable-type="link" attribute makes the link editable.

You can also include resources in your Fragments. See Including Default Resources in Fragments for more information.

Note

The Fragment and configuration object are passed in as arguments in JavaScript and are available as fragmentElement and configuration parameters, respectively.

Import Your New Fragment

You can import your new Fragment as you did the original example Fragment:

Run the import command and provide your credentials:
```
yarn run import
```
Verify the Fragment Set is available. Open the Site Menu () and go to Design → Fragments. The Set should appear in the list.

The Set is available.

Great! Now you know how to use the Fragments Toolkit to create and manage Fragments. See the Fragments Toolkit Command Reference for more toolkit command information.

Alternatives to the Fragments Toolkit

The Fragments Toolkit is deprecated as of Liferay 2024.Q1+/Portal 7.4 GA112+.

There are some alternatives you can use for developing fragments:

Export/Import: If you must export/import fragments, you can use the Export/Import fragment option in your Fragments app to Export/Import fragments in .zip format.
Create a Basic Custom Element: If you must develop and manage React components, you can create a custom element client extension. This way, you transform your React component into a widget and you can use it in your pages.

Available: Liferay DXP 2023.Q4+/Portal 7.4 GA102+ Create a React Fragment: Instantiate a React component in a fragment using static JS imports. See the example code below and its comments.

Instantiate a React component in a fragment using static JS imports.

// Import statements. Clay Components, React, and ReactDOM are already included in Liferay's importMap.
import React, { useState } from "react";
import ReactDOM from "react-dom";

// my-collection/my-fragment/Counter.jsx
// A simple Counter component to increase or decrease a given variable (count).
function Counter() {
const [count, setCount] = useState(0);
const increase = () => setCount((previousCount) => previousCount + 1);
const decrease = () => setCount((previousCount) => previousCount - 1);

// Rendering an output element that displays the current count, along with two buttons for increasing/decreasing the count.
return React.createElement(
   React.Fragment,
   null,
   React.createElement("output", null, count),
   React.createElement("button", { onClick: increase, type: "button" }, "+"),
   React.createElement("button", { onClick: decrease, type: "button" }, "-")
);
}

// my-collection/my-fragment/index.jsx
// Another functional React component. It renders an instance of the Counter component.
function MyFragment(props) {
console.log("MyFragment props", props);
return React.createElement(Counter, null);
}

// Cleanup process: Unmounts any existing React component associated with the specified DOM element (fragmentElement) before rendering a new component.
ReactDOM.unmountComponentAtNode(fragmentElement);
// Renders an instance of MyFragment with a configuration prop into the specified DOM element (fragmentElement) using ReactDOM.render.
ReactDOM.render(
React.createElement(MyFragment, { configuration }),
fragmentElement
);
// Cleanup process: Listens for the beforeNavigate event using Liferay.once and, when triggered, unmounts the React component associated with fragmentElement to clean up before navigating to another page.
// Liferay.once(event, callback); function is used to add an event listener that is executed only once when the specified event occurs.
Liferay.once("beforeNavigate", () =>
ReactDOM.unmountComponentAtNode(fragmentElement)
);

Note

If you want to import a React component that is not included in Liferay’s importMap, you can add it by creating an importMap ClientExtension.

While editing a page, fragments can be rendered multiple times when users interact with them (e.g. while changing the fragment configuration). To ensure the React component is remounted, add a condition to check the layout mode to the first cleanup process. See the example code below:

// my-collection/my-fragment/index.jsx
// Checking the layout mode
if (props.layoutMode === 'edit') {
   React.DOM.unmountComponentAtNode(fragmentElement);
}

ReactDOM.render(...)

Use a bundler to build your fragments: If you want to use JSX or multiple files, you must bundle the files before importing them.

Pay attention that the default behavior of bundlers (e.g. esbuild, webpack, and vite-plugin-externals) is to merge all content in a single JS file (including React, ReactDOM, and all dependencies). So, you must use methods to select which libraries are not included in the final bundle as the import relies on importMaps.
Use CSS when possible: Consider using standard CSS instead of SASS unless you need SASS-only features.

Nesting is now available in CSS.

Capability:

Development and Tooling

Resource Type:

Official Documentation

Feature:

Fragments

Deployment Approach:

Liferay PaaS

Liferay Self-Hosted