Skip to content

liferay/liferay-portal / workspaces/clarity-solution-workspace/.agents/skills/react-custom-elements

react-custom-elements

Verified

Standards for building and deploying React based Custom Element Client Extensions. Use when the user wants to build a React powered widget, scaffold a React Custom Element CET, debug 404s on built assets, or troubleshoot an OSGi `Configuration deleted` loop. For nonReact Custom Element scaffolding or other CET types, use `scaffold-client-extension`.

React Custom Elements

Standards for building and deploying React based Custom Element Client Extensions.

When to Invoke

  • "Build a React widget", "scaffold a React Custom Element CET"
  • "Debug 404s on built assets"
  • "Troubleshoot an OSGi Configuration deleted loop"
  • For nonReact Custom Elements or other CET types, use scaffold-client-extension.

Project Scaffold

Before generating any scaffold code, ask the user which build tool they are using (e.g., Vite, webpack, Create React App). Do not assume a build tool — the project structure, output paths, and assemble block configuration differ between bundlers.

For a reference starting point, consult the official Liferay client-extension-samples which reflect the current recommended structure.

client-extension.yaml — Assemble Block

The assemble block is mandatory. Without it, Liferay Workspace will not package the extension's assets, causing 404 errors on all static resources.

The assemble block must copy your build output directory into a target directory in the extension. The urls pattern must match your bundler's output filename format, including any content hashes:

assemble:
    - from: <build-output-dir>
      into: static

my-react-app:
    name: My React App
    type: customElement
    friendlyURLMapping: my-react-app
    htmlElementName: my-react-app
    instanceable: true
    portletCategoryName: category.client-extensions
    urls:
        - <bundler-output-pattern>   # e.g. js/main.*.js for CRA, assets/index-*.js for Vite
    cssURLs:
        - <bundler-css-pattern>
    useESM: true

Vite library mode does not replace process.env.NODE_ENV. With build.lib and formats: ['es'] and no define, the literal expression survives into the bundle, and React, ReactDOM, and Clay ship their development builds. The symptom is console warnings that appear only in development builds, with no functional breakage, such as ClayIcon requires a spritemap. Add define: {'process.env.NODE_ENV': JSON.stringify('production')} to the Vite config. One jsImportMapsEntry bundle dropped from 1,177 KB to 632 KB. To check a build, grep --count "process\.env\.NODE_ENV" on the output should return 0. A Vite build in app mode (not library mode) is not affected.

Home Page URL: for associated OAuth2 applications, homePageURL must include the full protocol (e.g., http://localhost:${PORT}) to prevent interpolation errors.

Implementation Patterns

Wrap the React application in a standard Web Components Custom Element class. This pattern is build tool agnostic — it works regardless of bundler.

  • Web Component wrapper: wrap the React application in a standard Custom Element class.
  • Lifecycle management: use connectedCallback to initialize the React root and disconnectedCallback to properly unmount it, preventing memory leaks in single page navigation.
  • Global variables: use /* global Liferay */ to prevent ESLint errors when accessing platform utilities.
/* global Liferay */
import React from 'react';
import { createRoot } from 'react-dom/client';
import App from './App';

class MyReactElement extends HTMLElement {
    connectedCallback() {
        if (!this.root) {
            this.root = createRoot(this);
        }
        this.root.render(<App />);
    }
    disconnectedCallback() {
        if (this.root) {
            this.root.unmount();
            this.root = null;
        }
    }
}

const ELEMENT_ID = 'my-react-app';
if (!customElements.get(ELEMENT_ID)) {
    customElements.define(ELEMENT_ID, MyReactElement);
}

Patterns and Gotchas

  • 404 on assets: usually a mismatch between the assemble block from path and the actual build output directory. Verify the path matches your bundler's output location.
  • Multiple apps: if deploying multiple React apps, ensure each has a unique htmlElementName and friendlyURLMapping.
  • OSGi "deleted" loop: if deployment logs show a repeating IllegalStateException: Configuration [id] deleted, the OSGi registry is stuck on a corrupted previous registration. Do not rename the extension ID as the first move. The yaml key is the CET's identity: LXC:<key> bindings in master pages, function#<key> object action executors, oAuth2ApplicationExternalReferenceCode references, and pages that placed the widget all point at it, and a rename orphans every one of them silently. Start with the least destructive step, deleting the stale deployed zip from bundles/osgi/client-extensions and redeploying clean; that is a first attempt, not a verified fix. Rename only after listing and updating every reference.

Success Signal

TODO / inferred — verify against a running bundle. After deploy-and-verify, confirm the built React widget's assets return HTTP 200 OK and the custom element renders on a page hosting it.

finishing-a-development-branchobra/superpowersUse when implementation is complete, all tests pass, and you need to decide how to integrate the workStars: 319kUpdated Claude CodeCodexVerifiedInstall
systematic-debuggingobra/superpowersUse when encountering any bug, test failure, or unexpected behavior, before proposing fixesStars: 319kUpdated Claude CodeCodexVerifiedInstall
test-driven-developmentobra/superpowersUse when implementing any feature or bugfix, before writing implementation codeStars: 319kUpdated Claude CodeCodexVerifiedInstall
skill-creatoranthropics/skillsCreate new skills, modify and improve existing skills, and measure skill performance. Use when users want to create a skill from scratch, edit, or optimize an existing skill, run evals to test a skill, benchmark skill performance with variance analysis, or optimize a skill's description for better triggering accuracy.Stars: 196kUpdated Claude CodeCodexVerifiedInstall