Files
WRNexusJSDoc/app/pages/packages/playground.wrn
T

66 lines
5.5 KiB
Plaintext

page wrnexusplayground {
seo {
title = "@wrnexus/playground"
description = "Interactive framework examples and executable playground utilities."
}
view {
<div class="docs-shell">
<a href="#main" class="skip-link">Skip to content</a>
<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="https://component.wrnexusjs.dev/">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.8.6</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="https://component.wrnexusjs.dev/">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/playground</span></nav><section class="doc-intro"><span class="eyebrow">Tooling · Package reference</span><h1>@wrnexus/playground</h1><p>Interactive framework examples and executable playground utilities.</p><div class="doc-meta"><span>v0.8.6</span><span>Private registry</span><span>Tooling</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/playground@0.8.6</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"><p>A deployable, shareable <code>.wrn</code> playground with diagnostics, generated JavaScript, safe SSR-shaped HTML, sandboxed preview, reactive/UI examples, and version adapters.</p>
<p>Run <code>wrnexus playground</code>, or deploy <code>createPlaygroundHandler()</code>.</p></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>interface PlaygroundCompilation &#123;
source: string;
generated: string;
client: string;
html: string;
interactiveHtml: string;
diagnostics: Array&lt;&#123;
code: string;
message: string;
severity: string;
&#125;&gt;;
version: string;
&#125;
interface PlaygroundVersionAdapter &#123;
version: string;
compile(source: string): Promise&lt;Omit&lt;PlaygroundCompilation, &quot;source&quot; | &quot;version&quot;&gt;&gt;;
&#125;
declare function compilePlayground(source: string, version?: string): PlaygroundCompilation;
declare function encodePlaygroundShare(source: string): string;
declare function decodePlaygroundShare(value: string): string;
declare function comparePlaygroundVersions(source: string, adapters: PlaygroundVersionAdapter[]): Promise&lt;&#123;
current: PlaygroundCompilation;
comparisons: &#123;
generated: string;
client: string;
html: string;
interactiveHtml: string;
diagnostics: Array&lt;&#123;
code: string;
message: string;
severity: string;
&#125;&gt;;
version: string;
&#125;[];
&#125;&gt;;
declare function createPlaygroundHandler(options?: &#123;
versions?: PlaygroundVersionAdapter[];
examples?: Record&lt;string, string&gt;;
&#125;): (request: Request) =&gt; Promise&lt;Response&gt;;
export &#123; type PlaygroundCompilation, type PlaygroundVersionAdapter, comparePlaygroundVersions, compilePlayground, createPlaygroundHandler, decodePlaygroundShare, encodePlaygroundShare &#125;;
</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>Install @wrnexus/playground</h3><pre data-language="sh"><code>bun add @wrnexus/playground</code></pre></article><article class="example-card"><h3>Import @wrnexus/playground</h3><pre data-language="ts"><code>import * as playground from &quot;@wrnexus/playground&quot;;</code></pre></article></div></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-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.8.6</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>
</div>
}
}