NV NVIDIA Elements Catalog Starters Repo System Themes Getting Started Getting Started Installation CLI MCP Skills Lint Integrations Getting Started Angular Bundles CDN Custom Elements Eleventy Golang HTMX + Go Hugo Import Maps Lit Lit Library MCP Apps NextJS Nuxt Preact React SolidJS Svelte TypeScript Vue About What’s New Changelog Metrics Support Accessibility Contributions Requests Migration Foundations Overview Typography Iconography Themes Design Tokens Size & Space Objects Interactions Support Status Color Animation Fonts Layers Custom Layout Horizontal Vertical Grid Popovers i18n Visualization View Transitions DESIGN.md Elements Accordion Alert Avatar Badge Breadcrumb Button Button Group Card Chat Message Checkbox Codeblock Color Combobox Copy Button Datagrid Getting Started Integrations Column Action Column Alignment Column Fixed Column width Container Card Display Settings Footer Heatmap Keynav Multi Select Pagination Panel Detail Panel Grid Performance Placeholder Row Action Row Groups Row Sort Scroll Height Single Select Stripe Date Datetime Dialog Divider Dot Drawer Dropdown Dropdown Group Dropzone File Format Bytes Format Datetime Format Number Format Relative Time Forms Getting Started Validation Actions Control Gauge Icon Icon Button Input Input Group Logo Markdown Markdown CSS Media Controller Pause Button Playback Rate Select Mute Button Seek Button Time Range Volume Range Full-screen Button Menu Month Monaco Input Diff Input Monaco Editor Diff Editor Problems Notification Page Page Header Page Loader Pagination Progressive Filter Chip Progress Bar Progress Ring Password Preferences Input Pulse Radio Range Resize Handle Search Select Skeleton Sort Button Sparkline Star Rating Steps Switch Tabs Tag Textarea Time Toast Toggletip Toolbar Tooltip Tree Week Patterns Authentication Browse Chat Dashboard Editor Empty States Heatmap Keyboard Shortcut Logging Media Navigation Onboarding Panel Responsive Search Subheader Trend Labs Responsive Layout Viewport Container Patterns Forms API Design Properties & Attributes Slots Registration CustomEvents Stateless Composition Styles Packaging Glossary Logs Internal Guidelines Agent Harness Agent Tooling Agent Ownership Documentation Examples TypeScript Testing Unit Testing Accessibility Testing Lighthouse Testing SSR Testing Visual Testing Troubleshooting Component Creation Internal Examples All Examples

Documentation Guidelines

API Guidelines for the Eleventy based documentation site for Elements. Eleventy Shortcodes provide a way to create reusable templates in markdown content.


Install Shortcode

Renders the install entrypoint of a given element API.

Parameter Description Type
Name Tag name of element API string
CLI / MCP / CDN

Example Shortcode

Renders an example template and its corresponding metadata.

Parameter Description Type
Path Fully qualified path to the examples file string
Name Case sensitive name of the example to render from file string
Options Optional settings { "height": "150px", "align": "center", "summary": false, "layer": "highlight" }

Example Default

Basic button component with standard appearance and behavior for primary user actions.

standard

Example Options

standard

Example Tags Shortcode

Render the metadata tags of a given Example template.

Parameter Description Type
Path Fully qualified path to the examples file string
Name Case sensitive name of the example to render from file string
test-caseperformance

Example Group Shortcode

The example-group shortcode visualizes many related examples in a single layout. Each example renders its summary/description alongside its example.

Parameter Description Type
Paths Fully qualified paths to the examples file and its example name string
Content Slot Extra context about related examples in example group string

Single or Group

Appearance

 Adjust workspace preferences and project configurations to customize your experience.

Account Settings

 Adjust workspace preferences and project configurations to customize your experience.

Privacy

 Adjust workspace preferences and project configurations to customize your experience.

Leverage accordions alone or in conjunction with others to create progressive disclosure patterns.

Example Usage Single Basic accordion component for collapsible content sections with expand/collapse functionality. Multiple Brings together many accordion components for embedded multi-section content organization.

API Shortcode

Renders the description metadata of a given API. The identifier of the referenced API is optional. If you omit the identifier, the shortcode displays all API references of the provided type.

Parameter Description Type
Tag Name Tag name of element API string
API API metadata to render description | event | property | slot | css-property | css-part
Identifier Optional public API name string

API Description

A button is a widget that enables users to trigger an action or event, such as submitting a form, opening a dialog, canceling an action, or performing a delete operation.

API Event

Dispatched when the alert closes within an alert group.

API Slot

The topmost section of the page, typically containing navigation, branding, or other global elements.

API CSS Part

The inner template reference for the close button of the dialog.

API CSS Property

MDN

API Property / Attribute

The Interaction type provides a way to show the intent of an interactive element. This can help users quickly understand what each interaction does and reduce the potential for confusion or errors.

Interaction Description emphasis Shows the interaction targets emphasis or highlighting primary actions. destructive Shows the interaction targets destructive actions such as deleting or removing.

API Value

Shows the interaction targets destructive actions such as deleting or removing.

API Type

If you omit the identifier, the shortcode displays all API references of the provided type.

Property Attribute Description Values color color

Defines a base color from the theme color palette
red-cardinal
gray-slate
gray-denim
blue-indigo
blue-cobalt
blue-sky
teal-cyan
green-mint
teal-seafoam
green-grass
yellow-amber
orange-pumpkin
red-tomato
pink-magenta
purple-plum
purple-violet
purple-lavender
pink-rose
green-jade
lime-pear
yellow-nova
brand-green
size size

Sets size of the avatar component. Update size through the width + height css props as an alternative.
sm Compact size for dense layouts or secondary elements with less visual prominence.
md Standard size that works well in most contexts and provides balanced visibility.
lg Larger size for emphasizing important elements or improving touch targets in spacious layouts.
xs

Design Token Shortcode

Renders a given subset of matching design tokens.

Parameter Description Type
Name Tag name of token subset string
Token Value Description Demo
--nve-ref-border-color --nve-ref-color-neutral-800 Use for default borders that match the standard color scheme
--nve-ref-border-color-emphasis --nve-ref-color-neutral-1000 Use for borders that need high contrast and emphasis
--nve-ref-border-color-muted --nve-ref-color-neutral-700 Use for subtle borders that blend with backgrounds
--nve-ref-border-color-inverse --nve-ref-color-scheme-inverse Use for borders on inverse color scheme backgrounds

Do/Don't Shortcode

Renders the "Do/Don't" shortcode layout for guidance on potential anti-patterns.

Parameter Description Type
Slot Slot for two example shortcodes string
Do Don't
column 0column 1column 2column 3 cell 0-0cell 0-1cell 0-2cell 0-3 cell 1-0cell 1-1cell 1-2cell 1-3 cell 2-0cell 2-1cell 2-2cell 2-3 cell 3-0cell 3-1cell 3-2cell 3-3
column 0column 1column 2column 3
cell 0-0cell 0-1cell 0-2
cell 1-0cell 1-1cell 1-2
cell 2-0cell 2-1cell 2-2
cell 3-0cell 3-1cell 3-2

Split Layout Shortcode

Pressed state for toggle buttons marking active/selected state with clear visual feedback.

pressed inline pressed flat pressed

Indicates the current state of a toggle button that switches on or off. MDN

Pressed Description true The button is in the pressed (on) state and the associated action or setting is active. false The button is in the unpressed (off) state and the associated action or setting is inactive.

Interaction states that communicate button hierarchy, importance, and availability to users.

standard emphasis destructive

The Interaction type provides a way to show the intent of an interactive element. This can help users quickly understand what each interaction does and reduce the potential for confusion or errors.

Interaction Description emphasis Shows the interaction targets emphasis or highlighting primary actions. destructive Shows the interaction targets destructive actions such as deleting or removing.

Grouping Disjointed APIs

When comparing disjointed or non-enum based properties use the api value shortcode to explicitly render the api description for the given value.

States

Button interaction states including hover, focus, pressed, selected, and disabled.

standard selected pressed disabled
State Usage
selected
The element holds selection and represents the user's current choice within the group.
pressed
The button is in the pressed (on) state and the associated action or setting is active.
disabled
The element has a disabled state and does not accept interaction.