@dynamic-field-kit/angular 1.2.1 → 1.2.3

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 +18 -6
  2. package/package.json +4 -2
package/README.md CHANGED
@@ -7,10 +7,12 @@ This package exposes Angular components and a convenience NgModule that integrat
7
7
  Quick overview
8
8
  - Exports `DynamicInput`, `FieldInput`, `MultiFieldInput`, layout components, and `DynamicFieldKitModule`.
9
9
  - Uses the shared `fieldRegistry` from `@dynamic-field-kit/core` to resolve Angular field renderers at runtime.
10
- - Can be consumed as a packaged library, or linked locally from `packages/angular/dist` during development.
10
+ - Can be consumed in two modes: npm package mode for external apps, or local development mode from `packages/angular/dist`.
11
11
  - `MultiFieldInput` currently supports `column`, `row`, and `grid` layout values.
12
12
 
13
- Usage (consumer Angular app)
13
+ Mode 1: npm package mode
14
+
15
+ Use this mode for normal Angular apps outside this monorepo.
14
16
 
15
17
  1. Install the packages:
16
18
 
@@ -82,8 +84,11 @@ export class AppComponent {
82
84
  }
83
85
  ```
84
86
 
85
- Local development
86
- - During local development, point your Angular app at the built package output instead of importing from `src/`:
87
+ Mode 2: local development mode
88
+
89
+ Use this mode only when developing inside this monorepo or when intentionally linking a local build.
90
+
91
+ 1. Point your Angular app at the built package output instead of importing from `src/`:
87
92
 
88
93
  ```json
89
94
  {
@@ -94,7 +99,14 @@ Local development
94
99
  }
95
100
  ```
96
101
 
97
- - When using a local `file:` dependency on Windows or via symlinked installs, set `preserveSymlinks: true` in the Angular builder options to avoid runtime issues with linked packages.
102
+ 2. Build the local Angular package before running the app:
103
+
104
+ ```bash
105
+ cd packages/angular
106
+ npm run build
107
+ ```
108
+
109
+ 3. When using a local `file:` dependency on Windows or via symlinked installs, set `preserveSymlinks: true` in the Angular builder options to avoid runtime issues with linked packages.
98
110
 
99
111
  Build & publish
100
112
  - Build locally with `ng-packagr`:
@@ -120,5 +132,5 @@ Notes & caveats
120
132
  - Supported `layout` values are `column`, `row`, and `grid`.
121
133
 
122
134
  Examples & docs
123
- - See `example/angular-instructions.md` for detailed wiring steps.
135
+ - See `example/angular-app/angular-instructions.md` for detailed wiring steps.
124
136
  - Try the local scaffold at `example/angular-app/` for a hands-on demo.
package/package.json CHANGED
@@ -1,14 +1,16 @@
1
1
  {
2
2
  "name": "@dynamic-field-kit/angular",
3
- "version": "1.2.1",
3
+ "version": "1.2.3",
4
4
  "description": "Angular renderer for dynamic-field-kit",
5
5
  "license": "MIT",
6
6
  "private": false,
7
7
  "sideEffects": false,
8
+ "main": "fesm2015/dynamic-field-kit-angular.mjs",
9
+ "types": "index.d.ts",
8
10
  "peerDependencies": {
9
11
  "@angular/common": ">=13 <22",
10
12
  "@angular/core": ">=13 <22",
11
- "@dynamic-field-kit/core": "^1.0.7"
13
+ "@dynamic-field-kit/core": "^1.0.12"
12
14
  },
13
15
  "publishConfig": {
14
16
  "access": "public"