agentleFS
NVIDIAKnown publisherNVIDIA/elements/.agents/skills/guidance-api-design/SKILL.md

guidance-api-design

Skill115 starsChanged 55 days agoApache-2.0View on GitHub

Component API design patterns following Elements conventions for properties, attributes, CSS custom properties, slots, and events. Use this skill whenever the user is designing or deciding on a component API, choosing between properties vs attributes vs slots, naming CSS custom properties, designing events, avoiding impossible states, deciding whether to reflect to an attribute, using CSS Parts, implementing the DataElement interface, or applying the internal-host pattern. Also trigger when the user asks about shorthand vs granular CSS properties or event naming conventions.

The file

We split this skill into the rules it gives an agent

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈8

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    When creating new components or features that may contain user state review the Stateless Components Guidelines.

    line 22
  2. Distinctive:

    When working with JavaScript properties and HTML attributes review the Properties & Attributes Guidelines.

    line 26
  3. Distinctive:

    When working with CSS, CSS Custom Properties or Design Tokens review the Styles & CSS Custom Properties Guidelines.

    line 30
  4. Distinctive:

    When creating a new API or determining API design of parent child relationships between components review the Component Composition …

    line 34
  5. Distinctive:

    When working with user provided content or container-like components review the Slots Guidelines.

    line 38
  6. Distinctive:

    When creating new events or listening to existing event review the Custom Events Guidelines.

    line 42
  7. Distinctive:

    When creating new components or using components as dependencies review the Component Registration Guidelines.

    line 46
  8. Distinctive:

    When creating a new component or package review the Packaging & Exports Guidelines.

    line 50

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill 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
SKILL.md

Guidance API Design

You MUST review the relevant API design guidelines before designing or modifying component APIs.

When to Use This Skill

  • Designing properties and attributes for new components
  • Creating CSS custom properties for theming
  • Avoiding impossible states in component APIs
  • Choosing between properties, attributes, and slots
  • Designing custom events
  • Planning component composition patterns
  • Setting up package exports and dependencies

Stateless Components

When creating new components or features that may contain user state review the Stateless Components Guidelines.

Properties vs Attributes

When working with JavaScript properties and HTML attributes review the Properties & Attributes Guidelines.

Styles & CSS Custom Properties

When working with CSS, CSS Custom Properties or Design Tokens review the Styles & CSS Custom Properties Guidelines.

Component Composition

When creating a new API or determining API design of parent child relationships between components review the Component Composition Guidelines.

Slots

When working with user provided content or container-like components review the Slots Guidelines.

Custom Events

When creating new events or listening to existing event review the Custom Events Guidelines.

Component Registration

When creating new components or using components as dependencies review the Component Registration Guidelines.

Packaging & Exports

When creating a new component or package review the Packaging & Exports Guidelines.

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.