Skip to content

Commit c7e16a5

Browse files
committed
chore(docs): add component preview to card list
- add small inline preview of the component to the card - large components like monaco have small mock html/css inlined visuals Signed-off-by: Cory Rylan <crylan@nvidia.com>
1 parent 0b24dcc commit c7e16a5

14 files changed

Lines changed: 615 additions & 91 deletions

File tree

‎projects/core/src/dialog/dialog.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import styles from './dialog.css?inline';
2121

2222
/**
2323
* @element nve-dialog
24-
* @description Dialog is a component that appears above main content. A modal dialog displays critical information that requires user attention and interrupts user flow. [MDN Popover API](https://developer.mozilla.org/en-US/docs/Web/API/Popover_API)
24+
* @description Dialog is a component that appears above main content. A modal dialog displays critical information that requires user attention and interrupts user flow.
2525
* @documentation https://nvidia.github.io/elements/docs/elements/dialog/
2626
* @since 0.6.0
2727
* @entrypoint \@nvidia-elements/core/dialog

‎projects/core/src/drawer/drawer.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import styles from './drawer.css?inline';
1818

1919
/**
2020
* @element nve-drawer
21-
* @descriptionDrawer are to display content that is out of context of the rest of the page (notifications, navigation, settings). Or use [Panel](./docs/elements/panel/) inline as its content couples with or closely relates to the content on the page (details, extra actions/options). [MDN Popover API](https://developer.mozilla.org/en-US/docs/Web/API/Popover_API)
21+
* @descriptionA drawer displays content separate from the rest of the page, such as notifications, navigation, and settings.
2222
* @documentation https://nvidia.github.io/elements/docs/elements/drawer/
2323
* @since 0.16.0
2424
* @entrypoint \@nvidia-elements/core/drawer

‎projects/core/src/gauge/gauge.examples.ts‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,7 @@ export default {
1414
*/
1515
exportconstDefault={
1616
render: ()=>html`
17-
<divnve-layout="row gap:sm">
18-
<nve-gaugevalue="50">50%</nve-gauge>
19-
<nve-gaugestatus="accent" value="66">66%</nve-gauge>
20-
</div>
17+
<nve-gaugestatus="accent" value="66">66%</nve-gauge>
2118
`};
2219

2320
/**

‎projects/core/src/notification/notification.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import styles from './notification.css?inline';
2020

2121
/**
2222
* @element nve-notification
23-
* @description Displays real time updates without interrupting the user's workflow to communicate an important message or status. [MDN Popover API](https://developer.mozilla.org/en-US/docs/Web/API/Popover_API)
23+
* @description Displays real time updates without interrupting the user's workflow to communicate an important message or status.
2424
* @documentation https://nvidia.github.io/elements/docs/elements/notification/
2525
* @since 0.6.0
2626
* @entrypoint \@nvidia-elements/core/notification

‎projects/core/src/toast/toast.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import styles from './toast.css?inline';
2121

2222
/**
2323
* @element nve-toast
24-
* @description A contextual popup that displays a status. Toasts are [triggered](https://w3c.github.io/aria/#tooltip) by clicking, focusing, or tapping an element and cannot have interactive elements within them. [MDN Popover API](https://developer.mozilla.org/en-US/docs/Web/API/Popover_API)
24+
* @description A contextual popup that displays a status. Toasts are [triggered](https://w3c.github.io/aria/#tooltip) by clicking, focusing, or tapping an element and cannot have interactive elements within them.
2525
* @documentation https://nvidia.github.io/elements/docs/elements/toast/
2626
* @since 0.6.0
2727
* @entrypoint \@nvidia-elements/core/toast

‎projects/core/src/tooltip/tooltip.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import styles from './tooltip.css?inline';
1717

1818
/**
1919
* @element nve-tooltip
20-
* @description A contextual popup that displays a plaintext description. Tooltips are [triggered](https://w3c.github.io/aria/#tooltip) by hovering, focusing, or tapping an element and cannot have interactive elements within them. [MDN Popover API](https://developer.mozilla.org/en-US/docs/Web/API/Popover_API)
20+
* @description A contextual popup that displays a plaintext description. Trigger tooltips by hovering, focusing, or tapping an element and cannot have interactive elements within them.
2121
* @documentation https://nvidia.github.io/elements/docs/elements/tooltip/
2222
* @since 0.6.0
2323
* @entrypoint \@nvidia-elements/core/tooltip

‎projects/markdown/src/markdown/markdown.examples.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ export const Default = {
1717
render: ()=>html`
1818
<nve-markdown>
1919
<template>
20-
# Default
20+
## Markdown
2121
2222
This is a default markdown component in its initial state.
2323

‎projects/site/package.json‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,15 @@
167167
"env": {
168168
"PAGES_BASE_URL": {
169169
"external": true,
170-
"default": "/elements/preview/"
170+
"default": "/"
171+
},
172+
"ELEMENTS_SITE_URL": {
173+
"external": true,
174+
"default": "http://localhost:4173/"
175+
},
176+
"LOCAL_PREVIEW": {
177+
"external": true,
178+
"default": "false"
171179
}
172180
}
173181
},

‎projects/site/src/_11ty/layouts/common.js‎

Lines changed: 11 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,8 @@ export const renderBaseHead = data => {
7777
/* hide non-ssr elements until defined */
7878
nve-tree:not(:defined),
7979
nve-grid:not(:defined),
80-
nvd-canvas:not(:defined) {
80+
nvd-canvas:not(:defined),
81+
nve-button:not(:defined) {
8182
visibility: hidden !important;
8283
}
8384
@@ -219,7 +220,7 @@ export const renderDocsNav = data => /* html */ `
219220
<nve-tree-node ${data.page.url.includes('/docs/design-md/') ? 'highlighted selected' : ''}><a href="/docs/design-md/">DESIGN.md</a></nve-tree-node>
220221
</nve-tree-node>
221222
222-
<nve-tree-node ${data.page.url.includes('/docs/elements/') ? 'expanded' : ''}${data.page.url==='/docs/elements/' ? 'highlighted selected' : ''}>
223+
<nve-tree-node ${data.page.url.includes('/docs/elements/')||data.page.url.includes('/docs/monaco/')||data.page.url.includes('/docs/markdown/')||data.page.url.includes('/docs/code/')? 'expanded' : ''}${data.page.url==='/docs/elements/' ? 'highlighted selected' : ''}>
223224
<a href="/docs/elements/">Elements</a>
224225
<nve-tree-node ${data.page.url.includes('/docs/elements/accordion/') ? 'highlighted selected' : ''}><a href="/docs/elements/accordion/">Accordion</a></nve-tree-node>
225226
<nve-tree-node ${data.page.url.includes('/docs/elements/alert/') ? 'highlighted selected' : ''}><a href="/docs/elements/alert/">Alert</a></nve-tree-node>
@@ -231,6 +232,7 @@ export const renderDocsNav = data => /* html */ `
231232
<nve-tree-node ${data.page.url.includes('/docs/elements/card/') ? 'highlighted selected' : ''}><a href="/docs/elements/card/">Card</a></nve-tree-node>
232233
<nve-tree-node ${data.page.url.includes('/docs/elements/chat-message/') ? 'highlighted selected' : ''}><a href="/docs/elements/chat-message/">Chat Message</a></nve-tree-node>
233234
<nve-tree-node ${data.page.url.includes('/docs/elements/checkbox/') ? 'highlighted selected' : ''}><a href="/docs/elements/checkbox/">Checkbox</a></nve-tree-node>
235+
<nve-tree-node ${data.page.url.includes('/docs/code/codeblock/') ? 'highlighted selected' : ''}><a href="/docs/code/codeblock/">Codeblock</a></nve-tree-node>
234236
<nve-tree-node ${data.page.url.includes('/docs/elements/color/') ? 'highlighted selected' : ''}><a href="/docs/elements/color/">Color</a></nve-tree-node>
235237
<nve-tree-node ${data.page.url.includes('/docs/elements/combobox/') ? 'highlighted selected' : ''}><a href="/docs/elements/combobox/">Combobox</a></nve-tree-node>
236238
<nve-tree-node ${data.page.url.includes('/docs/elements/copy-button/') ? 'highlighted selected' : ''}><a href="/docs/elements/copy-button/">Copy Button</a></nve-tree-node>
@@ -285,8 +287,15 @@ export const renderDocsNav = data => /* html */ `
285287
<nve-tree-node ${data.page.url.includes('/docs/elements/input/') ? 'highlighted selected' : ''}><a href="/docs/elements/input/">Input</a></nve-tree-node>
286288
<nve-tree-node ${data.page.url.includes('/docs/elements/input-group/') ? 'highlighted selected' : ''}><a href="/docs/elements/input-group/">Input Group</a></nve-tree-node>
287289
<nve-tree-node ${data.page.url.includes('/docs/elements/logo/') ? 'highlighted selected' : ''}><a href="/docs/elements/logo/">Logo</a></nve-tree-node>
290+
<nve-tree-node ${data.page.url.endsWith('/docs/markdown/') ? 'highlighted selected' : ''}><a href="/docs/markdown/">Markdown</a></nve-tree-node>
291+
<nve-tree-node ${data.page.url.includes('/docs/markdown/styles/') ? 'highlighted selected' : ''}><a href="/docs/markdown/styles/">Markdown CSS</a></nve-tree-node>
288292
<nve-tree-node ${data.page.url.includes('/docs/elements/menu/') ? 'highlighted selected' : ''}><a href="/docs/elements/menu/">Menu</a></nve-tree-node>
289293
<nve-tree-node ${data.page.url.includes('/docs/elements/month/') ? 'highlighted selected' : ''}><a href="/docs/elements/month/">Month</a></nve-tree-node>
294+
<nve-tree-node ${data.page.url.includes('/docs/monaco/input/') ? 'highlighted selected' : ''}><a href="/docs/monaco/input/">Monaco Input</a></nve-tree-node>
295+
<nve-tree-node ${data.page.url.includes('/docs/monaco/diff-input/') ? 'highlighted selected' : ''}><a href="/docs/monaco/diff-input/">Monaco Diff Input</a></nve-tree-node>
296+
<nve-tree-node ${data.page.url.includes('/docs/monaco/editor/') ? 'highlighted selected' : ''}><a href="/docs/monaco/editor/">Monaco Editor</a></nve-tree-node>
297+
<nve-tree-node ${data.page.url.includes('/docs/monaco/diff-editor/') ? 'highlighted selected' : ''}><a href="/docs/monaco/diff-editor/">Monaco Diff Editor</a></nve-tree-node>
298+
<nve-tree-node ${data.page.url.includes('/docs/monaco/problems/') ? 'highlighted selected' : ''}><a href="/docs/monaco/problems/">Monaco Problems</a></nve-tree-node>
290299
<nve-tree-node ${data.page.url.includes('/docs/elements/notification/') ? 'highlighted selected' : ''}><a href="/docs/elements/notification/">Notification</a></nve-tree-node>
291300
<nve-tree-node ${data.page.url.includes('/docs/elements/page/') ? 'highlighted selected' : ''}><a href="/docs/elements/page/">Page</a></nve-tree-node>
292301
<nve-tree-node ${data.page.url.includes('/docs/elements/page-header/') ? 'highlighted selected' : ''}><a href="/docs/elements/page-header/">Page Header</a></nve-tree-node>
@@ -342,26 +351,6 @@ export const renderDocsNav = data => /* html */ `
342351
<nve-tree-node ${data.page.url.includes('/docs/patterns/trend/') ? 'highlighted selected' : ''}><a href="/docs/patterns/trend/">Trend</a></nve-tree-node>
343352
</nve-tree-node>
344353
345-
<nve-tree-node ${data.page.url.includes('/docs/code/') ? 'expanded' : ''}>
346-
<a href="/docs/code/codeblock/">Code</a>
347-
<nve-tree-node ${data.page.url.includes('/docs/code/codeblock/') ? 'highlighted selected' : ''}><a href="/docs/code/codeblock/">Codeblock</a></nve-tree-node>
348-
</nve-tree-node>
349-
350-
<nve-tree-node ${data.page.url.includes('/docs/monaco/') ? 'expanded' : ''}>
351-
<a href="/docs/monaco/input/">Monaco</a>
352-
<nve-tree-node ${data.page.url.includes('/docs/monaco/input/') ? 'highlighted selected' : ''}><a href="/docs/monaco/input/">Input</a></nve-tree-node>
353-
<nve-tree-node ${data.page.url.includes('/docs/monaco/diff-input/') ? 'highlighted selected' : ''}><a href="/docs/monaco/diff-input/">Diff Input</a></nve-tree-node>
354-
<nve-tree-node ${data.page.url.includes('/docs/monaco/editor/') ? 'highlighted selected' : ''}><a href="/docs/monaco/editor/">Editor</a></nve-tree-node>
355-
<nve-tree-node ${data.page.url.includes('/docs/monaco/diff-editor/') ? 'highlighted selected' : ''}><a href="/docs/monaco/diff-editor/">Diff Editor</a></nve-tree-node>
356-
<nve-tree-node ${data.page.url.includes('/docs/monaco/problems/') ? 'highlighted selected' : ''}><a href="/docs/monaco/problems/">Problems</a></nve-tree-node>
357-
</nve-tree-node>
358-
359-
<nve-tree-node ${data.page.url.includes('/docs/markdown/') ? 'expanded' : ''}>
360-
<a href="/docs/markdown/">Markdown</a>
361-
<nve-tree-node ${data.page.url.endsWith('/docs/markdown/') ? 'highlighted selected' : ''}><a href="/docs/markdown/">Markdown</a></nve-tree-node>
362-
<nve-tree-node ${data.page.url.includes('/docs/markdown/styles/') ? 'highlighted selected' : ''}><a href="/docs/markdown/styles/">CSS Utility</a></nve-tree-node>
363-
</nve-tree-node>
364-
365354
<nve-tree-node ${data.page.url.includes('/docs/labs/') ? 'expanded' : ''}${data.page.url==='/docs/labs/' ? 'highlighted' : ''}>
366355
<a href="/docs/labs/">Labs</a>
367356
<nve-tree-node ${data.page.url.includes('/docs/labs/layout/responsive/') ? 'expanded' : ''}${data.page.url==='/docs/labs/layout/responsive/' ? 'highlighted' : ''}>

‎projects/site/src/_11ty/layouts/docs.css‎

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -205,25 +205,26 @@ p[nve-text~='mkd']:has(*:not(code, a, pre)) {
205205
text-box: initial !important;
206206
}
207207

208-
code:has(nve-codeblock) {
209-
display: contents;
210-
}
211-
212208
pre {
213209
display: block;
214210
margin:0;
215211
padding:0;
216212
width:100%;
217213
}
218214

219-
code>nve-codeblock {
220-
--padding:var(--nve-ref-space-lg);
221-
min-height:65px;
215+
.markdown-codeblock {
216+
anchor-scope:--codeblock;
222217
width:100%;
223-
anchor-name:--codeblock;
218+
219+
nve-codeblock {
220+
--padding:var(--nve-ref-space-lg);
221+
anchor-name:--codeblock;
222+
min-height:65px;
223+
width:100%;
224+
}
224225
}
225226

226-
nve-copy-button.markdown-copy-button {
227+
.markdown-copy-button {
227228
position: absolute;
228229
position-anchor:--codeblock;
229230
bottom:calc(anchor(bottom) +var(--nve-ref-space-md));
@@ -232,17 +233,11 @@ nve-copy-button.markdown-copy-button {
232233
transition: opacity 0.15s ease-in-out;
233234
}
234235

235-
code:has(nve-codeblock:hover) nve-copy-button.markdown-copy-button,
236-
nve-copy-button.markdown-copy-button:hover {
236+
.markdown-codeblock:has(nve-codeblock:hover) .markdown-copy-button,
237+
.markdown-copy-button:hover {
237238
opacity:1;
238239
}
239240

240-
pre:has(nve-codeblock),
241-
code:has(nve-codeblock) {
242-
display: contents;
243-
anchor-scope:--codeblock;
244-
}
245-
246241
/* Canvas Styles */
247242
nvd-canvas {
248243
min-height:120px;

0 commit comments

Comments
 (0)