mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-06-30 18:15:11 +00:00
[ADF-2334] Added version and status metadata to docs (#2973)
This commit is contained in:
parent
62d5dd1b30
commit
9e8fb2b6ea
@ -1,23 +1,12 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# DataTableAdapter interface
|
||||
|
||||
Defines how table data is supplied to [DataTable](datatable.component.md)
|
||||
and [Tasklist](task-list.component.md) components.
|
||||
|
||||
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
|
||||
|
||||
<!-- toc -->
|
||||
|
||||
- [Properties](#properties)
|
||||
- [Methods](#methods)
|
||||
- [Details](#details)
|
||||
* [Columns and rows](#columns-and-rows)
|
||||
* [ObjectDataTableAdapter](#objectdatatableadapter)
|
||||
- [See also](#see-also)
|
||||
|
||||
<!-- tocstop -->
|
||||
|
||||
<!-- markdown-toc end -->
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description |
|
||||
|
@ -1,9 +1,7 @@
|
||||
* * *
|
||||
|
||||
---
|
||||
Added: v2.0.0
|
||||
|
||||
## Status: Active
|
||||
|
||||
Status: Active
|
||||
---
|
||||
# Card View Update service
|
||||
|
||||
Reports edits and clicks within fields of a [Card View component](card-view.component.md).
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# Card View component
|
||||
|
||||
Displays a configurable property list renderer.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# Checklist Component
|
||||
|
||||
Shows the checklist task functionality.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# Comment list component
|
||||
|
||||
Shows a list of comments.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# Comment Process model
|
||||
|
||||
Represents a comment added to a Process Services task or process instance.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# Comment Process service
|
||||
|
||||
Adds and retrieves comments for task and process instances in Process Services.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# Comments Component
|
||||
|
||||
Displays comments from users involved in a specified task and allows an involved user to add a comment to the task.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# Content Action component
|
||||
|
||||
Adds options to a Document List actions menu for a particular content type.
|
||||
|
@ -1,22 +1,13 @@
|
||||
---
|
||||
Added: v2.1.0
|
||||
Status: Active
|
||||
---
|
||||
# Content Metadata Card component
|
||||
|
||||
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
|
||||
<!-- toc -->
|
||||
<!-- tocstop -->
|
||||
<!-- markdown-toc end -->
|
||||
|
||||
Allows a user to display and edit metadata related to a node.
|
||||
|
||||
<img src="docassets/images/ContentMetadata.png" width="325">
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| node | MinimalNodeEntryEntity | - | (**required**) The node entity to fetch metadata about |
|
||||
| displayEmpty | boolean | false | Display empty values in card view or not |
|
||||
| preset | string | "*" | The metadata preset's name, which defines aspects and their properties |
|
||||
|
||||
## Basic Usage
|
||||
|
||||
The component shows metadata related to the given node. The component uses the card view component to render the properties of metadata aspects.
|
||||
@ -30,7 +21,17 @@ The different aspects and their properties to be shown can be configured as appl
|
||||
</adf-content-metadata-card>
|
||||
```
|
||||
|
||||
## Application config presets
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| node | MinimalNodeEntryEntity | - | (**required**) The node entity to fetch metadata about |
|
||||
| displayEmpty | boolean | false | Display empty values in card view or not |
|
||||
| preset | string | "*" | The metadata preset's name, which defines aspects and their properties |
|
||||
|
||||
## Details
|
||||
|
||||
### Application config presets
|
||||
|
||||
In the application config file you can define different presets for the metadata component or override the default preset. The **default** preset is "*" if not set, meaning the component will display every aspects and properties of the nodes without filtering.
|
||||
|
||||
@ -52,7 +53,6 @@ If you don't have any preset configured manually in you application config, this
|
||||
...
|
||||
```
|
||||
|
||||
|
||||
### Aspect oriented config
|
||||
|
||||
With this type of configuration you are able to "whitelist" aspects and properties for a preset, but everything will be grouped by aspects and there is no further way to group properties. If you want to group different properties in groups you define, scroll down a bit and have a look at on the layout oriented configruration.
|
||||
@ -113,7 +113,6 @@ And finally, you can create any custom aspect following the same rules.
|
||||
|
||||
Beside the aspect oriented configuration, it is possible to configure the groups and properties in a more detailed way. With this type of configuration any property of any aspect / type can be "cherry picked"-ed and grouped into and accordion drawer, with defining a translatable title in the preset configuration.
|
||||
|
||||
|
||||
#### Basic elements
|
||||
|
||||
The following config will result in one accordion group named "TRANSLATABLE_TITLE_FOR_GROUP_1", with all the properties from the custom:aspect followed by the two properties (exif:pixelXDimension, exif:pixelYDimension) from the exif:exif aspect followed by one property (custom:myPropertyName) from custom:type.
|
||||
@ -178,7 +177,6 @@ As a more complex config, you can study the one below:
|
||||
```
|
||||
The end result of this config would be two accordion groups with the properties like this:
|
||||
|
||||
|
||||
|GROUP-TITLE1-TRANSLATION-KEY|
|
||||
|---|
|
||||
|exif:param1|
|
||||
@ -191,7 +189,6 @@ The end result of this config would be two accordion groups with the properties
|
||||
|kitten:name|
|
||||
|kitten:color|
|
||||
|
||||
|
||||
|GROUP-TITLE2-TRANSLATION-KEY|
|
||||
|---|
|
||||
|kitten:favourite-food|
|
||||
@ -200,7 +197,3 @@ The end result of this config would be two accordion groups with the properties
|
||||
## What happens when there is a whitelisted aspect in the config but the given node doesn't relate to that aspect
|
||||
|
||||
Nothing, this aspect (as it is not related to the node) will be simply ignored and not be displayed. The aspects to be displayed are calculated as an intersection of the preset's aspects and the aspects related to the node.
|
||||
|
||||
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
|
||||
<!-- seealso start -->
|
||||
<!-- seealso end -->
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
Added: v2.1.0
|
||||
Status: Active
|
||||
---
|
||||
# Content Node Dialog service
|
||||
|
||||
Displays and manages dialogs for selecting content to open, copy or upload.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
Added: v2.1.0
|
||||
Status: Active
|
||||
---
|
||||
# Content Node Selector Panel component
|
||||
|
||||
Opens a [Content Node Selector](content-node-selector.component.md) in its own dialog window.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# Content Node Selector component
|
||||
|
||||
Allows a user to select items from a Content Services repository.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# Content service
|
||||
|
||||
Accesses app-generated data objects via URLs and file downloads.
|
||||
|
@ -1,4 +1,8 @@
|
||||
# Activiti Content Component
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# APS Content Component
|
||||
|
||||
Shows the content preview.
|
||||
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# Context Menu directive
|
||||
|
||||
Adds a context menu to a component.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# Cookie service
|
||||
|
||||
Stores key-value data items as browser cookies.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# Create Process Attachment component
|
||||
|
||||
Displays Upload Component (Drag and Click) to upload the attachment to a specified process instance
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# Create Task Attachment Component
|
||||
|
||||
Displays Upload Component (Drag and Click) to upload the attachment to a specified task
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# DataColumn Component
|
||||
|
||||
Defines column properties for DataTable, Tasklist, Document List and other components.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# DataTable component
|
||||
|
||||
Displays data as a table with customizable columns and presentation.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# Deleted Nodes Api service
|
||||
|
||||
Gets a list of Content Services nodes currently in the trash.
|
||||
|
@ -1,16 +1,10 @@
|
||||
# Activiti Diagram Component
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# Diagram Component
|
||||
|
||||
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
|
||||
|
||||
<!-- toc -->
|
||||
|
||||
- [Basic Usage](#basic-usage)
|
||||
* [Properties](#properties)
|
||||
* [Events](#events)
|
||||
|
||||
<!-- tocstop -->
|
||||
|
||||
<!-- markdown-toc end -->
|
||||
Displays process diagrams.
|
||||
|
||||
## Basic Usage
|
||||
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# Discovery Api service
|
||||
|
||||
Gets version and license information for Process Services and Content Services.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# Document Actions service
|
||||
|
||||
Implements the document menu actions for the Document List component.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# Document Library model
|
||||
|
||||
Defines classes for use with the Content Services node API.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# Document List component
|
||||
|
||||
Displays the documents from a repository.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# Document List service
|
||||
|
||||
Implements node operations used by the Document List component.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# Dropdown Breadcrumb Component
|
||||
|
||||
Indicates the current position within a navigation hierarchy using a dropdown menu.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# Ecm User model
|
||||
|
||||
Contains information about a Content Services user.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# Ecm User service
|
||||
|
||||
Gets information about a Content Services user.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# Favorites Api service
|
||||
|
||||
Gets a list of items a user has marked as their favorites.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# File Draggable directive
|
||||
|
||||
Provide drag-and-drop features for an element such as a `div`.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# File Size pipe
|
||||
|
||||
Converts a number of bytes to the equivalent in KB, MB, etc.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# File Uploading Dialog Component
|
||||
|
||||
Shows a dialog listing all the files uploaded with the Upload Button or Drag Area components.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# Filter model
|
||||
|
||||
Contains classes related to filters in Process Services.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# Folder Actions service
|
||||
|
||||
Implements the folder menu actions for the Document List component.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# Folder Create directive
|
||||
|
||||
Allows folders to be created.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# Folder Edit directive
|
||||
|
||||
Allows folders to be edited.
|
||||
|
Loading…
x
Reference in New Issue
Block a user