api-design

Guide component API design for NVIDIA Elements properties, attributes, slots, and events.

33|9|Updated Mar 2, 2026
One-click install
npx skills add https://github.com/NVIDIA/elements --skill api-design-nvidia
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/NVIDIA/elements/tree/main/.agents/skills/api-design
Command: npx skills add https://github.com/NVIDIA/elements --skill api-design-nvidia

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill helps solve the challenge of designing component APIs that follow NVIDIA Elements conventions, ensuring consistency and usability across your applications.

Core Features & Use Cases

  • API Design Patterns: Offers patterns for properties, attributes, CSS custom properties, slots, and events.
  • Guidelines Review: Provides guidelines for designing properties, attributes, styles, composition, slots, custom events, component registration, and packaging.
  • Use Case: When designing a new component, use this Skill to ensure best practices are followed and to make informed design decisions.

Quick Start

Run the 'api-design' skill to review the API design guidelines for your component.

Frequently Asked Questions about api-design

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
What are component API design guidelines for frontend development?

Component API design guidelines define patterns for properties, attributes, slots, events, and CSS custom properties. They ensure consistency and usability across applications by providing structured conventions for frontend developers and designers.

How do I design properties and slots for a new UI component?

To design properties and slots for a UI component, follow established API design patterns that structure component composition and registration. Use these guidelines to make informed design decisions and ensure best practices are followed.

Does the NVIDIA Elements framework support custom events and CSS custom properties?

Yes, the NVIDIA Elements framework supports custom events and CSS custom properties. The Skill provides specific guidelines for designing these features alongside component registration and packaging to maintain framework conventions.

What is the best way to structure component composition in UI development?

The best way to structure component composition is to apply targeted design patterns for slots and attributes. This approach ensures your components integrate seamlessly and maintain usability across the application architecture.

When do I need specific guidelines for component registration and packaging?

You need specific guidelines for component registration and packaging when finalizing a new component for production. Following these conventions ensures your component API integrates properly and maintains consistency across the framework.