51 lines
5.5 KiB
Plaintext
51 lines
5.5 KiB
Plaintext
page fileuploadcomponent {
|
|
seo {
|
|
title = "file-upload component"
|
|
description = "Reusable file-upload component."
|
|
}
|
|
|
|
view {
|
|
<div class="docs-shell">
|
|
<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="/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.73</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="/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 component-detail-page"><article id="main" class="documentation prose standalone"><nav class="breadcrumbs" aria-label="Breadcrumb"><a href="/">Home</a><span>/</span><a href="/components">Components</a><span>/</span><span aria-current="page">file-upload</span></nav><section class="doc-intro"><span class="eyebrow">core component</span><h1>file-upload</h1><p>Reusable file-upload component.</p><div class="doc-meta"><span>@wrnexus/ui 0.2.73</span><span>7 props</span><span>0 slots</span><span>0 events</span></div></section><section id="usage"><h2>Usage</h2><p>Components are auto-discovered. Use the component directly in any <code>.wrn</code> view:</p><pre data-language="wrn"><code><file-upload
|
|
store="public"
|
|
endpoint="/api/upload"
|
|
accept="accept"
|
|
multiple="false"
|
|
max="0"
|
|
/></code></pre><p>Legacy mount name: <code>data-component="file-upload"</code>.</p></section><section id="props"><h2>Props and attributes</h2><div class="table-wrap"><table><thead><tr><th>Prop</th><th>Type</th><th>Requirement</th><th>Default</th></tr></thead><tbody><tr><td><code>store</code></td><td><code>string</code></td><td>Optional</td><td><code>"public"</code></td></tr><tr><td><code>endpoint</code></td><td><code>string</code></td><td>Optional</td><td><code>"/api/upload"</code></td></tr><tr><td><code>accept</code></td><td><code>string</code></td><td>Optional</td><td><code>""</code></td></tr><tr><td><code>multiple</code></td><td><code>boolean</code></td><td>Optional</td><td><code>false</code></td></tr><tr><td><code>max</code></td><td><code>number</code></td><td>Optional</td><td><code>0</code></td></tr><tr><td><code>label</code></td><td><code>string</code></td><td>Optional</td><td><code>"Drag files here or click to browse"</code></td></tr><tr><td><code>class</code></td><td><code>string</code></td><td>Optional</td><td><code>""</code></td></tr></tbody></table></div></section><section id="slots"><h2>Slots</h2><p>This component does not declare a slot.</p></section><section id="events"><h2>Events</h2><p>This component does not declare a custom event.</p></section><section id="source"><h2>Source contract</h2><p>Installed source: <code>components/file-upload.wrn</code></p><pre data-language="wrn"><code>// Drag-and-drop file uploader with per-file progress. Progressive enhancement:
|
|
// the markup is inert until /__wrnexus/uploader.js loads (auto-injected when a
|
|
// page contains `data-uploader`). Pairs with `handleUpload` on the server —
|
|
// files POST to `endpoint`, which returns `{ ok, files:[{ key, url, … }] }`.
|
|
//
|
|
// <div data-component="file-upload" store="public" endpoint="/api/upload"
|
|
// accept="image/*" max="10000000" multiple="true">
|
|
</div>
|
|
component FileUpload {
|
|
props {
|
|
store = "public"
|
|
endpoint = "/api/upload"
|
|
accept = ""
|
|
multiple = false
|
|
max = 0
|
|
label = "Drag files here or click to browse"
|
|
class = ""
|
|
}
|
|
view {
|
|
<div class="wire-fileupload {class}" data-uploader="{store}" data-endpoint="{endpoint}" data-accept="{accept}" data-multiple="{multiple}" data-max="{max}" data-label="{label}">
|
|
</div>
|
|
}
|
|
}
|
|
</code></pre></section></article><aside class="on-this-page"><h2>On this page</h2><nav><a href="#usage">Usage</a><a href="#props">Props and attributes</a><a href="#slots">Slots</a><a href="#events">Events</a><a href="#source">Source contract</a></nav></aside></main>
|
|
<footer><div class="footer-brand"><span class="footer-mark" aria-hidden="true">W</span><p><strong>WRNexusJS 0.2.73</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 />
|
|
</div>
|
|
}
|
|
}
|