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.
Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 31,774 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository46 other files it gives its agents.
- AGENTS.mdAGENTS.md
- projects/starters/angular/AGENTS.mdAGENTS.md
- projects/starters/bundles/AGENTS.mdAGENTS.md
- projects/starters/eleventy/AGENTS.mdAGENTS.md
- projects/starters/eleventy-ssr/AGENTS.mdAGENTS.md
- projects/starters/go/AGENTS.mdAGENTS.md
- projects/starters/go-htmx/AGENTS.mdAGENTS.md
- projects/starters/hugo/AGENTS.mdAGENTS.md
- projects/starters/importmaps/AGENTS.mdAGENTS.md
- projects/starters/lit-library/AGENTS.mdAGENTS.md
- projects/starters/mcp-app/AGENTS.mdAGENTS.md
- projects/starters/mpa/AGENTS.mdAGENTS.md
- projects/starters/nuxt/AGENTS.mdAGENTS.md
- projects/starters/react/AGENTS.mdAGENTS.md
- projects/starters/solidjs/AGENTS.mdAGENTS.md
- projects/starters/sphinx/AGENTS.mdAGENTS.md
- projects/starters/svelte/AGENTS.mdAGENTS.md
- projects/starters/typescript/AGENTS.mdAGENTS.md
- projects/starters/vue/AGENTS.mdAGENTS.md
- agent-availability-reportSkill
- agent-debug-ciSkill
- agent-dependenciesSkill
- agent-startersSkill
- agent-upkeepSkill
- agent-web-modernizationSkill
- audit-accessibilitySkill
- audit-ciSkill
- audit-codeSkill
- audit-consolidationSkill
- audit-simplificationSkill
- authoring-benchmarksSkill
- authoring-componentsSkill
- authoring-documentationSkill
- authoring-examplesSkill
- authoring-patternsSkill
- authoring-projectsSkill
- authoring-testsSkill
- authoring-typescriptSkill
- elementsSkill
- github-dependabotSkill
- guidance-api-designSkill
- guidance-buildSkill
- guidance-webgpu-performanceSkill
- summarize-releasesSkill
- summarize-video-releasesSkill
- troubleshootingSkill
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
- Very specific: line 7
Use the React custom elements type augmentation in src/global.d.ts.
- Very specific: line 8
Keep global theme attributes on src/pages/_document.tsx.
- Very specific: line 9
Keep global CSS imports in src/styles/globals.css.
- Very specific: line 15
Keep basePath, output, and distDir aligned in next.config.ts for static starter output.
- Very specific: line 16
Import server-specific modules, such as @nvidia-elements/core/icon/server.js, only when a component needs server render support.
- Very specific: line 20
Treat @lit-labs/nextjs integration as experimental in this starter.
- Very specific: line 21
If enabling Lit SSR, import or configure it before any Elements registration imports and run a full build.
- Very specific: line 25
Use React custom element event naming such as onclose for a close event.
- Very specific: line 26
Use primitive JSX props for custom element properties and strings for attributes when the Elements API expects attributes.
- Very specific: line 30
Run pnpm run build in projects/starters/nextjs after React, config, SSR, or type changes.
- Very specific: line 31
Run pnpm run lint after TSX or config edits.
≈ “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.
Files
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, anddistDiraligned innext.config.tsfor 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/nextjsintegration 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
onclosefor acloseevent. - Use primitive JSX props for custom element properties and strings for attributes when the Elements API expects attributes.
Verification
- Run
pnpm run buildinprojects/starters/nextjsafter React, config, SSR, or type changes. - Run
pnpm run lintafter TSX or config edits.
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
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.

