@gsa-tts/graymatter-ui 0.3.14 → 0.3.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -4
- package/dist/graymatter-ui.js +651 -651
- package/dist/graymatter-ui.umd.cjs +21 -21
- package/package.json +6 -3
- package/src/components/ApiDocSubNavList.svelte +25 -0
- package/src/components/ApiDocSubNavMenu.svelte +464 -0
- package/src/components/ApiDocSubNavMenuItem.svelte +116 -0
- package/src/components/DesktopSideNav.svelte +2 -2
- package/src/components/index.ts +3 -0
- package/src/content/api/endpoints.mdx +174 -0
- package/src/content/api/getting-started.mdx +84 -0
- package/src/content/api/support.mdx +10 -0
- package/src/layouts/DocsLayout.astro +178 -0
- package/src/types/subnav.ts +15 -0
- package/src/utils/copyButtonScript.ts +107 -0
- package/src/utils/generateApiNavData.ts +113 -0
- package/src/utils/index.ts +2 -0
package/README.md
CHANGED
|
@@ -190,6 +190,7 @@ import {
|
|
|
190
190
|
### Layout Components
|
|
191
191
|
- **GlobalAppLayout** - Main application layout wrapper
|
|
192
192
|
- **BaseLayout** - Base page layout structure
|
|
193
|
+
- **DocsLayout** - Documentation layout with dynamic navigation (Astro only)
|
|
193
194
|
|
|
194
195
|
### UI Components
|
|
195
196
|
- **ProfileMenu** - User profile dropdown menu with event-driven actions
|
|
@@ -235,15 +236,18 @@ Detailed documentation for specific components is available in the package:
|
|
|
235
236
|
|
|
236
237
|
- **[NAVIGATION_CONTROL.md](https://github.com/GSA-TTS/usai-gov/blob/main/packages/ui/NAVIGATION_CONTROL.md)** - DesktopSideNav external control system with event-based API
|
|
237
238
|
- **[PROFILE_MENU.md](https://github.com/GSA-TTS/usai-gov/blob/main/packages/ui/PROFILE_MENU.md)** - ProfileMenu component usage and event handling
|
|
239
|
+
- **[README_DocsLayout.md](https://github.com/GSA-TTS/usai-gov/blob/main/packages/ui/README_DocsLayout.md)** - DocsLayout component with dynamic navigation generation (Astro only)
|
|
238
240
|
|
|
239
241
|
These files are also included with the package in your `node_modules/@gsa-tts/graymatter-ui/` directory. If you don't have access to the private repository, you can find the documentation files locally after installation.
|
|
240
242
|
|
|
241
243
|
## Framework Support
|
|
242
244
|
|
|
243
|
-
- **Svelte 5** - Native Svelte components
|
|
244
|
-
- **Astro** - Full support with client-side hydration
|
|
245
|
-
- **React/Vue/Angular** - Via web components
|
|
246
|
-
- **Vanilla JavaScript** - Via web components
|
|
245
|
+
- **Svelte 5** - Native Svelte components (individual components only)
|
|
246
|
+
- **Astro** - Full support with client-side hydration (including DocsLayout)
|
|
247
|
+
- **React/Vue/Angular** - Via web components (individual components only)
|
|
248
|
+
- **Vanilla JavaScript** - Via web components (individual components only)
|
|
249
|
+
|
|
250
|
+
**Note:** The `DocsLayout` component is Astro-specific and cannot be used in other frameworks. For non-Astro applications, use the individual Svelte components and shared utilities instead.
|
|
247
251
|
|
|
248
252
|
## Troubleshooting
|
|
249
253
|
|