agentleFS
NVIDIAKnown publisherNVIDIA/elements/projects/starters/nextjs/AGENTS.md

elements / nextjs

AGENTS.md115 starsChanged 54 days agoApache-2.0View on GitHub

This file only covers how this starter wires Elements into Next.js. For component APIs, template validation, and project setup commands, use the Elements CLI/MCP documentation instead.

The file

We split this AGENTS.md into the rules it gives an agent

11 rules. About 0 are common, 0 are distinctive, and 11 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 11

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Use the React custom elements type augmentation in src/global.d.ts.

    line 7
  2. Very specific:

    Keep global theme attributes on src/pages/_document.tsx.

    line 8
  3. Very specific:

    Keep global CSS imports in src/styles/globals.css.

    line 9
  4. Very specific:

    Keep basePath, output, and distDir aligned in next.config.ts for static starter output.

    line 15
  5. Very specific:

    Import server-specific modules, such as @nvidia-elements/core/icon/server.js, only when a component needs server render support.

    line 16
  6. Very specific:

    Treat @lit-labs/nextjs integration as experimental in this starter.

    line 20
  7. Very specific:

    If enabling Lit SSR, import or configure it before any Elements registration imports and run a full build.

    line 21
  8. Very specific:

    Use React custom element event naming such as onclose for a close event.

    line 25
  9. Very specific:

    Use primitive JSX props for custom element properties and strings for attributes when the Elements API expects attributes.

    line 26
  10. Very specific:

    Run pnpm run build in projects/starters/nextjs after React, config, SSR, or type changes.

    line 30
  11. Very specific:

    Run pnpm run lint after TSX or config edits.

    line 31

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

Elements NextJS Starter

This file only covers how this starter wires Elements into Next.js. For component APIs, template validation, and project setup commands, use the Elements CLI/MCP documentation instead.

Integration Points

  • Use the React custom elements type augmentation in src/global.d.ts.
  • Keep global theme attributes on src/pages/_document.tsx.
  • Keep global CSS imports in src/styles/globals.css.
  • Register Elements in the page or component module that renders them.

Next.js Runtime

  • This starter uses the pages router and output: 'export'.
  • Keep basePath, output, and distDir aligned in next.config.ts for static starter output.
  • Import server-specific modules, such as @nvidia-elements/core/icon/server.js, only when a component needs server render support.

SSR Status

  • Treat @lit-labs/nextjs integration as experimental in this starter. Do not enable it casually; the current config leaves it commented with the upstream issue.
  • If enabling Lit SSR, import or configure it before any Elements registration imports and run a full build.

JSX Syntax

  • Use React custom element event naming such as onclose for a close event.
  • Use primitive JSX props for custom element properties and strings for attributes when the Elements API expects attributes.

Verification

  • Run pnpm run build in projects/starters/nextjs after React, config, SSR, or type changes.
  • Run pnpm run lint after TSX or config edits.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.