Liferay Fragments Library

A professional-grade collection of robust, accessible, and responsive Liferay fragments designed for Liferay DXP. This repository provides ready-to-use, low-code UI components that leverage the latest Liferay features like Objects, Headless APIs, and the Meridian theme.

🚀 Why Use This Library?

If you are building modern portals with Liferay DXP, this library solves common development challenges out-of-the-box:

• Object-Driven UI: Visualize and manage Liferay Object data without writing custom portlets.
• Headless Integration: Advanced components using Headless APIs for faster data delivery.
• Auto-Deployable Localization: Every collection includes Batch Language Client Extensions for automatic deployment of localized strings.
• Theme Consistency: Meridian-ready, utilizing standard CSS tokens for colors, spacing, and typography.
• Accessibility & Responsiveness: Mobile-first design principles.

---

🛠️ Developer Experience (DX)

This repository includes a suite of tools to ensure high-quality, consistent development.

1. The Fragment Scaffolder

Create a new fragment with all project standards (Rule #4, Rule #9) in seconds:

npm run create-fragment "[Collection Name]" "[Fragment Name]"
# Example: npm run create-fragment finance "Tax Estimator"

2. Quality Gate (Linter)

Validate your changes against JSON schemas, localization rules, and theme fidelity before committing:

npm run lint

Note: This check is enforced via GitHub Actions on every push.

3. Commons Library

Leverage shared logic for Object discovery and identifier validation by linking to the shared resource: misc/resources/commons.js

---

📖 Documentation & Resources

Explore our comprehensive documentation to get started:

• 🖼️ Visual Gallery: Browse screenshots of every fragment in action.
• 🚀 Deployment Guide: Detailed deployment instructions for fragments and language assets.
• 📖 Common Recipes: Step-by-step workflows for combining fragments.
• 🎨 Theme Standards: Reference for cross-theme safe CSS tokens.
• ⚙️ Setup & Prerequisites: Mandatory Liferay configurations.
• ❓ Troubleshooting & FAQ: Solutions to common configuration issues.

---

📦 Quick Start Workflow

1. Build

Generate standard fragment ZIPs and Batch Language Client Extensions:

./create-fragment-zips.sh

2. Deploy

Use the automated deployment script to push assets to your Liferay instance:

# Deploy everything to a Liferay bundle
./deploy-fragment-zips.sh /path/to/liferay/root --all

# Deploy specific fragments/collections
./deploy-fragment-zips.sh /path/to/liferay/root gemini-generated loan-calculator

For more details, see the Full Documentation.