docs(ui): publish complete component catalog
This commit is contained in:
Clintchiz committed
1 parent
b190bbf41c
commit
45f2820871
975 files changed
+49638
-294
No files matched your search
@@ -9,13 +9,12 @@ page wrnexusui {
|
||||
<SkipLink label="Skip to content" href="#main" class="docs-skip-link" />
|
||||
<header class="topbar">
|
||||
<a class="brand" href="/"><span>W</span> WRNexusJS</a>
|
||||
<nav aria-label="Primary"><a href="/getting-started">Get started</a><a href="/packages">Packages</a><a href="/language">Language</a><a href="/architecture">Architecture</a></nav>
|
||||
<nav aria-label="Primary"><a href="/getting-started">Get started</a><a href="/packages">Packages</a><a href="/components">Components</a><a href="/language">Language</a><a href="/architecture">Architecture</a></nav>
|
||||
<div class="topbar-actions"><a class="preview-pill" href="/access">Private preview · v0.2.64</a><button data-wire-theme-toggle class="theme-button" aria-label="Toggle color theme" title="Toggle color theme">◐</button></div>
|
||||
</header>
|
||||
<div class="mobile-doc-nav"><details><summary>Browse documentation</summary><nav><a href="/getting-started">Get started</a><a href="/packages">Packages</a><a href="/language">Language</a><a href="/architecture">Architecture</a><a href="/tutorial">Tutorial</a><a href="/guides/project-structure">Guides</a><a href="/examples">Examples</a><a href="/search">Search</a></nav></details></div>
|
||||
<main class="page package-page">
|
||||
<aside class="sidebar"><a href="/packages">← All packages</a><span class="category">Frontend</span><h2>@wrnexus/ui</h2><p>Themeable server-rendered UI components and CSS.</p><span class="status status-beta">Private preview · 0.2.64</span><nav><a href="#access">Access</a><a href="#guide">Guide</a><a href="#api">Complete API</a></nav></aside>
|
||||
<article id="main" class="documentation"><section class="doc-intro"><span class="eyebrow">Frontend · Preview</span><h1>@wrnexus/ui</h1><p>Themeable server-rendered UI components and CSS.</p><section id="access" class="access-callout"><h2>Private registry access required</h2><p>This package is not available from the public npm registry. After WorkRoot approves access and supplies private registry instructions, install the release-aligned package:</p><pre><code>bun add @wrnexus/ui@0.2.64</code><button type="button" class="copy-button" aria-label="Copy installation command">Copy</button></pre><p><a href="/access">Request preview access</a>. Never put registry tokens in source control.</p></section></section><section id="guide" class="prose"><blockquote>First-party Wire UI component library — a set of themeable <code>.wrn</code> components plus a single tokenized stylesheet.</blockquote>
|
||||
<div class="mobile-doc-nav"><details><summary>Browse documentation</summary><nav><a href="/getting-started">Get started</a><a href="/packages">Packages</a><a href="/components">Components</a><a href="/language">Language</a><a href="/architecture">Architecture</a><a href="/tutorial">Tutorial</a><a href="/guides/project-structure">Guides</a><a href="/examples">Examples</a><a href="/search">Search</a></nav></details></div>
|
||||
<main class="portal-main docs-layout">
|
||||
<article id="main" class="documentation prose standalone package-document"><nav class="breadcrumbs" aria-label="Breadcrumb"><a href="/">Home</a><span>/</span><a href="/packages">Packages</a><span>/</span><span aria-current="page">@wrnexus/ui</span></nav><section class="doc-intro"><span class="eyebrow">Frontend · Package reference</span><h1>@wrnexus/ui</h1><p>Themeable server-rendered UI components and CSS.</p><div class="doc-meta"><span>v0.2.64</span><span>Private registry</span><span>Frontend</span></div><section id="access" class="access-callout"><h2>Install the package</h2><p>After WorkRoot approves private registry access, install the release-aligned package:</p><pre><code>bun add @wrnexus/ui@0.2.64</code><button type="button" class="copy-button" aria-label="Copy installation command">Copy</button></pre><p><a href="/access">Request preview access</a>. Never put registry tokens in source control.</p></section></section><section id="guide"><blockquote>First-party Wire UI component library — a set of themeable <code>.wrn</code> components plus a single tokenized stylesheet.</blockquote>
|
||||
<p>Part of the <strong>WRNexusJS</strong> framework — an SSR-first, Bun-native full-stack web framework.</p>
|
||||
<h3 id="overview">Overview</h3>
|
||||
<p><code>@wrnexus/ui</code> ships a library of server-rendered <code>.wrn</code> components (layout, form controls, and feedback UI) together with one themeable stylesheet, <code>ui.css</code>. The components are <strong>auto-discovered</strong> by the framework router — you don't import them in code. Once the package's component directory is on the router's scan path, you mount any component in a page with <code>data-component="<name>"</code>. Every visual is driven by <code>var(--wire-*)</code> theme tokens, so components restyle instantly when the theme changes. The tiny JS surface (<code>src/index.ts</code>) exists only so the toolchain (CLI build + dev server) can locate the component directory and stylesheet.</p>
|
||||
@@ -97,7 +96,7 @@ const router = buildRouter(appDir, { componentDirs: [uiComponentsDir()] 
|
||||
<li>Depends on [<code>@wrnexus/core</code>](../core) (<code>dependencies</code>).</li>
|
||||
<li><code>theme-toggle</code> relies on the framework's theme runtime, which binds the</li>
|
||||
<p><code>data-wire-theme-toggle</code> attribute — no per-component JS is required.</p>
|
||||
</ul></section><section id="api" class="prose api"><h2>Complete TypeScript API</h2><p>This declaration comes from the exact installed package and lists its exported functions, classes, interfaces, and types.</p><pre data-language="typescript"><code>/**
|
||||
</ul></section><section id="api" class="api"><h2>Complete TypeScript API</h2><p>Generated from the exact installed package declarations.</p><pre data-language="typescript"><code>/**
|
||||
* @wrnexus/ui — the Wire UI component library.
|
||||
*
|
||||
* Components are `.wrn` files under `components/`, auto-discovered by the
|
||||
@@ -122,15 +121,15 @@ declare function uiCss(): string;
|
||||
declare function uiComponentNames(): string[];
|
||||
|
||||
export { uiComponentNames, uiComponentsDir, uiCss, uiCssPath };
|
||||
</code></pre></section><section id="examples" class="prose examples"><h2>Examples</h2><p>Examples are taken from this package's installed documentation and must be evaluated with its requirements and stability notes.</p><div class="example-grid"><article class="example-card"><h3>Auto-discovery</h3><pre data-language="ts"><code>import { buildRouter } from "@wrnexus/router";
|
||||
</code></pre></section><section id="examples" class="examples"><h2>Examples</h2><p>Copy-ready examples from the installed package documentation.</p><div class="example-grid"><article class="example-card"><h3>Auto-discovery</h3><pre data-language="ts"><code>import { buildRouter } from "@wrnexus/router";
|
||||
import { uiComponentsDir } from "@wrnexus/ui";
|
||||
|
||||
const router = buildRouter(appDir, { componentDirs: [uiComponentsDir()] });</code></pre></article><article class="example-card"><h3>Mounting components in a page</h3><pre data-language="html"><code><div data-component="card">
|
||||
<div data-component="badge" label="New"></div>
|
||||
<button data-component="button" label="Save" variant="primary" size="lg"></button>
|
||||
<div data-component="alert" variant="success" title="Done" message="Saved."></div>
|
||||
</div></code></pre></article></div></section><section id="components" class="prose ui-component-reference"><h2>All 901 UI components and props</h2><p>This reference is generated from the exact installed <code>.wrn</code> sources. Required props have no default; optional props show their default value.</p><h3>Actions</h3><div class="table-wrap"><table><thead><tr><th>Component</th><th>Props</th><th>Slots</th><th>Events</th></tr></thead><tbody><tr><td><strong>AcceptAllCookiesButton</strong><br><code>data-component="AcceptAllCookiesButton"</code><br><small>Reusable accept all cookies button component.</small></td><td><code>label: string = "Action"</code><br><code>href: string = ""</code><br><code>type: string = "button"</code><br><code>variant: string = "primary"</code><br><code>disabled: boolean = false</code><br><code>class: string = ""</code></td><td><code>default</code></td><td>None</td></tr><tr><td><strong>ArticleNewsletterCTA</strong><br><code>data-component="ArticleNewsletterCTA"</code><br><small>Reusable article newsletter c t a component.</small></td><td><code>label: string = "Action"</code><br><code>href: string = ""</code><br><code>type: string = "button"</code><br><code>variant: string = "primary"</code><br><code>disabled: boolean = false</code><br><code>class: string = ""</code></td><td><code>default</code></td><td>None</td></tr><tr><td><strong>ArticleShareActions</strong><br><code>data-component="ArticleShareActions"</code><br><small>Reusable article share actions component.</small></td><td><code>label: string = "Action"</code><br><code>href: string = ""</code><br><code>type: string = "button"</code><br><code>variant: string = "primary"</code><br><code>disabled: boolean = false</code><br><code>class: string = ""</code></td><td><code>default</code></td><td>None</td></tr><tr><td><strong>BackButton</strong><br><code>data-component="BackButton"</code><br><small>Reusable back button component.</small></td><td><code>label: string = "Action"</code><br><code>type: string = "button"</code><br><code>disabled: boolean = false</code><br><code>class: string = ""</code></td><td><code>default</code></td><td>None</td></tr><tr><td><strong>Button</strong><br><code>data-component="Button"</code><br><small>Reusable button component.</small></td><td><code>label: string = "Button"</code><br><code>type: string = "button"</code><br><code>variant: string = "primary"</code><br><code>size: string = "md"</code><br><code>disabled: boolean = false</code><br><code>loading: boolean = false</code><br><code>icon: string = ""</code><br><code>className: string = ""</code></td><td>None</td><td>None</td></tr><tr><td><strong>CenteredCTA</strong><br><code>data-component="CenteredCTA"</code><br><small>Reusable centered c t a component.</small></td><td><code>label: string = "Action"</code><br><code>href: string = ""</code><br><code>type: string = "button"</code><br><code>variant: string = "primary"</code><br><code>disabled: boolean = false</code><br><code>class: string = ""</code></td><td><code>default</code></td><td>None</td></tr><tr><td><strong>ClearFiltersButton</strong><br><code>data-component="ClearFiltersButton"</code><br><small>Reusable clear filters button component.</small></td><td><code>label: string = "Action"</code><br><code>href: string = ""</code><br><code>type: string = "button"</code><br><code>variant: string = "primary"</code><br><code>disabled: boolean = false</code><br><code>class: string = ""</code></td><td><code>default</code></td><td>None</td></tr><tr><td><strong>CloseButton</strong><br><code>data-component="CloseButton"</code><br><small>Reusable close button component.</small></td><td><code>label: string = "Action"</code><br><code>type: string = "button"</code><br><code>disabled: boolean = false</code><br><code>class: string = ""</code></td><td><code>default</code></td><td>None</td></tr><tr><td><strong>CodeCopyButton</strong><br><code>data-component="CodeCopyButton"</code><br><small>Reusable code copy button component.</small></td><td><code>label: string = "Action"</code><br><code>href: string = ""</code><br><code>type: string = "button"</code><br><code>variant: string = "primary"</code><br><code>disabled: boolean = false</code><br><code>class: string = ""</code></td><td><code>default</code></td><td>None</td></tr><tr><td><strong>ContactCTA</strong><br><code>data-component="ContactCTA"</code><br><small>Reusable contact c t a component.</small></td><td><code>label: string = "Action"</code><bLine truncated
|
||||
<aside class="on-this-page"><h2>On this page</h2><nav><a class="toc-level-2" href="#guide">Guide</a><a class="toc-level-3" href="#overview">Overview</a><a class="toc-level-3" href="#components">Components</a><a class="toc-level-4" href="#layout">Layout</a><a class="toc-level-4" href="#core-feedback">Core / feedback</a><a class="toc-level-4" href="#additional-controls-data-display">Additional controls & data display</a><a class="toc-level-3" href="#api">API</a><a class="toc-level-4" href="#ui-css-asset-export">./ui.css asset export</a><a class="toc-level-4" href="#tailwind-and-motion">Tailwind and motion</a><a class="toc-level-4" href="#using-the-selected-theme-in-application-ui">Using the selected theme in application UI</a><a class="toc-level-3" href="#usage">Usage</a><a class="toc-level-4" href="#auto-discovery">Auto-discovery</a><a class="toc-level-4" href="#mounting-components-in-a-page">Mounting components in a page</a><a class="toc-level-3" href="#overrides">Overrides</a><a class="toc-level-3" href="#requirements-notes">Requirements / Notes</a><a class="toc-level-2" href="#api">Complete API</a><a class="toc-level-2" href="#examples">Examples</a><a class="toc-level-2" href="#components">All UI components</a></nav></aside>
|
||||
</div></code></pre></article></div></section><section class="prose component-catalog-callout"><h2>Explore the component library</h2><p>The component reference now has a dedicated catalog with searchable cards and one complete page per component.</p><p><a class="primary" href="/components">Browse all 901 components →</a></p></section></article>
|
||||
<aside class="on-this-page"><h2>On this page</h2><nav><a class="toc-level-2" href="#guide">Guide</a><a class="toc-level-3" href="#overview">Overview</a><a class="toc-level-3" href="#components">Components</a><a class="toc-level-4" href="#layout">Layout</a><a class="toc-level-4" href="#core-feedback">Core / feedback</a><a class="toc-level-4" href="#additional-controls-data-display">Additional controls & data display</a><a class="toc-level-3" href="#api">API</a><a class="toc-level-4" href="#ui-css-asset-export">./ui.css asset export</a><a class="toc-level-4" href="#tailwind-and-motion">Tailwind and motion</a><a class="toc-level-4" href="#using-the-selected-theme-in-application-ui">Using the selected theme in application UI</a><a class="toc-level-3" href="#usage">Usage</a><a class="toc-level-4" href="#auto-discovery">Auto-discovery</a><a class="toc-level-4" href="#mounting-components-in-a-page">Mounting components in a page</a><a class="toc-level-3" href="#overrides">Overrides</a><a class="toc-level-3" href="#requirements-notes">Requirements / Notes</a><a class="toc-level-2" href="#api">Complete API</a><a class="toc-level-2" href="#examples">Examples</a></nav></aside>
|
||||
</main>
|
||||
<footer><div class="footer-brand"><span class="footer-mark" aria-hidden="true">W</span><p><strong>WRNexusJS 0.2.64</strong><span>Complete API documentation generated from installed package declarations.</span></p></div><nav aria-label="Footer"><a href="/packages">All packages</a><a href="/getting-started">Get started</a><a href="/security">Security</a><a href="/support">Support</a><a href="/llms.txt">AI guide</a></nav><p class="footer-meta">Private Developer Preview · Bun-native</p></footer>
|
||||
<BackToTop />
|
||||
|
||||
Reference in new issue
Block a user