Skip to content

Commit 3863793

Browse files
committed
doc update
1 parent 258a4c9 commit 3863793

File tree

2 files changed

+9
-6
lines changed

2 files changed

+9
-6
lines changed

demo/angular/src/app/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,14 +41,15 @@ HTML
4141
```
4242

4343
## Demo
44-
You can see a fuller example at [app.component](https://github.com/gridstack/gridstack.js/blob/master/demo/angular/src/app/app.component.ts).
44+
You can see a fuller example at [app.component.ts](https://github.com/gridstack/gridstack.js/blob/master/demo/angular/src/app/app.component.ts)
4545

4646
to build the demo, go to demo/angular and run `yarn` + `yarn start` and Navigate to `http://localhost:4200/`
4747

4848
### Caveats
4949

5050
- This wrapper needs v7.1.2+ to run as it needs the latest changes
51-
- This wrapper handles well ngFor loops, but if you're using a trackBy function (as I would recommend) and no element id change after an update, you must manually call the `Gridstack.update()` method directly.
51+
- This wrapper handles well ngFor loops, but if you're using a trackBy function (as I would recommend) and no element id change after an update,
52+
you must manually update the `GridstackItemComponent.option` directly - see [modify()](./app.component.ts#L58) example.
5253
- The original client list of items is not updated to match **content** changes made by gridstack (TBD later), but adding new item or removing (as shown in demo) will update those new items. Client could use change/added/removed events to sync that list if they wish to do so now.
5354
- Code isn't compiled into a side lib to use right now - you need to copy those files for now. Let me know (slack) if you are using it...
5455

demo/index.html

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,15 @@ <h1>Demos</h1>
3131
<li><a href="web1.html">Website demo 1</a></li>
3232
<li><a href="web2.html">Website demo 2</a></li>
3333
</ul>
34-
<h1>Angular src Demos</h1>
35-
<p>these are complete Angular projects with multiple options. use `yarn` and `yarn start` in demo/angular sub-project to run them</p>
36-
<p>You can find the complete source at <a href="https://github.com/gridstack/gridstack.js/tree/master/demo/angular" target="_blank">Angular Demo</a></p>
34+
<h1>Angular wrapper</h1>
35+
<p>We now ship an <a href="https://github.com/gridstack/gridstack.js/tree/master/demo/angular/src/app" target="_blank">Angular component wrapper</a>
36+
to make it supper easy for that framework (Vue and React examples are above)</p>
37+
<p>These are complete Angular projects with multiple options. use `yarn` and `yarn start` in <a href="https://github.com/gridstack/gridstack.js/tree/master/demo/angular" target="_blank">demo/angular</a> sub-project to run them</p>
3738
<ol>
3839
<li><a href="angular/src/app/simple.ts">simple.ts</a></li>
3940
<li><a href="angular/src/app/ngFor.ts">ngFor.ts</a></li>
40-
<li><a href="angular/src/app/ngFor_cmd.ts">ngFor with command (not recommended)</a></li>
41+
<li><a href="angular/src/app/ngFor_cmd.ts">ngFor with command</a> (not recommended)</li>
42+
<li><a href="angular/src/app/gridstack.component.ts">gridstack.component.ts</a> (BEST)</li>
4143
</ol>
4244
<h1>Old v5.1.1 Jquery Demos</h1>
4345
Note: those are no longer supported, and use an old version of the lib to compare functionality.

0 commit comments

Comments
 (0)