mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-26 17:24:56 +00:00
* fix after rebase * new release strategy for ng next Signed-off-by: eromano <eugenioromano16@gmail.com> * peer dep Signed-off-by: eromano <eugenioromano16@gmail.com> * Angular 14 fix unit test and storybook Signed-off-by: eromano <eugenioromano16@gmail.com> fix after rebase Signed-off-by: eromano <eugenioromano16@gmail.com> update pkg.json Signed-off-by: eromano <eugenioromano16@gmail.com> missing dep Signed-off-by: eromano <eugenioromano16@gmail.com> Fix mistake and missing code Dream....build only affected libs Add utility run commands * Use nx command to run affected tests * Fix nx test core fix content tests Run unit with watch false core test fixes reduce test warnings Fix process cloud unit Fix adf unit test Fix lint process cloud Disable lint next line Use right core path Fix insights unit fix linting insights Fix process-services unit fix the extensions test report fix test warnings Fix content unit Fix bunch of content unit * Produce an adf alpha of 14 * hopefully fixing the content * Push back the npm publish * Remove flaky unit * Fix linting * Make the branch as root * Get rid of angualar13 * Remove the travis depth * Fixing version for npm * Enabling cache for unit and build * Fix scss for core and paths Copy i18 and asset by using ng-packager Export the theming alias and fix path Use ng-package to copy assets process-services-cloud Use ng-package to copy assets process-services Use ng-package to copy assets content-services Use ng-package to copy assets insights * feat: fix api secondary entry point * fix storybook rebase * Move dist under dist/libs from lib/dist * Fix the webstyle * Use only necessary nrwl deps and improve lint * Fix unit for libs * Convert lint.sh to targets - improve performance * Use latest of angular * Align alfresco-js-api Signed-off-by: eromano <eugenioromano16@gmail.com> Co-authored-by: eromano <eugenioromano16@gmail.com> Co-authored-by: Mikolaj Serwicki <mikolaj.serwicki@hyland.com> Co-authored-by: Tomasz <tomasz.gnyp@hyland.com>
142 lines
5.2 KiB
Markdown
142 lines
5.2 KiB
Markdown
---
|
|
Title: Card View Update service
|
|
Added: v2.0.0
|
|
Status: Active
|
|
Last reviewed: 2018-11-14
|
|
---
|
|
|
|
# [Card View Update service](lib/core/src/lib/card-view/services/card-view-update.service.ts "Defined in card-view-update.service.ts")
|
|
|
|
Reports edits and clicks within fields of a [Card View component](../components/card-view.component.md).
|
|
|
|
## Details
|
|
|
|
You can use the [Card View Update service](card-view-update.service.md) to respond to edits and clicks within items on
|
|
a card view. This might involve updating application data to reflect the changes made to
|
|
the view or could simply be a matter of highlighting a clicked item.
|
|
|
|
The service is injected into a component using a constructor parameter, which also
|
|
creates a corresponding property in the object:
|
|
|
|
```ts
|
|
properties: any;
|
|
|
|
constructor(private cardViewUpdateService: CardViewUpdateService) {
|
|
|
|
this.properties = [
|
|
new CardViewTextItemModel({
|
|
label: 'Name',
|
|
value: 'Kirk',
|
|
key: 'name',
|
|
default: 'No name entered',
|
|
multiline: false,
|
|
editable: true,
|
|
clickable: true
|
|
}),
|
|
new CardViewTextItemModel({
|
|
label: 'Rank',
|
|
value: 'Captain',
|
|
key: 'rank',
|
|
default: 'No rank entered',
|
|
multiline: false,
|
|
editable: true,
|
|
clickable: true
|
|
}),
|
|
new CardViewTextItemModel({
|
|
label: 'Ship',
|
|
value: 'Enterprise',
|
|
key: 'ship',
|
|
default: 'No ship entered',
|
|
multiline: false,
|
|
editable: true,
|
|
clickable: true
|
|
})
|
|
];
|
|
}
|
|
```
|
|
|
|
The constructor here also sets the [`CardViewTextItemModel`](lib/core/src/lib/card-view/models/card-view-textitem.model.ts) instances that define the layout of the
|
|
card view (see the [Card View component](../components/card-view.component.md) for further information
|
|
about this). The model objects and the `key` property are used to identify which item has been clicked
|
|
or updated when an event occurs.
|
|
|
|
You must subscribe to the service to be informed about clicks and updates. You can do this by
|
|
registering your own functions with the service's `itemUpdated$` and `itemClicked$` events
|
|
(place this code in the `ngOnInit`
|
|
[lifecycle hook](https://angular.io/guide/lifecycle-hooks#oninit) rather than the constructor):
|
|
|
|
```ts
|
|
ngOnInit() {
|
|
this.cardViewUpdateService.itemUpdated$.subscribe(this.respondToCardUpdate.bind(this));
|
|
this.cardViewUpdateService.itemClicked$.subscribe(this.respondToCardClick.bind(this));
|
|
}
|
|
```
|
|
|
|
With the subscriptions in place, `respondToCardUpdate` and `respondToCardClick` will now be
|
|
called after updates and clicks, respectively.
|
|
|
|
### Responding to updates
|
|
|
|
The update function is passed a parameter of type [`UpdateNotification`](lib/core/src/lib/card-view/services/card-view-update.service.ts):
|
|
|
|
```ts
|
|
export interface UpdateNotification {
|
|
target: any;
|
|
changed: any;
|
|
}
|
|
```
|
|
|
|
Here, `target` contains the [`CardViewTextItemModel`](lib/core/src/lib/card-view/models/card-view-textitem.model.ts) that was used to initialize
|
|
the field in question (in practice, this might be a [`CardViewDateItemModel`](lib/core/src/lib/card-view/models/card-view-dateitem.model.ts) or [`CardViewMapItemModel`](lib/core/src/lib/card-view/models/card-view-mapitem.model.ts) if
|
|
the card layout includes these objects). The `changed` property contains an object with a single property:
|
|
|
|
```ts
|
|
{ keyValue: 'Value after editing' }
|
|
```
|
|
|
|
Here, `keyValue` is actually the value of the `key` field specified when the item was initialized. So
|
|
in our example, if the third item was edited from 'Enterprise' to 'Shuttle Craft', the object would be:
|
|
|
|
```ts
|
|
{ ship: 'Shuttle Craft' }
|
|
```
|
|
|
|
The complete code for `respondToCardUpdate` might look something like the following:
|
|
|
|
```ts
|
|
respondToCardUpdate(un: UpdateNotification) {
|
|
this.updateMessage = un.target.label + ' changed to ' + un.changed[un.target.key];
|
|
}
|
|
```
|
|
|
|
Note that the function will only be called if the `editable` property of the model object is set to true
|
|
for this item. Also, the `editable` value of all items will be overridden if `editable` is set to false
|
|
on the [Card View component](../components/card-view.component.md) itself.
|
|
|
|
### Responding to clicks
|
|
|
|
The click function is passed a [`ClickNotification`](lib/core/src/lib/card-view/services/card-view-update.service.ts) object, which is similar to [`UpdateNotification`](lib/core/src/lib/card-view/services/card-view-update.service.ts) described above,
|
|
but without the `changed` property. Use the `target` property to identify the item that was clicked:
|
|
|
|
```ts
|
|
respondToCardClick(cn: ClickNotification) {
|
|
this.clickMessage = cn.target.label + ' was just clicked';
|
|
}
|
|
```
|
|
|
|
Note that this function will only be called if the `clickable` property of the model object is set to true for this item.
|
|
|
|
## Update cardview update item
|
|
|
|
[`updateElement`](lib/core/src/lib/card-view/services/card-view-update.service.ts) function helps to update the card view item. It takes the [`CardViewBaseItemModel`](lib/core/src/lib/card-view/models/card-view-baseitem.model.ts) type object as parameter.
|
|
|
|
Example
|
|
|
|
```javascript
|
|
this.cardViewUpdateService.updateElement(cardViewBaseItemModel)
|
|
```
|
|
|
|
## See also
|
|
|
|
- [Card view component](../components/card-view.component.md)
|