ngx-view-builder 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +19 -131
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,131 +1,19 @@
1
- # Ngx View Builder
2
-
3
- Angular form/page builder library with builder, preview, JSON editor, runtime rendering and host API.
4
-
5
- ## Install in host app
6
-
7
- Base package:
8
-
9
- ```bash
10
- npm i ngx-view-builder
11
- ```
12
-
13
- Optional official plugins:
14
-
15
- ```bash
16
- npm i ngx-view-builder-plugin-automation ngx-view-builder-plugin-documentation ngx-view-builder-plugin-logic
17
- ```
18
-
19
- Important:
20
-
21
- - `NgxViewBuilderBuilder`, `NgxViewBuilderRuntime`, `NgxViewBuilderRenderer` and `NgxViewBuilder` are imported from `ngx-view-builder`.
22
- - optional plugin tabs do not appear automatically;
23
- - the host application must install the plugin package and register its provider.
24
-
25
- ## Typical imports
26
-
27
- Builder:
28
-
29
- ```ts
30
- import { BuilderModel, NgxViewBuilderBuilder } from 'ngx-view-builder';
31
- ```
32
-
33
- Runtime:
34
-
35
- ```ts
36
- import { NgxViewBuilderRuntime, NgxViewBuilderRenderer, NgxViewBuilderApiService } from 'ngx-view-builder';
37
- ```
38
-
39
- Optional plugins:
40
-
41
- ```ts
42
- import { provideNgxViewBuilderAutomationStudio } from 'ngx-view-builder-plugin-automation';
43
- import { provideNgxViewBuilderDocumentationGenerator } from 'ngx-view-builder-plugin-documentation';
44
- import { provideNgxViewBuilderLogicStudio } from 'ngx-view-builder-plugin-logic';
45
- ```
46
-
47
- ## Host registration example
48
-
49
- ```ts
50
- import { ApplicationConfig } from '@angular/core';
51
- import { provideNgxViewBuilderDocumentationGenerator } from 'ngx-view-builder-plugin-documentation';
52
- import { provideNgxViewBuilderAutomationStudio } from 'ngx-view-builder-plugin-automation';
53
- import { provideNgxViewBuilderLogicStudio } from 'ngx-view-builder-plugin-logic';
54
-
55
- export const appConfig: ApplicationConfig = {
56
- providers: [
57
- provideNgxViewBuilderDocumentationGenerator(),
58
- provideNgxViewBuilderAutomationStudio(),
59
- provideNgxViewBuilderLogicStudio(),
60
- ],
61
- };
62
- ```
63
-
64
- ## Builder component
65
-
66
- ```html
67
- <ngx-view-builder-builder [model]="builderModel"></ngx-view-builder-builder>
68
- ```
69
-
70
- ## Styles
71
-
72
- ```scss
73
- @import 'ngx-view-builder/styles/index.css';
74
- ```
75
-
76
- Reset styles are scoped to `.nvb-root`, so host global styles are not overridden.
77
-
78
- ## Build in this workspace
79
-
80
- ```bash
81
- npm run build:ngx-view-builder
82
- npm run build:ngx-view-builder-plugins
83
- ```
84
-
85
- Outputs:
86
-
87
- - `dist/ngx-view-builder`
88
- - `dist/ngx-view-builder-builder`
89
- - `dist/ngx-view-builder-runtime`
90
- - `dist/ngx-view-builder-plugin-automation`
91
- - `dist/ngx-view-builder-plugin-documentation`
92
- - `dist/ngx-view-builder-plugin-logic`
93
-
94
- ## Runtime API
95
-
96
- `NgxViewBuilderApiService` exposes:
97
-
98
- - value events: `onValueChanging`, `onValueChanged`
99
- - lifecycle events: `onBeforeRender`, `onRender`, `onAfterRender`
100
- - structure/data methods: `getStructure`, `setStructure`, `getData`, `setData`
101
- - validation method: `validateData(formJson, dataJson, options?)`
102
- - model access: `getElement`, `getElementProperty`, `setElementProperty`
103
- - extension registration: `registerExtensions`, `registerExtensionsAsync`
104
-
105
- ## Headless validation
106
-
107
- ```ts
108
- import { inject } from '@angular/core';
109
- import { ForgeInitializerService } from 'ngx-view-builder';
110
-
111
- inject(ForgeInitializerService).load({
112
- preloadRuntimeServices: true,
113
- exposeHeadlessValidationApi: true,
114
- headlessValidationApiKey: '__NGX_VIEW_BUILDER__',
115
- });
116
- ```
117
-
118
- ## Documentation
119
-
120
- Main product docs live in `ngx-view-builder-docs-vitepress/` (VitePress).
121
-
122
- ## License
123
-
124
- NGX View Builder is **commercial software** — see [LICENSE.md](./LICENSE.md).
125
-
126
- - A paid license key unlocks the builder without a watermark; a key covers **all versions released during your license term, perpetually** — they keep working even after the license expires.
127
- - Client work is covered, and **either side can hold the license**: an agency's key covers apps it builds for its clients, or the client buys the key and it covers the contractors developing their application. Operating a delivered application never requires a separate key.
128
- - Versions released after your license term require a renewal.
129
- - Evaluation without a key is free (the builder shows a watermark); the production runtime never shows license UI.
130
-
131
- Pricing and keys: https://ngxviewbuilder.io/pricing
1
+ # NGX View Builder
2
+
3
+ Visual builder and native runtime for complete Angular views — forms, dashboards, data tables, and guided flows defined as JSON.
4
+
5
+ ## Install
6
+
7
+ ```bash
8
+ npm i ngx-view-builder
9
+ ```
10
+
11
+ ## Documentation
12
+
13
+ Full guides, API reference, and examples: https://ngxviewbuilder.io
14
+
15
+ ## License
16
+
17
+ NGX View Builder is **commercial software** — see [LICENSE.md](./LICENSE.md). Evaluate for free (the builder shows a watermark; the production runtime never does). A paid license key covers all versions released during your license term, perpetually.
18
+
19
+ Pricing and keys: https://ngxviewbuilder.io/pricing
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ngx-view-builder",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Visual builder and native runtime for complete Angular views — forms, dashboards, data tables, and guided flows defined as JSON.",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "homepage": "https://ngxviewbuilder.io",