agentleFS
Sign inStart free
NVIDIAKnown publisherNVIDIA/elements/projects/starters/react/AGENTS.md

elements / react

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

This file only covers how this starter wires Elements into React. 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

8 rules. About 0 are common, 0 are distinctive, and 8 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.

  • 8

    Very specific

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

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

    Keep global theme CSS in src/index.css.

    line 8
  2. Very specific:

    Keep nve-theme and nve-transition on src/index.html.

    line 9
  3. Very specific:

    Keep JSX custom element type augmentation in src/global.d.ts.

    line 10
  4. Very specific:

    Use direct custom elements for React 19.

    line 14
  5. Very specific:

    Use lowercase custom event props such as onclose for an Elements close event.

    line 15
  6. Very specific:

    Use string attributes when the Elements API is attribute-driven.

    line 17
  7. Very specific:

    Run pnpm run build in projects/starters/react after TSX, type, or import changes.

    line 21
  8. Very specific:

    Run pnpm run lint after React source edits.

    line 22

≈ “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 React Starter

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

Integration Points

  • Register Elements in the React module that renders the corresponding nve-* tags, as in src/App.tsx.
  • Keep global theme CSS in src/index.css.
  • Keep nve-theme and nve-transition on src/index.html.
  • Keep JSX custom element type augmentation in src/global.d.ts.

JSX Syntax

  • Use direct custom elements for React 19.
  • Use lowercase custom event props such as onclose for an Elements close event.
  • Pass primitive values as JSX props when setting JavaScript properties.
  • Use string attributes when the Elements API is attribute-driven.

Verification

  • Run pnpm run build in projects/starters/react after TSX, type, or import changes.
  • Run pnpm run lint after React source 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.

Check your setup, free