Skip to content

Commit bf9168c

Browse files
committed
fix(core): include custom data documentation references
Signed-off-by: John Yanarella <jyanarella@nvidia.com>
1 parent 3f2bd36 commit bf9168c

92 files changed

Lines changed: 103 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎projects/core/src/accordion/accordion.ts‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ import accordionGroupStyleSheet from './accordion-group.css?inline';
2727
/**
2828
* @element nve-accordion-header
2929
* @description Provides the clickable heading region of an accordion that toggles the visibility of associated content.
30+
* @documentation https://nvidia.github.io/elements/docs/elements/accordion/
3031
* @since 0.12.0
3132
* @entrypoint \@nvidia-elements/core/accordion
3233
* @slot - default content slot
@@ -69,6 +70,7 @@ export class AccordionHeader extends LitElement {
6970
/**
7071
* @element nve-accordion-content
7172
* @description Contains the collapsible body content that reveals or hides when the parent accordion expands or collapses.
73+
* @documentation https://nvidia.github.io/elements/docs/elements/accordion/
7274
* @since 0.12.0
7375
* @entrypoint \@nvidia-elements/core/accordion
7476
* @slot - This is a default/unnamed slot for accordion content
@@ -93,6 +95,7 @@ export class AccordionContent extends LitElement {
9395
/**
9496
* @element nve-accordion
9597
* @description An accordion is a vertical stack of interactive headings used to toggle the display of further information.
98+
* @documentation https://nvidia.github.io/elements/docs/elements/accordion/
9699
* @since 0.12.0
97100
* @entrypoint \@nvidia-elements/core/accordion
98101
* @command --open - use to open the accordion
@@ -219,6 +222,7 @@ export class Accordion extends LitElement implements ContainerElement {
219222
/**
220223
* @element nve-accordion-group
221224
* @description Organizes many accordions into a cohesive group, enabling coordinated expand/collapse behavior such as single-item expansion.
225+
* @documentation https://nvidia.github.io/elements/docs/elements/accordion/
222226
* @since 0.12.0
223227
* @entrypoint \@nvidia-elements/core/accordion
224228
* @cssprop --padding

‎projects/core/src/alert/alert-group.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ import styles from './alert-group.css?inline';
1919
/**
2020
* @element nve-alert-group
2121
* @description An alert group is an element that displays a group of related and important messages in a way that attracts the user's attention without interrupting the user's task.
22+
* @documentation https://nvidia.github.io/elements/docs/elements/alert/
2223
* @since 0.3.0
2324
* @entrypoint \@nvidia-elements/core/alert
2425
* @cssprop --gap

‎projects/core/src/alert/alert.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ import styles from './alert.css?inline';
2424
/**
2525
* @element nve-alert
2626
* @description Alert is an element that displays a brief, important message in a way that attracts the user's attention without interrupting the user's task.
27+
* @documentation https://nvidia.github.io/elements/docs/elements/alert/
2728
* @since 0.3.0
2829
* @entrypoint \@nvidia-elements/core/alert
2930
* @event close - Dispatched when the alert closes within an alert group.

‎projects/core/src/avatar/avatar.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import styles from './avatar.css?inline';
1111
/**
1212
* @element nve-avatar
1313
* @description Avatar represents a user/bot within a UI. Typically with text or image content.
14+
* @documentation https://nvidia.github.io/elements/docs/elements/avatar/
1415
* @since 1.20.0
1516
* @entrypoint \@nvidia-elements/core/avatar
1617
* @slot - default slot for content

‎projects/core/src/badge/badge.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ import styles from './badge.css?inline';
2222
/**
2323
* @element nve-badge
2424
* @description A visual indicator that communicates a status description of an associated component. Status badges use short text, color, built in icons for quick recognition and render near the relevant content.
25+
* @documentation https://nvidia.github.io/elements/docs/elements/badge/
2526
* @since 0.11.0
2627
* @entrypoint \@nvidia-elements/core/badge
2728
* @slot - default slot for content

‎projects/core/src/breadcrumb/breadcrumb.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ import type { Button } from '@nvidia-elements/core/button';
2020
/**
2121
* @element nve-breadcrumb
2222
* @description Breadcrumb is a component that can help users establish their location while navigating a website with complex URLs and navigation paths.
23+
* @documentation https://nvidia.github.io/elements/docs/elements/breadcrumb/
2324
* @since 0.11.0
2425
* @entrypoint \@nvidia-elements/core/breadcrumb
2526
* @cssprop --gap

‎projects/core/src/button-group/button-group.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ import globalStyles from './button-group.global.css?inline';
2222
/**
2323
* @element nve-button-group
2424
* @description A button group organizes related buttons and can support either mutually exclusive single or multi selection. Prefer usage within toolbars.
25+
* @documentation https://nvidia.github.io/elements/docs/elements/button-group/
2526
* @since 0.16.0
2627
* @entrypoint \@nvidia-elements/core/button-group
2728
* @slot - default slot for `nve-button` or `nve-icon-button`

‎projects/core/src/button/button.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import styles from './button.css?inline';
1111
/**
1212
* @element nve-button
1313
* @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.
14+
* @documentation https://nvidia.github.io/elements/docs/elements/button/
1415
* @since 0.1.3
1516
* @entrypoint \@nvidia-elements/core/button
1617
* @slot - slot for button text content or icon, icon placement depends on whether `icon` appears before or after text content.

‎projects/core/src/card/card.ts‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ import cardFooterStyleSheet from './card-footer.css?inline';
1313
/**
1414
* @element nve-card
1515
* @description A container for content representing a single entity.
16+
* @documentation https://nvidia.github.io/elements/docs/elements/card/
1617
* @since 0.1.3
1718
* @entrypoint \@nvidia-elements/core/card
1819
* @slot - use `<nve-card-header>`,`<nve-card-content>`,`<nve-card-footer>` for card content layout
@@ -51,6 +52,7 @@ export class Card extends LitElement implements ContainerElement {
5152
/**
5253
* @element nve-card-header
5354
* @description Displays the title and optional actions at the top of a card, establishing the card's identity and purpose.
55+
* @documentation https://nvidia.github.io/elements/docs/elements/card/
5456
* @since 0.1.3
5557
* @entrypoint \@nvidia-elements/core/card
5658
* @slot - default slot
@@ -86,6 +88,7 @@ export class CardHeader extends LitElement {
8688
/**
8789
* @element nve-card-content
8890
* @description Contains the primary body content of a card, providing a structured region for the main information or media.
91+
* @documentation https://nvidia.github.io/elements/docs/elements/card/
8992
* @since 0.1.3
9093
* @entrypoint \@nvidia-elements/core/card
9194
* @slot - This is a default/unnamed slot for card content
@@ -112,6 +115,7 @@ export class CardContent extends LitElement {
112115
/**
113116
* @element nve-card-footer
114117
* @description Provides a designated area at the bottom of a card for actions, metadata, or supplementary information.
118+
* @documentation https://nvidia.github.io/elements/docs/elements/card/
115119
* @since 0.1.3
116120
* @entrypoint \@nvidia-elements/core/card
117121
* @slot - This is a default/unnamed slot for card footer content

‎projects/core/src/chat-message/chat-message.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ import globalStyles from './chat-message.global.css?inline';
1212
/**
1313
* @element nve-chat-message
1414
* @description A chat message component displays a text message within a conversation, sent between users or bots
15+
* @documentation https://nvidia.github.io/elements/docs/elements/chat-message/
1516
* @since 1.25.0
1617
* @entrypoint \@nvidia-elements/core/chat-message
1718
* @slot - default slot for content

0 commit comments

Comments
 (0)