@webx-ui/schema
@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
Site settings for the WebX UI admin panel: the section that draws the settings s...
The block constructor for the WebX UI admin panel: the section where a block typ...
Pages for the WebX UI admin panel: the tree of a site's pages, their addresses,...
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 | |
| 0.8.1 | MIT | |
| 0.8.0 | MIT | |
| 0.7.4 | MIT | |
| 0.7.3 | MIT | |
| 0.7.2 | MIT | |
| 0.7.1 | MIT | |
| 0.7.0 | MIT | |
| 0.6.4 | MIT | |
| 0.6.3 | MIT | |
| 0.6.2 | MIT | |
| 0.6.1 | MIT | |
| 0.6.0 | MIT | |
| 0.5.1 | MIT | |
| 0.5.0 | MIT | |
| 0.4.0 | MIT | |
| 0.3.8 | MIT | |
| 0.3.7 | MIT | |
| 0.3.6 | MIT | |
| 0.3.5 | MIT | |
| 0.3.4 | MIT | |
| 0.3.3 | MIT | |
| 0.3.1 | MIT | |
| 0.3.0 | MIT | |
| 0.2.3 | MIT | |
| 0.2.2 | MIT |
Showing the latest 30 of 36. See every release on npm