mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-2905] Updated JSDocs for core (#3271)
This commit is contained in:
committed by
Eugenio Romano
parent
fe0ac0e474
commit
c824e646de
@@ -2,12 +2,29 @@
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
|
||||
# Card View component
|
||||
|
||||
Displays a configurable property list renderer.
|
||||
|
||||

|
||||
|
||||
## Contents
|
||||
|
||||
- [Basic Usage](#basic-usage)
|
||||
|
||||
- [Class members](#class-members)
|
||||
|
||||
- [Properties](#properties)
|
||||
|
||||
- [Details](#details)
|
||||
|
||||
- [Editing](#editing)
|
||||
- [Defining properties](#defining-properties)
|
||||
- [Defining your custom card Item](#defining-your-custom-card-item)
|
||||
|
||||
- [See also](#see-also)
|
||||
|
||||
## Basic Usage
|
||||
|
||||
```html
|
||||
@@ -21,11 +38,11 @@ Displays a configurable property list renderer.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
| ---- | ---- | ------- | ----------- |
|
||||
| properties | [CardViewItem](#defining-properties)\[] | - | (**required**) The custom view to render |
|
||||
| editable | boolean | - | If the component editable or not |
|
||||
| displayEmpty | boolean | true | Whether to show empty properties in non-editable mode |
|
||||
| Name | Type | Default value | Description |
|
||||
| -- | -- | -- | -- |
|
||||
| displayEmpty | `boolean` | true | Toggles whether or not to show empty items in non-editable mode. |
|
||||
| editable | `boolean` | | Toggles whether or not the items can be edited. |
|
||||
| properties | `CardViewItem[]` | | (**required**) Items to show in the card view. |
|
||||
|
||||
## Details
|
||||
|
||||
@@ -145,7 +162,7 @@ const textItemProperty = new CardViewTextItemModel(options);
|
||||
| displayValue\* | string | --- | The value to render |
|
||||
| editable | boolean | false | Whether the property editable or not |
|
||||
| clickable | boolean | false | Whether the property clickable or not |
|
||||
| icon | string | The material icon to show against the clickable property |
|
||||
| icon | string | The material icon to show against the clickable property | |
|
||||
| multiline | string | false | Single or multiline text |
|
||||
| pipes | CardViewTextItemPipeProperty\[] | \[] | Pipes to be applied on the displayValue |
|
||||
|
||||
|
Reference in New Issue
Block a user