Package Exports

@softgenai/element-tagger
@softgenai/element-tagger/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@softgenai/element-tagger) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@softgenai/element-tagger

A lightweight loader that injects tracking attributes into React/JSX elements for visual editing capabilities.

Installation

npm install --save-dev @softgenai/element-tagger

Usage

Next.js (Turbopack & Webpack)

Add to next.config.js or next.config.mjs:

Safe Configuration (Recommended)

Gracefully handles when package isn't installed:

/** @type {import('next').NextConfig} */
import { createRequire } from "module";

// Check if element-tagger is available
function isElementTaggerAvailable() {
  try {
    const require = createRequire(import.meta.url);
    require.resolve("@softgenai/element-tagger");
    return true;
  } catch {
    return false;
  }
}

// Build turbo rules only if tagger is available
function getTurboRules() {
  if (!isElementTaggerAvailable()) {
    return {};
  }
  return {
    "*.tsx": {
      loaders: ["@softgenai/element-tagger"],
      as: "*.tsx",
    },
    "*.jsx": {
      loaders: ["@softgenai/element-tagger"],
      as: "*.jsx",
    },
  };
}

const nextConfig = {
  experimental: {
    turbo: {
      rules: getTurboRules(),
    },
  },
  // For webpack mode (fallback when not using --turbopack)
  webpack: (config, { dev }) => {
    if (dev && isElementTaggerAvailable()) {
      config.module.rules.push({
        test: /\.(jsx?|tsx?)$/,
        exclude: /node_modules/,
        use: ["@softgenai/element-tagger"],
      });
    }
    return config;
  },
};

export default nextConfig;

Simple Configuration

If you know the package is always installed:

/** @type {import('next').NextConfig} */
const nextConfig = {
  experimental: {
    turbo: {
      rules: {
        "*.tsx": {
          loaders: ["@softgenai/element-tagger"],
          as: "*.tsx",
        },
        "*.jsx": {
          loaders: ["@softgenai/element-tagger"],
          as: "*.jsx",
        },
      },
    },
  },
};

export default nextConfig;

How It Works

The loader injects two data attributes into JSX elements at build time:

data-sg-el - File path and element position (filepath:line:column)
data-sg-name - Element/component name

License

MIT