Introduction for developers
NGX View Builder is an Angular library with two halves:
- Builder: the visual editor your creators use to design views.
- Runtime: the engine that renders a saved view definition (JSON) to end users.
You embed one or both as standalone components, persist the JSON wherever you like, and control everything else (data, theming, custom elements, plugins) through providers and a typed API service.
The five components
| Component | Selector | Purpose |
|---|---|---|
| Builder | <ngx-view-builder-builder> | Full editing shell: canvas, sidebars, tabs, history |
| Runtime | <ngx-view-builder-runtime> | Renders a view definition with live logic and data |
| Unified | <ngx-view-builder> | Runtime-oriented host that can also take a BuilderModel |
| Renderer | <ngx-view-builder-renderer> | Low-level renderer used by the unified wrapper |
| Validator | <ngx-view-builder-validator> | Headless validation for server-side scenarios |
The flow
Creator designs in <ngx-view-builder-builder>
│ (structureChanged) → IStructure JSON
▼
Your backend / storage
│ [pageJson]
▼
<ngx-view-builder-runtime> renders to end users
│ values, events, validation
▼
Your app (via outputs and NgxViewBuilderApiService)What you can extend
| Extension | How |
|---|---|
| Custom elements (component + model + properties) | Custom elements |
| Expression functions | Custom functions |
| Extra/changed element properties | Custom properties |
| SVG icons | Icons |
| Theme tokens, light/dark palettes | Theming |
| Builder UI language | UI translations |
| Whole builder tabs | Plugins |
Reading order
- Installation: package, providers, initialization.
- Embedding the builder and Rendering views.
- API service overview: the programmatic surface.
- Extensions overview: one config object for everything custom.
