@webx-ui/schema

Screens as JSON for WebX UI admin panels: the node format, patches, the type registry and the renderer.
11,595
Install
npm install @webx-ui/schema
Latest Version:0.9.4
Vue:3
License:MIT
Last Updated:Oct 21, 2026
Links: GitHub  ·  npm
Maintainer: ahabzig

@webx-ui/schema

Screens as JSON for WebX UI admin panels: a screen is a tree of nodes, each with a stable id and a type the registry resolves to a Vue component. A module ships the tree, a project lays a patch over it — add, remove, replace, move, set — and WxScreenRenderer draws the result with the core components.

<script setup lang="ts">
import { ref } from 'vue'
import { WxScreenRenderer } from '@webx-ui/schema'

const values = ref({ 'general.project-name': 'Acme' })
const patch = [{ op: 'set', target: 'robots', props: { rows: 16 } }]
</script>

<template>
  <wx-screen-renderer :root="screen.root" :patch="patch" v-model="values" :errors="errors" />
</template>

The package also exports the pieces on their own — applyPatch, validateScreen, validatePatch, isVisible, coreTypes — and ships schemas/screen.schema.json and schemas/patch.schema.json for editors and for the server half.

The guide: https://webx-ui.github.io/webx-ui/guide/screens.html. The design and what comes next (the screens endpoint in module-admin, module-settings) is docs/architecture/WEBX_UI_SCREENS.md in the repository.

Related Packages

@webx-ui/module-settings

Site settings for the WebX UI admin panel: the section that draws the settings s...

6,621 0
@xunserver-jsf/vue

Vue renderer for the JSON Schema form engine.

647 0
@webx-ui/module-blocks

The block constructor for the WebX UI admin panel: the section where a block typ...

10,326 0
@webx-ui/module-pages

Pages for the WebX UI admin panel: the tree of a site's pages, their addresses,...

7,462 0
@webx-ui/module-blog

Blog for the WebX UI admin panel: articles made of blocks, rubrics and tags, sch...

6,583 0

Version History

Version Released License
0.9.4 MIT
0.9.3 MIT
0.9.2 MIT
0.9.1 MIT
0.9.0 MIT