Skip to content

JSON Schema Overview

Trix Admin uses VSchema to render UI from JSON Schema, enabling declarative page development.

Core Concepts

JSON Schema defines:

  • Components - What to render (com)
  • Props - Component properties (props)
  • Data - Reactive state (data)
  • Events - User interactions (events)
  • Logic - Computed values, methods, conditions

Basic Example

json
{
  "data": { "message": "Hello World" },
  "com": "NCard",
  "props": { "title": "Welcome" },
  "children": [
    { "com": "NText", "children": "{{ message }}" }
  ]
}

Schema Structure

PropertyTypeDescription
comstringComponent name
propsobjectComponent props
childrenarray|stringChild nodes or text
dataobjectReactive data
computedobjectComputed properties
methodsobjectMethod definitions
eventsobjectEvent handlers
ifstringConditional rendering
forstringLoop rendering
modelstringTwo-way binding

Available Components

  • All NaiveUI components (NButton, NInput, NDataTable, etc.)
  • Custom components (SvgIcon, VueECharts, IconPicker, etc.)
  • HTML elements (div, span, p, etc.)

Learn More

Released under the MIT License