docs: update portal for WRNexusJS 0.5.10
This commit is contained in:
+86
-41
@@ -1,4 +1,4 @@
|
||||
# WRNexusJS documentation 0.5.1
|
||||
# WRNexusJS documentation 0.5.10
|
||||
|
||||
Status: Private Developer Preview. This site documents 31 release-aligned packages.
|
||||
|
||||
@@ -289,193 +289,193 @@ wrnexus eject <component> # copy a Wire UI component's .wrn into app/compone
|
||||
|
||||
## @wrnexus/ai
|
||||
|
||||
- @wrnexus/ai 0.5.1
|
||||
- @wrnexus/ai 0.5.10
|
||||
- Documentation: https://wrnexusjs.dev/packages/ai
|
||||
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
|
||||
|
||||
## @wrnexus/auth
|
||||
|
||||
- @wrnexus/auth 0.5.1
|
||||
- @wrnexus/auth 0.5.10
|
||||
- Documentation: https://wrnexusjs.dev/packages/auth
|
||||
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
|
||||
|
||||
## @wrnexus/authz
|
||||
|
||||
- @wrnexus/authz 0.5.1
|
||||
- @wrnexus/authz 0.5.10
|
||||
- Documentation: https://wrnexusjs.dev/packages/authz
|
||||
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
|
||||
|
||||
## @wrnexus/captcha
|
||||
|
||||
- @wrnexus/captcha 0.5.1
|
||||
- @wrnexus/captcha 0.5.10
|
||||
- Documentation: https://wrnexusjs.dev/packages/captcha
|
||||
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
|
||||
|
||||
## @wrnexus/cli
|
||||
|
||||
- @wrnexus/cli 0.5.1
|
||||
- @wrnexus/cli 0.5.10
|
||||
- Documentation: https://wrnexusjs.dev/packages/cli
|
||||
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
|
||||
|
||||
## @wrnexus/compiler
|
||||
|
||||
- @wrnexus/compiler 0.5.1
|
||||
- @wrnexus/compiler 0.5.10
|
||||
- Documentation: https://wrnexusjs.dev/packages/compiler
|
||||
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
|
||||
|
||||
## @wrnexus/core
|
||||
|
||||
- @wrnexus/core 0.5.1
|
||||
- @wrnexus/core 0.5.10
|
||||
- Documentation: https://wrnexusjs.dev/packages/core
|
||||
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
|
||||
|
||||
## @wrnexus/csr
|
||||
|
||||
- @wrnexus/csr 0.5.1
|
||||
- @wrnexus/csr 0.5.10
|
||||
- Documentation: https://wrnexusjs.dev/packages/csr
|
||||
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
|
||||
|
||||
## @wrnexus/db
|
||||
|
||||
- @wrnexus/db 0.5.1
|
||||
- @wrnexus/db 0.5.10
|
||||
- Documentation: https://wrnexusjs.dev/packages/db
|
||||
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
|
||||
|
||||
## @wrnexus/dev-server
|
||||
|
||||
- @wrnexus/dev-server 0.5.1
|
||||
- @wrnexus/dev-server 0.5.10
|
||||
- Documentation: https://wrnexusjs.dev/packages/dev-server
|
||||
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
|
||||
|
||||
## @wrnexus/dev-toolbar
|
||||
|
||||
- @wrnexus/dev-toolbar 0.5.1
|
||||
- @wrnexus/dev-toolbar 0.5.10
|
||||
- Documentation: https://wrnexusjs.dev/packages/dev-toolbar
|
||||
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
|
||||
|
||||
## @wrnexus/encryption
|
||||
|
||||
- @wrnexus/encryption 0.5.1
|
||||
- @wrnexus/encryption 0.5.10
|
||||
- Documentation: https://wrnexusjs.dev/packages/encryption
|
||||
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
|
||||
|
||||
## @wrnexus/helpers
|
||||
|
||||
- @wrnexus/helpers 0.5.1
|
||||
- @wrnexus/helpers 0.5.10
|
||||
- Documentation: https://wrnexusjs.dev/packages/helpers
|
||||
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
|
||||
|
||||
## @wrnexus/i18n
|
||||
|
||||
- @wrnexus/i18n 0.5.1
|
||||
- @wrnexus/i18n 0.5.10
|
||||
- Documentation: https://wrnexusjs.dev/packages/i18n
|
||||
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
|
||||
|
||||
## @wrnexus/jwt
|
||||
|
||||
- @wrnexus/jwt 0.5.1
|
||||
- @wrnexus/jwt 0.5.10
|
||||
- Documentation: https://wrnexusjs.dev/packages/jwt
|
||||
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
|
||||
|
||||
## @wrnexus/mobile
|
||||
|
||||
- @wrnexus/mobile 0.5.1
|
||||
- @wrnexus/mobile 0.5.10
|
||||
- Documentation: https://wrnexusjs.dev/packages/mobile
|
||||
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
|
||||
|
||||
## @wrnexus/native
|
||||
|
||||
- @wrnexus/native 0.5.1
|
||||
- @wrnexus/native 0.5.10
|
||||
- Documentation: https://wrnexusjs.dev/packages/native
|
||||
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
|
||||
|
||||
## @wrnexus/oauth
|
||||
|
||||
- @wrnexus/oauth 0.5.1
|
||||
- @wrnexus/oauth 0.5.10
|
||||
- Documentation: https://wrnexusjs.dev/packages/oauth
|
||||
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
|
||||
|
||||
## @wrnexus/plugin
|
||||
|
||||
- @wrnexus/plugin 0.5.1
|
||||
- @wrnexus/plugin 0.5.10
|
||||
- Documentation: https://wrnexusjs.dev/packages/plugin
|
||||
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
|
||||
|
||||
## @wrnexus/pubsub
|
||||
|
||||
- @wrnexus/pubsub 0.5.1
|
||||
- @wrnexus/pubsub 0.5.10
|
||||
- Documentation: https://wrnexusjs.dev/packages/pubsub
|
||||
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
|
||||
|
||||
## @wrnexus/queue
|
||||
|
||||
- @wrnexus/queue 0.5.1
|
||||
- @wrnexus/queue 0.5.10
|
||||
- Documentation: https://wrnexusjs.dev/packages/queue
|
||||
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
|
||||
|
||||
## @wrnexus/reactive
|
||||
|
||||
- @wrnexus/reactive 0.5.1
|
||||
- @wrnexus/reactive 0.5.10
|
||||
- Documentation: https://wrnexusjs.dev/packages/reactive
|
||||
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
|
||||
|
||||
## @wrnexus/router
|
||||
|
||||
- @wrnexus/router 0.5.1
|
||||
- @wrnexus/router 0.5.10
|
||||
- Documentation: https://wrnexusjs.dev/packages/router
|
||||
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
|
||||
|
||||
## @wrnexus/ssr
|
||||
|
||||
- @wrnexus/ssr 0.5.1
|
||||
- @wrnexus/ssr 0.5.10
|
||||
- Documentation: https://wrnexusjs.dev/packages/ssr
|
||||
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
|
||||
|
||||
## @wrnexus/styles
|
||||
|
||||
- @wrnexus/styles 0.5.1
|
||||
- @wrnexus/styles 0.5.10
|
||||
- Documentation: https://wrnexusjs.dev/packages/styles
|
||||
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
|
||||
|
||||
## @wrnexus/syntax
|
||||
|
||||
- @wrnexus/syntax 0.5.1
|
||||
- @wrnexus/syntax 0.5.10
|
||||
- Documentation: https://wrnexusjs.dev/packages/syntax
|
||||
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
|
||||
|
||||
## @wrnexus/test
|
||||
|
||||
- @wrnexus/test 0.5.1
|
||||
- @wrnexus/test 0.5.10
|
||||
- Documentation: https://wrnexusjs.dev/packages/test
|
||||
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
|
||||
|
||||
## @wrnexus/tracking
|
||||
|
||||
- @wrnexus/tracking 0.5.1
|
||||
- @wrnexus/tracking 0.5.10
|
||||
- Documentation: https://wrnexusjs.dev/packages/tracking
|
||||
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
|
||||
|
||||
## @wrnexus/ui
|
||||
|
||||
- @wrnexus/ui 0.5.1
|
||||
- @wrnexus/ui 0.5.10
|
||||
- Documentation: https://wrnexusjs.dev/packages/ui
|
||||
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
|
||||
|
||||
## @wrnexus/uploader
|
||||
|
||||
- @wrnexus/uploader 0.5.1
|
||||
- @wrnexus/uploader 0.5.10
|
||||
- Documentation: https://wrnexusjs.dev/packages/uploader
|
||||
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
|
||||
|
||||
## @wrnexus/validation
|
||||
|
||||
- @wrnexus/validation 0.5.1
|
||||
- @wrnexus/validation 0.5.10
|
||||
- Documentation: https://wrnexusjs.dev/packages/validation
|
||||
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
|
||||
|
||||
# UI component catalog
|
||||
|
||||
The installed @wrnexus/ui 0.5.1 release contains 85 documented components. The contracts below include every mount name, purpose, prop type, required/default status, slot, and event. Interactive examples live only on the dedicated component showcase.
|
||||
The installed @wrnexus/ui 0.5.10 release contains 90 documented components. The contracts below include every mount name, purpose, prop type, required/default status, slot, and event. Interactive examples live only on the dedicated component showcase.
|
||||
|
||||
### Accordion
|
||||
Showcase: https://component.wrnexusjs.dev/
|
||||
@@ -522,6 +522,24 @@ Props: size: string = "default", color: string = "info", variant: string = "soft
|
||||
Slots: none
|
||||
Events: dismiss, action
|
||||
|
||||
### AuthForm
|
||||
Showcase: https://component.wrnexusjs.dev/
|
||||
Mount: <AuthForm /> (legacy: data-component="AuthForm")
|
||||
Category: forms
|
||||
Purpose: Reusable authentication form for sign-in, registration, recovery, reset, and MFA.
|
||||
Props: size: string = "default", color: string = "primary", mode: string = "sign-in", action: string = "/api/auth/login", method: string = "post", title: string = "Sign in", description: string = "", returnTo: string = "", schema: string = "", showRemember: boolean = true, showName: boolean = true, submitLabel: string = "Continue", class: string = ""
|
||||
Slots: default
|
||||
Events: submit, change, input, focus, blur
|
||||
|
||||
### AuthSplitLayout
|
||||
Showcase: https://component.wrnexusjs.dev/
|
||||
Mount: <AuthSplitLayout /> (legacy: data-component="AuthSplitLayout")
|
||||
Category: layout
|
||||
Purpose: Responsive 50/50 authentication layout with content and form regions.
|
||||
Props: size: string = "default", color: string = "primary", eyebrow: string = "Secure identity", title: string = "Welcome back", description: string = "", brand: string = "Police Management System", features: string = [], class: string = ""
|
||||
Slots: aside-extra, form
|
||||
Events: none
|
||||
|
||||
### Avatar
|
||||
Showcase: https://component.wrnexusjs.dev/
|
||||
Mount: <Avatar /> (legacy: data-component="Avatar")
|
||||
@@ -788,9 +806,9 @@ Showcase: https://component.wrnexusjs.dev/
|
||||
Mount: <Dropdown /> (legacy: data-component="Dropdown")
|
||||
Category: overlays
|
||||
Purpose: Theme-aware, responsive dropdown component.
|
||||
Props: size: string = "default", color: string = "primary", title: string = "Dropdown", description: string = "", open: boolean = false, placement: string = "bottom", closeLabel: string = "Close", class: string = ""
|
||||
Slots: default
|
||||
Events: open, close, select, change
|
||||
Props: size: string = "default", color: string = "primary", label: string = "Open menu", items: string = [], placement: string = "end", class: string = ""
|
||||
Slots: trigger, header, footer
|
||||
Events: toggle, open, close, select
|
||||
|
||||
### FileInput
|
||||
Showcase: https://component.wrnexusjs.dev/
|
||||
@@ -819,6 +837,15 @@ Props: size: string = "default", color: string = "primary", label: string = "Pro
|
||||
Slots: none
|
||||
Events: cancel, retry, complete
|
||||
|
||||
### Footer
|
||||
Showcase: https://component.wrnexusjs.dev/
|
||||
Mount: <Footer /> (legacy: data-component="Footer")
|
||||
Category: navigation
|
||||
Purpose: Responsive application footer with structured links and pre/post content slots.
|
||||
Props: size: string = "default", color: string = "primary", label: string = "Footer navigation", items: string = [], columns: number = 3, maxWidth: string = "compact", copyright: string = "", class: string = ""
|
||||
Slots: pre-footer, post-footer, copyright-left, copyright-right
|
||||
Events: select, action
|
||||
|
||||
### Grid
|
||||
Showcase: https://component.wrnexusjs.dev/
|
||||
Mount: <Grid /> (legacy: data-component="Grid")
|
||||
@@ -968,9 +995,9 @@ Showcase: https://component.wrnexusjs.dev/
|
||||
Mount: <Navbar /> (legacy: data-component="Navbar")
|
||||
Category: navigation
|
||||
Purpose: Theme-aware, responsive navbar component.
|
||||
Props: size: string = "default", color: string = "primary", label: string = "Navbar", items: string = [], active: string = "", orientation: string = "horizontal", class: string = ""
|
||||
Slots: default
|
||||
Events: toggle, open, close
|
||||
Props: size: string = "default", color: string = "primary", label: string = "Primary navigation", topbarLabel: string = "Utility navigation", brand: string = {}, items: string = [], actions: string = [], active: string = "", sticky: boolean = false, openOnHover: boolean = false, maxWidth: string = "full", mobileLabel: string = "Toggle navigation", class: string = ""
|
||||
Slots: topbar, actions
|
||||
Events: toggle, open, close, select, action
|
||||
|
||||
### Pagination
|
||||
Showcase: https://component.wrnexusjs.dev/
|
||||
@@ -999,6 +1026,24 @@ Props: size: string = "default", color: string = "primary", title: string = "Pop
|
||||
Slots: default
|
||||
Events: open, close
|
||||
|
||||
### PortalDashboard
|
||||
Showcase: https://component.wrnexusjs.dev/
|
||||
Mount: <PortalDashboard /> (legacy: data-component="PortalDashboard")
|
||||
Category: blocks
|
||||
Purpose: Responsive portal dashboard with metrics, actions, tasks, and updates.
|
||||
Props: size: string = "default", color: string = "primary", eyebrow: string = "Overview", eyebrowKey: string = "", title: string = "Dashboard", titleKey: string = "", description: string = "", descriptionKey: string = "", userName: string = "", metrics: string = [], actions: string = [], updates: string = [], tasks: string = [], class: string = ""
|
||||
Slots: hero-action
|
||||
Events: action, navigate
|
||||
|
||||
### PreferenceSwitcher
|
||||
Showcase: https://component.wrnexusjs.dev/
|
||||
Mount: <PreferenceSwitcher /> (legacy: data-component="PreferenceSwitcher")
|
||||
Category: navigation
|
||||
Purpose: Accessible theme, accent color, and language preference controls.
|
||||
Props: size: string = "default", color: string = "primary", themeLabel: string = "Theme", colorLabel: string = "Accent color", languageLabel: string = "Language", languages: string = [, colors: string = [, compact: boolean = true, class: string = ""
|
||||
Slots: none
|
||||
Events: theme, color, language
|
||||
|
||||
### Progress
|
||||
Showcase: https://component.wrnexusjs.dev/
|
||||
Mount: <Progress /> (legacy: data-component="Progress")
|
||||
@@ -1067,9 +1112,9 @@ Showcase: https://component.wrnexusjs.dev/
|
||||
Mount: <Sidebar /> (legacy: data-component="Sidebar")
|
||||
Category: navigation
|
||||
Purpose: Theme-aware, responsive sidebar component.
|
||||
Props: size: string = "default", color: string = "primary", label: string = "Sidebar", items: string = [], active: string = "", orientation: string = "horizontal", class: string = ""
|
||||
Props: size: string = "default", color: string = "primary", label: string = "Sidebar", items: string = [], active: string = "", orientation: string = "horizontal", mobileLabel: string = "Open navigation", class: string = ""
|
||||
Slots: default
|
||||
Events: toggle, open, close
|
||||
Events: toggle, open, close, select
|
||||
|
||||
### Skeleton
|
||||
Showcase: https://component.wrnexusjs.dev/
|
||||
|
||||
Reference in New Issue
Block a user