[AAE-10767] Separate core card view logic from content-services and add documentation to reflect the changes (#7952)

This commit is contained in:
Diogo Bastos
2022-12-16 15:28:36 +00:00
committed by GitHub
parent 8d074e8b33
commit 02578dcdc5
27 changed files with 487 additions and 65 deletions

View File

@@ -0,0 +1,53 @@
---
Title: Base Card View Update Interface
Added: v6.0.0
Status: Active
Last reviewed: 2022-11-25
---
# [Base Card View Update interface](../../../lib/core/src/lib/card-view/interfaces/base-card-view-update.interface.ts "Defined in base-card-view-update.interface.ts")
Specifies required properties and methods for [Card View Update service](../../../lib/core/src/lib/card-view/services/card-view-update.service.ts).
## Basic usage
```ts
export interface BaseCardViewUpdate {
itemUpdated$: Subject<UpdateNotification>;
itemClicked$: Subject<ClickNotification>;
updateItem$: Subject<CardViewBaseItemModel>;
update(property: CardViewBaseItemModel, newValue: any);
clicked(property: CardViewBaseItemModel);
updateElement(notification: CardViewBaseItemModel);
}
```
## Properties
| Name | Type | Description |
| ---- | ---- | ----------- |
| itemUpdated$ | [`Subject`](http://reactivex.io/documentation/subject.html)`<`[`UpdateNotification`](../../../lib/core/src/lib/card-view/interfaces/update-notification.interface.ts)`>` | The current updated item. |
| itemClicked$ | [`Subject`](http://reactivex.io/documentation/subject.html)`<`[`ClickNotification`](../../../lib/core/src/lib/card-view/interfaces/click-notification.interface.ts)`>` | The current clicked item. |
| updateItem$ | [`Subject`](http://reactivex.io/documentation/subject.html)`<`[`CardViewBaseItemModel`](../../../lib/core/src/lib/card-view/models/card-view-baseitem.model.ts)`>` | The current model for the update item. |
### Methods
- **update**(property: [`CardViewBaseItemModel`](../../../lib/core/src/lib/card-view/models/card-view-baseitem.model.ts), newValue: `any`)<br/>
Update itemUpdated$ property.
- property:\_ [`CardViewBaseItemModel`](../../../lib/core/src/lib/card-view/models/card-view-baseitem.model.ts) - The property.
- newValue:\_ `any` - new value.
- **clicked**(property: [`CardViewBaseItemModel`](../../../lib/core/src/lib/card-view/models/card-view-baseitem.model.ts))<br/>
Update itemClicked$ property.
- property:\_ [`CardViewBaseItemModel`](../../../lib/core/src/lib/card-view/models/card-view-baseitem.model.ts) - The property.
- **updateElement**(notification: [`CardViewBaseItemModel`](../../../lib/core/src/lib/card-view/models/card-view-baseitem.model.ts))<br/>
Update updateItem$ observable.
- notification:\_ [`CardViewBaseItemModel`](../../../lib/core/src/lib/card-view/models/card-view-baseitem.model.ts) - The notification.
## See also
- [CardViewUpdate service](../services/card-view-update.service.md)

View File

@@ -0,0 +1,26 @@
---
Title: Click Notification Interface
Added: v6.0.0
Status: Active
Last reviewed: 2022-11-25
---
# [Click Notification Interface](../../../lib/core/src/lib/card-view/interfaces/click-notification.interface.ts "Defined in click-notification.interface.ts")
## Basic usage
```ts
export interface ClickNotification {
target: any;
}
```
## Properties
| Name | Type | Description |
| ---- | ---- | ----------- |
| target | `any` | The target for the click notification. |
## See also
- [BaseCardViewUpdate interface](../interfaces/base-card-view-update.interface.md)

View File

@@ -0,0 +1,28 @@
---
Title: Update Notification Interface
Added: v6.0.0
Status: Active
Last reviewed: 2022-11-25
---
# [Update Notification Interface](../../../lib/core/src/lib/card-view/interfaces/update-notification.interface.ts "Defined in update-notification.interface.ts")
## Basic usage
```ts
export interface UpdateNotification {
target: CardViewBaseItemModel;
changed: any;
}
```
## Properties
| Name | Type | Description |
| ---- | ---- | ----------- |
| target | [`CardViewBaseItemModel`](../../../lib/core/src/lib/card-view/models/card-view-baseitem.model.ts) | The target for the update notification. |
| changed | `any` | The changed value on the update notification. |
## See also
- [BaseCardViewUpdate interface](../interfaces/base-card-view-update.interface.md)