mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2026-09-09 18:03:21 +00:00
[ACS-5645] updated the documentation
This commit is contained in:
committed by
Anukriti Singh
parent
52acd0a216
commit
5d1272b9d2
@@ -56,12 +56,6 @@ Displays and edits metadata related to a node.
|
||||
| editable | `boolean` | | (optional) This flag toggles editable of content. |
|
||||
| customPanels | [`ContentMetadataCustomPanel`](../interfaces/content-metadata-custom-panel.interface.md)`[]` | | (optional) List of custom metadata panels to be displayed as [`Dynamic components`](../../extensions/components/dynamic.component.md). |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
|----------------|-----------------------------------------------------------------------|---------------------------------------------------|
|
||||
| editableChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when content's editable state is changed. |
|
||||
|
||||
## Details
|
||||
|
||||
The component shows metadata related to a given node. It uses the
|
||||
@@ -444,3 +438,4 @@ When the list of values is too long, the options selection panel will be enhance
|
||||
## Custom metadata panels
|
||||
|
||||
If there is a need to display some custom node properties that require additional UI or data to be fetched you can define custom metadata panels for the metadata component. After creating custom component to be displayed it has to be registered in [Extension Service](../../extensions/services/extension.service.md). Both `panelTitle` and `component` properties have to be defined.
|
||||

|
||||
|
||||
@@ -98,9 +98,27 @@ Now that the `my-preset` configuration is defined, let's use it in a view of the
|
||||
</adf-content-metadata-card>
|
||||
```
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| readOnly | `boolean` | false | (optional) This flag sets the metadata in read only mode preventing changes. |
|
||||
| editable | `boolean` | | (optional) This flag toggles editable of content. |
|
||||
| editableTags | `boolean` | | (optional) This flag toggles editable of tags content. |
|
||||
| editableCategories | `boolean` | | (optional) This flag toggles editable of categories content. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
|----------------|-----------------------------------------------------------------------|---------------------------------------------------|
|
||||
| editableChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when content's editable state is changed. |
|
||||
| editableTagsChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when content's editableTags state is changed. |
|
||||
| editableCategoriesChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when content's editableCategories state is changed. |
|
||||
| groupChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when content's group state is changed. |
|
||||
|
||||
### Viewing the result
|
||||
|
||||
After saving the html file, open the ADF app in a browser and dive into the `Personal Files > Sites > swsdp` folder of the Alfresco's repository. Once there, select the `documentLibrary` folder (one click only) and click on the view details icon (the `i` on the top right). Scrolling down the metadata tab on the right, click on the `More information` item at the bottom. Once clicked, you will see two different groups: `Properties` (already there by default) and `This is my preset`. Click on `This is my preset` to show the properties related.
|
||||
After saving the html file, open the ADF app in a browser and dive into the `Personal Files > Sites > swsdp` folder of the Alfresco's repository. Once there, select the `documentLibrary` folder (one click only) and click on the view details icon (the `menu_open icon` on the top right). Scrolling down the metadata tab on the right. You will see different panels: `Properties` (already there by default), `Tags`, `Categories` and `grouped properties`.
|
||||
|
||||
In the following screenshot you can see how the result should look:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user