inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-12 17:04:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-2847] Added Class members headings and rebuilt prop/method tables for docs (#3240)

Browse Source 
* [ADF-2847] Added class members heading to content services docs

* [ADF-2847] Updated all prop/method tables in content services
This commit is contained in:
Andy Stark 2018-04-26 14:54:25 +01:00 committed by Eugenio Romano
parent 616036f9e7
commit 2c0e7aa035
40 changed files with 541 additions and 405 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/content-services/breadcrumb.component.md
View File

@ -19,20 +19,22 @@ Indicates the current position within a navigation hierarchy.
</adf-breadcrumb>
```
## Class members
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| folderNode | `MinimalNodeEntryEntity` | `null` | Active node, builds UI based on folderNode.path.elements collection. |
| root | `string` | `null` | (optional) Name of the root element of the breadcrumb. You can use this property to rename "Company Home" to "Personal Files" for example. You can use an i18n resource key for the property value. |
| rootId | `string` | `null` | (optional) The id of the root element. You can use this property to set a custom element the breadcrumb should start with. |
| -- | -- | -- | -- |
| folderNode | `MinimalNodeEntryEntity` | null | Active node, builds UI based on folderNode.path.elements collection. |
| root | `string` | null | (optional) Name of the root element of the breadcrumb. You can use this property to rename "Company Home" to "Personal Files" for example. You can use an i18n resource key for the property value. |
| rootId | `string` | null | (optional) The id of the root element. You can use this property to set a custom element the breadcrumb should start with. |
| target | `DocumentListComponent` | | (optional) Document List component to operate with. The list will update when the breadcrumb is clicked. |
| transform | `(node: any) => any` | | Transformation to be performed on the chosen/folder node before building the breadcrumb UI. Can be useful when custom formatting is needed for the breadcrumb. You can change the path elements from the node that are used to build the breadcrumb using this function. |
| transform | `function` | | Transformation to be performed on the chosen/folder node before building the breadcrumb UI. Can be useful when custom formatting is needed for the breadcrumb. You can change the path elements from the node that are used to build the breadcrumb using this function. |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| -- | -- | -- |
| navigate | `EventEmitter<PathElementEntity>` | Emitted when the user clicks on a breadcrumb. |
## Details

32
docs/content-services/content-action.component.md
View File

@ -2,6 +2,7 @@
Added: v2.0.0
Status: Active
---
# Content Action component
Adds options to a Document List actions menu for a particular content type.
@ -12,6 +13,8 @@ Adds options to a Document List actions menu for a particular content type.
- [Basic Usage](#basic-usage)
- [Class members](#class-members)
- [Properties](#properties)
- [Events](#events)
@ -76,26 +79,28 @@ export class MyView {
}
```
## Class members
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| title | `string` | `'Action'` | The title of the action as shown in the menu. If the title is a translation key the translation will be automatically showed. |
| icon | `string` | | The name of the icon to display next to the menu command (can be left blank). |
| handler | `string` | | System actions. Can be "delete", "download", "copy" or "move". |
| target | `string` | [ContentActionTarget.All](https://github.com/Alfresco/alfresco-ng2-components/blob/development/lib/content-services/document-list/models/content-action.model.ts) | Type of item that the action applies to. Can be one of the values provided by the enum : **All**, **Folder**, **Document** |
| permission | `string` | | The permission type. |
| -- | -- | -- | -- |
| disableWithNoPermission | `boolean` | | Should this action be disabled in the menu if the user doesn't have permission for it? |
| disabled | `boolean` | `false` | Is the menu item disabled? |
| disabled | `boolean` | false | Is the menu item disabled? |
| handler | `string` | | System actions. Can be "delete", "download", "copy" or "move". |
| icon | `string` | | The name of the icon to display next to the menu command (can be left blank). |
| permission | `string` | | The permission type. |
| target | `string` | ContentActionTarget.All | Type of item that the action appies to. Can be "document" or "folder" |
| title | `string` | "Action" | The title of the action as shown in the menu. |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| execute | `EventEmitter<{}>` | Emitted when the user selects the action from the menu. |
| permissionEvent | `EventEmitter<{}>` | Emitted when a permission error occurs |
| error | `EventEmitter<{}>` | Emitted when an error occurs during the action. Applies to copy and move actions. |
| success | `EventEmitter<{}>` | Emitted when the action succeeds with the success string message. Applies to copy, move and delete actions. |
| -- | -- | -- |
| error | `EventEmitter<Object>` | Emitted when an error occurs during the action. Applies to copy and move actions. |
| execute | `EventEmitter<Object>` | Emitted when the user selects the action from the menu. |
| permissionEvent | `EventEmitter<Object>` | Emitted when a permission error occurs |
| success | `EventEmitter<Object>` | Emitted when the action succeeds with the success string message. Applies to copy, move and delete actions. |
## Details
@ -179,7 +184,6 @@ This action simply execute one of the built-in actions described above:
If you specify a custom handler it will be executed at any click of the action:
```html
<adf-document-list [contentActions]="true"...>
<content-actions>
@ -193,7 +197,6 @@ If you specify a custom handler it will be executed at any click of the action:
</adf-document-list>
```
```ts
export class MyComponent {
@ -276,7 +279,6 @@ export class MyComponent {
![Delete show notification message](../docassets/images/content-action-notification-message.png)
#### Copy and move
These actions show the destination chooser dialog for copy and move actions. By default,

24
docs/content-services/content-metadata.component.md
View File

@ -24,13 +24,14 @@ Displays and edits metadata related to a node.
### Properties
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| node | MinimalNodeEntryEntity | - | (**required**) The node entity to fetch metadata about |
| displayEmpty | boolean | false | Toggles whether to display empty values in the card view |
| readOnly | boolean | true | Toggles whether the edit button should be shown |
| multi | boolean | false | The multi parameter of the underlying material expansion panel |
| preset | string | "*" | Name of the metadata preset, which defines aspects and their properties |
| Name | Type | Default value | Description |
| -- | -- | -- | -- |
| displayEmpty | `boolean` | false | |
| editable | `boolean` | false | |
| expanded | `boolean` | false | |
| multi | `boolean` | false | |
| node | `MinimalNodeEntryEntity` | | |
| preset | `string` | | |
## Details
@ -44,7 +45,7 @@ properties.
### Application config presets
You can define different presets for the metadata component or override the default presets in
the `app.config.json` file. The **default** preset is "*" if not set, meaning the component
the `app.config.json` file. The **default** preset is "\*" if not set, meaning the component
will display every aspect and property of a node without filtering.
You can define as many extra presets as you need for your components.
@ -89,7 +90,7 @@ just the `exif:exif` and `custom:aspect` aspects are whitelisted:
```
You can further restrict the whitelist to specific properties of one or more aspects by using
an array of property names in place of the "*" filter:
an array of property names in place of the "\*" filter:
```json
...
@ -190,10 +191,11 @@ A more complex config is shown in the example below:
]
}
```
The result of this config would be two accordion groups with the following properties:
| GROUP-TITLE1-TRANSLATION-KEY |
|---|
| ---------------------------- |
| exif:param1 |
| exif:param2 |
| ... |
@ -205,7 +207,7 @@ The result of this config would be two accordion groups with the following prope
| kitten:color |
| GROUP-TITLE2-TRANSLATION-KEY |
|---|
| ---------------------------- |
| kitten:favourite-food |
| kitten:recommended-food |

80
docs/content-services/content-node-dialog.service.md
View File

@ -8,43 +8,57 @@ Last reviewed: 2018-03-13
Displays and manages dialogs for selecting content to open, copy or upload.
## Methods
## Class members
- `openLockNodeDialog(nodeEntry: MinimalNodeEntryEntity): Observable<string>`
Opens a dialog to lock or unlock file
- `nodeEntry` - Item to lock or unlock.
- `openFileBrowseDialogByFolderId(folderNodeId: string): Observable<MinimalNodeEntryEntity[]>`
Opens a file browser at a chosen folder location.
- `folderNodeId` - ID of the folder to use
- `openFileBrowseDialogBySite(): Observable<MinimalNodeEntryEntity[]>`
Opens a file browser at a chosen site location.
### Methods
- `openFolderBrowseDialogBySite(): Observable<MinimalNodeEntryEntity[]>`
Opens a folder browser at a chosen site location.
- `openFolderBrowseDialogByFolderId(folderNodeId: string): Observable<MinimalNodeEntryEntity[]>`
Opens a folder browser at a chosen folder location.
- `folderNodeId` - ID of the folder to use
- `openCopyMoveDialog(action: string, contentEntry: MinimalNodeEntryEntity, permission?: string): Observable<MinimalNodeEntryEntity[]>`
Opens a dialog to copy or move an item to a new location.
- `action` - Name of the action (eg, "Copy" or "Move") to show in the title
- `contentEntry` - Item to be copied or moved
- `permission` - (Optional) Permission for the operation
- `getTitleTranslation(action: string, name: string): string`
Gets the translation of the dialog title.
- `action` - Name of the action to display in the dialog title
- `name` - Name of the item on which the action is being performed
- `openUploadFolderDialog(action: string, contentEntry: MinimalNodeEntryEntity): Observable<MinimalNodeEntryEntity[]>`
Opens a dialog to choose a folder to upload.
- `action` - Name of the action to show in the title
- `contentEntry` - Item to upload
- `openUploadFileDialog(action: string, contentEntry: MinimalNodeEntryEntity): Observable<MinimalNodeEntryEntity[]>`
Opens a dialog to choose a file to upload.
- `action` - Name of the action to show in the title
- `contentEntry` - Item to upload
- `close()`
- `close()`<br/>
Closes the currently open dialog.
- `getTitleTranslation(action: string = null, name: string = null): string`<br/>
- `action: string = null` -
- `name: string = null` - Name of the item on which the action is being performed
- **Returns** `string` -
- `openCopyMoveDialog(action: string = null, contentEntry: MinimalNodeEntryEntity = null, permission?: string = null): Observable<MinimalNodeEntryEntity[]>`<br/>
- `action: string = null` -
- `contentEntry: MinimalNodeEntryEntity = null` -
- `permission?: string = null` - (Optional) Permission for the operation
- **Returns** `Observable<MinimalNodeEntryEntity[]>` -
- `openFileBrowseDialogByFolderId(folderNodeId: string = null): Observable<MinimalNodeEntryEntity[]>`<br/>
- `folderNodeId: string = null` - ID of the folder to use
- **Returns** `Observable<MinimalNodeEntryEntity[]>` -
- `openFileBrowseDialogBySite(): Observable<MinimalNodeEntryEntity[]>`<br/>
Opens a file browser at a chosen site location.
- **Returns** `Observable<MinimalNodeEntryEntity[]>` -
- `openFolderBrowseDialogByFolderId(folderNodeId: string = null): Observable<MinimalNodeEntryEntity[]>`<br/>
- `folderNodeId: string = null` - ID of the folder to use
- **Returns** `Observable<MinimalNodeEntryEntity[]>` -
- `openFolderBrowseDialogBySite(): Observable<MinimalNodeEntryEntity[]>`<br/>
Opens a folder browser at a chosen site location.
- **Returns** `Observable<MinimalNodeEntryEntity[]>` -
- `openLockNodeDialog(contentEntry: MinimalNodeEntryEntity = null): Subject<string>`<br/>
Opens a lock node dialog
- `contentEntry: MinimalNodeEntryEntity = null` - Node to lock
- **Returns** `Subject<string>` -
- `openUploadFileDialog(action: string = null, contentEntry: MinimalNodeEntryEntity = null): Observable<MinimalNodeEntryEntity[]>`<br/>
- `action: string = null` -
- `contentEntry: MinimalNodeEntryEntity = null` - Item to upload
- **Returns** `Observable<MinimalNodeEntryEntity[]>` -
- `openUploadFolderDialog(action: string = null, contentEntry: MinimalNodeEntryEntity = null): Observable<MinimalNodeEntryEntity[]>`<br/>
- `action: string = null` -
- `contentEntry: MinimalNodeEntryEntity = null` - Item to upload
- **Returns** `Observable<MinimalNodeEntryEntity[]>` -
## Details

20
docs/content-services/content-node-selector-panel.component.md
View File

@ -23,23 +23,25 @@ Opens a Content Node Selector in its own dialog window.
</adf-content-node-selector-panel>
```
## Class members
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| currentFolderId | `string` | `null` | Node ID of the folder currently listed. |
| dropdownHideMyFiles | `boolean` | `false` | Hide the "My Files" option added to the site list by default. See the [Sites Dropdown component](sites-dropdown.component.md) for more information. |
| dropdownSiteList | `SitePaging` | `null` | Custom site for site dropdown same as siteList. See the [Sites Dropdown component](sites-dropdown.component.md) for more information. |
| rowFilter | `RowFilter` | `null` | Custom row filter function. See the [Document List component](document-list.component.md#custom-row-filter) for more information. |
| imageResolver | `ImageResolver` | `null` | Custom image resolver function. See the [Document List component](document-list.component.md#custom-row-filter) for more information. |
| -- | -- | -- | -- |
| breadcrumbTransform | `function` | | Transformation to be performed on the chosen/folder node before building the breadcrumb UI. Can be useful when custom formatting is needed for the breadcrumb. You can change the path elements from the node that are used to build the breadcrumb using this function. |
| currentFolderId | `string` | null | Node ID of the folder currently listed. |
| dropdownHideMyFiles | `boolean` | false | Hide the "My Files" option added to the site list by default. See the [Sites Dropdown component](sites-dropdown.component.md) for more information. |
| dropdownSiteList | `SitePaging` | null | Custom site for site dropdown same as siteList. See the [Sites Dropdown component](sites-dropdown.component.md) for more information. |
| imageResolver | `ImageResolver` | null | Custom image resolver function. See the [Document List component](document-list.component.md#custom-row-filter) for more information. |
| isSelectionValid | `ValidationFunction` | defaultValidation | Function used to decide if the selected node has permission to be selected. Default value is a function that always returns true. |
| pageSize | `number` | | Number of items shown per page in the list. |
| isSelectionValid | `ValidationFunction` | `defaultValidation` | Function used to decide if the selected node has permission to be selected. Default value is a function that always returns true. |
| breadcrumbTransform | `(node: any) => any` | | Transformation to be performed on the chosen/folder node before building the breadcrumb UI. Can be useful when custom formatting is needed for the breadcrumb. You can change the path elements from the node that are used to build the breadcrumb using this function. |
| rowFilter | `RowFilter` | null | Custom row filter function. See the [Document List component](document-list.component.md#custom-row-filter) for more information. |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| -- | -- | -- |
| select | `EventEmitter<MinimalNodeEntryEntity[]>` | Emitted when the user has chosen an item. |
## Details

31
docs/content-services/content-node-selector.component.md
View File

@ -10,19 +10,34 @@ Allows a user to select items from a Content Services repository.
![Content Node Selector screenshot](../docassets/images/ContentNodeSelector.png)
## Contents
- [Class members](#class-members)
- [Properties](#properties)
- [Details](#details)
- [Showing the dialog](#showing-the-dialog)
- [Usage example](#usage-example)
- [RowFilter and ImageResolver](#rowfilter-and-imageresolver)
- [Using the breadcrumbTransform function](#using-the-breadcrumbtransform-function)
- [See also](#see-also)
## Class members
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| currentFolderId | `string` | null | Deprecated: in 2.1.0 |
| dropdownHideMyFiles | `boolean` | false | Deprecated: in 2.1.0 |
| dropdownSiteList | `SitePaging` | null | Deprecated: in 2.1.0 |
| imageResolver | `ImageResolver` | null | Deprecated: in 2.1.0 |
| pageSize | `number` | | Deprecated: in 2.1.0 |
| rowFilter | `RowFilter` | null | Deprecated: in 2.1.0 |
| title | `string` | null | Deprecated: in 2.1.0 |
| -- | -- | -- | -- |
| currentFolderId | `string` | null | **Deprecated:** in 2.1.0 |
| dropdownHideMyFiles | `boolean` | false | **Deprecated:** in 2.1.0 |
| dropdownSiteList | `SitePaging` | null | **Deprecated:** in 2.1.0 |
| imageResolver | `ImageResolver` | null | **Deprecated:** in 2.1.0 |
| pageSize | `number` | | **Deprecated:** in 2.1.0 |
| rowFilter | `RowFilter` | null | **Deprecated:** in 2.1.0 |
| title | `string` | null | **Deprecated:** in 2.1.0 |
## Details

94
docs/content-services/custom-resources.service.md
View File

@ -12,49 +12,57 @@ Manages Document List information that is specific to a user.
### Methods
- `getRecentFiles(personId: string, pagination: PaginationModel): Observable<NodePaging>`<br/>
Gets files recently accessed by a user.
- `personId: string` - ID of the user
- `pagination: PaginationModel` - Specifies how to paginate the results
- **Returns** `Observable<NodePaging>` - List of nodes for the recently used files
- `loadFavorites(pagination: PaginationModel, includeFields: string[] = []): Observable<NodePaging>`<br/>
Gets favorite files for the current user.
- `pagination: PaginationModel` - Specifies how to paginate the results
- `includeFields: string[] = []` - List of data field names to include in the results
- **Returns** `Observable<NodePaging>` - List of favorite files
- `loadMemberSites(pagination: PaginationModel): Observable<NodePaging>`<br/>
Gets sites that the current user is a member of.
- `pagination: PaginationModel` - Specifies how to paginate the results
- **Returns** `Observable<NodePaging>` - List of sites
- `loadSites(pagination: PaginationModel): Observable<NodePaging>`<br/>
Gets all sites in the respository.
- `pagination: PaginationModel` - Specifies how to paginate the results
- **Returns** `Observable<NodePaging>` - List of sites
- `loadTrashcan(pagination: PaginationModel, includeFields: string[] = []): Observable<DeletedNodesPaging>`<br/>
Gets all items currently in the trash.
- `pagination: PaginationModel` - Specifies how to paginate the results
- `includeFields: string[] = []` - List of data field names to include in the results
- **Returns** `Observable<DeletedNodesPaging>` - List of deleted items
- `loadSharedLinks(pagination: PaginationModel, includeFields: string[] = []): Observable<NodePaging>`<br/>
Gets shared links for the current user.
- `pagination: PaginationModel` - Specifies how to paginate the results
- `includeFields: string[] = []` - List of data field names to include in the results
- **Returns** `Observable<NodePaging>` - List of shared links
- `isCustomSource(folderId: string): boolean`<br/>
Is the folder ID one of the well-known aliases?
- `FolderId` - Folder ID name to check
- **Returns** `Observable<NodePaging>` - True if the ID is a well-known name, false otherwise
- `loadFolderByNodeId(nodeId: string, pagination: PaginationModel, includeFields: string[]): Observable<NodePaging>`<br/>
Gets a folder's contents.
- `nodeId: string` - ID of the target folder node
- `pagination: PaginationModel` - Specifies how to paginate the results
- `includeFields: string[] = []` - List of data field names to include in the results
- **Returns** `Observable<NodePaging>` - List of items contained in the folder
- `getCorrespondingNodeIds(nodeId: string, pagination: PaginationModel): Observable<string[]>`<br/>
Gets the contents of one of the well-known aliases in the form of node ID strings.
- `nodeId: string` - ID of the target folder node
- `pagination: PaginationModel` - Specifies how to paginate the results
- **Returns** `Observable<string[]>` - List of node IDs
- `getCorrespondingNodeIds(nodeId: string = null, pagination: PaginationModel = null): Observable<string[]>`<br/>
- `nodeId: string = null` -
- `pagination: PaginationModel = null` -
- **Returns** `Observable<string[]>` -
- `getRecentFiles(personId: string = null, pagination: PaginationModel = null): Observable<NodePaging>`<br/>
- `personId: string = null` -
- `pagination: PaginationModel = null` -
- **Returns** `Observable<NodePaging>` -
- `isCustomSource(folderId: string = null): boolean`<br/>
- `folderId: string = null` -
- **Returns** `boolean` -
- `loadFavorites(pagination: PaginationModel = null, includeFields: string[] = []): Observable<NodePaging>`<br/>
- `pagination: PaginationModel = null` -
- `includeFields: string[] = []` -
- **Returns** `Observable<NodePaging>` -
- `loadFolderByNodeId(nodeId: string = null, pagination: PaginationModel = null, includeFields: string[] = null): Observable<NodePaging>`<br/>
- `nodeId: string = null` -
- `pagination: PaginationModel = null` -
- `includeFields: string[] = null` -
- **Returns** `Observable<NodePaging>` -
- `loadMemberSites(pagination: PaginationModel = null): Observable<NodePaging>`<br/>
- `pagination: PaginationModel = null` -
- **Returns** `Observable<NodePaging>` -
- `loadSharedLinks(pagination: PaginationModel = null, includeFields: string[] = []): Observable<NodePaging>`<br/>
- `pagination: PaginationModel = null` -
- `includeFields: string[] = []` -
- **Returns** `Observable<NodePaging>` -
- `loadSites(pagination: PaginationModel = null): Observable<NodePaging>`<br/>
- `pagination: PaginationModel = null` -
- **Returns** `Observable<NodePaging>` -
- `loadTrashcan(pagination: PaginationModel = null, includeFields: string[] = []): Observable<DeletedNodesPaging>`<br/>
- `pagination: PaginationModel = null` -
- `includeFields: string[] = []` -
- **Returns** `Observable<DeletedNodesPaging>` -
## Details

3
docs/content-services/document-library.model.md
View File

@ -2,6 +2,7 @@
Added: v2.0.0
Status: Active
---
# Document Library model
Defines classes for use with the Content Services node API.
@ -109,7 +110,9 @@ class PathElementEntity {
```
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
## See also
- [Document list component](document-list.component.md)

69
docs/content-services/document-list.component.md
View File

@ -14,12 +14,15 @@ Displays the documents from a repository.
- [Basic Usage](#basic-usage)
- [Class members](#class-members)
- [Properties](#properties)
- [Events](#events)
- [Details](#details)
- [DOM Events](#dom-events)
- [Conditional visibility](#conditional-visibility)
- [Card view](#card-view)
- [Pagination strategy](#pagination-strategy)
- [Data Sources](#data-sources)
@ -52,48 +55,50 @@ Displays the documents from a repository.
</adf-document-list>
```
## Class members
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| display | `string` | `DisplayMode.List` | Change the display mode of the table. Can be "list" or "gallery". |
| permissionsStyle | `PermissionStyleModel[]` | `[]` | Define a set of CSS styles styles to apply depending on the permission of the user on that node. See the Permission Style model page for further details and examples. |
| locationFormat | `string` | `'/'` | The default route for all the location-based columns (if declared). |
| navigate | `boolean` | `true` | Toggles navigation to folder content or file preview |
| showHeader | `boolean` | `true` | Toggles the header |
| navigationMode | `string` | See description | User interaction for folder navigation or file preview. Valid values are "click" and "dblclick". Default value: "dblclick" |
| thumbnails | `boolean` | `false` | Show document thumbnails rather than icons |
| selectionMode | `string` | `'single'` | Row selection mode. Can be null, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. |
| multiselect | `boolean` | `false` | Toggles multiselect mode |
| contentActions | `boolean` | `false` | Toggles content actions for each row |
| contentActionsPosition | `string` | `'right'` | Position of the content actions dropdown menu. Can be set to "left" or "right". |
| contextMenuActions | `boolean` | `false` | Toggles context menus for each row |
| emptyFolderImageUrl | `string` | See description | Custom image for empty folder. Default value: './assets/images/empty_doc_lib.svg' |
| allowDropFiles | `boolean` | `false` | Toggle file drop support for rows (see Upload Directive for further details |
| sorting | `string[]` | | Defines default sorting. The format is an array of 2 strings `[key, direction]` i.e. `['name', 'desc']` or `['name', 'asc']`. Set this value only if you want to override the default sorting detected by the component based on columns. |
| -- | -- | -- | -- |
| allowDropFiles | `boolean` | false | Toggle file drop support for rows (see Upload Directive for further details |
| contentActions | `boolean` | false | Toggles content actions for each row |
| contentActionsPosition | `string` | "right" | Position of the content actions dropdown menu. Can be set to "left" or "right". |
| contextMenuActions | `boolean` | false | Toggles context menus for each row |
| currentFolderId | `string` | null | The ID of the folder node to display or a reserved string alias for special sources |
| display | `string` | DisplayMode.List | Change the display mode of the table. Can be "list" or "gallery". |
| emptyFolderImageUrl | `string` | "./assets/images/empty_doc_lib.svg" | Custom image for empty folder. Default value: './assets/images/empty_doc_lib.svg' |
| enableInfiniteScrolling | `boolean` | false | Set document list to work in infinite scrolling mode |
| folderNode | `MinimalNodeEntryEntity` | null | Currently displayed folder node |
| imageResolver | `any | null` | null | Custom image resolver |
| includeFields | `string[]` | | Include additional information about the node in the server request.for example: association, isLink, isLocked and others. |
| loading | `boolean` | false | Toggles the loading state and animated spinners for the component. Used in combination with `navigate=false` to perform custom navigation and loading state indication. |
| locationFormat | `string` | "/" | The default route for all the location-based columns (if declared). |
| maxItems | `number` | | Default value is stored into user preference settings use it only if you are not using the pagination |
| multiselect | `boolean` | false | Toggles multiselect mode |
| navigate | `boolean` | true | Toggles navigation to folder content or file preview |
| navigationMode | `string` | DocumentListComponent.DOUBLE_CLICK_NAVIGATION | User interaction for folder navigation or file preview. Valid values are "click" and "dblclick". Default value: "dblclick" |
| node | `NodePaging` | null | The Document list will show all the nodes contained in the NodePaging entity |
| permissionsStyle | `PermissionStyleModel[]` | \[] | Define a set of CSS styles styles to apply depending on the permission of the user on that node. See the Permission Style model page for further details and examples. |
| rowFilter | `any | null` | null | Custom row filter |
| rowStyle | `string` | | The inline style to apply to every row. See the Angular NgStyle docs for more details and usage examples. |
| rowStyleClass | `string` | | The CSS class to apply to every row |
| loading | `boolean` | `false` | Toggles the loading state and animated spinners for the component. Used in combination with `navigate=false` to perform custom navigation and loading state indication. |
| rowFilter | `any` | `null` | Custom row filter |
| imageResolver | `any` | `null` | Custom image resolver |
| currentFolderId | `string` | `null` | The ID of the folder node to display or a reserved string alias for special sources |
| folderNode | `MinimalNodeEntryEntity` | `null` | Currently displayed folder node |
| node | `NodePaging` | `null` | The Document list will show all the nodes contained in the NodePaging entity |
| maxItems | `number` | | Default value is stored into user preference settings |
| skipCount | `number` | `0` | Number of elements to skip over for pagination purposes |
| enableInfiniteScrolling | `boolean` | `false` | Set document list to work in infinite scrolling mode |
| includeFields | `string[]` | `[]` | Include additional information about the node in the server request.for example: association, isLink, isLocked and others. |
| selectionMode | `string` | "single" | Row selection mode. Can be null, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. |
| showHeader | `boolean` | true | Toggles the header |
| skipCount | `number` | 0 | Number of elements to skip over for pagination purposes |
| sorting | `string[]` | | Defines default sorting. The format is an array of 2 strings `[key, direction]` i.e. `['name', 'desc']` or `['name', 'asc']`. Set this value only if you want to override the default sorting detected by the component based on columns. |
| thumbnails | `boolean` | false | Show document thumbnails rather than icons |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| -- | -- | -- |
| error | `EventEmitter<any>` | Emitted when the API fails to get the Document List data |
| folderChange | `EventEmitter<NodeEntryEvent>` | Emitted when the current display folder changes |
| nodeClick | `EventEmitter<NodeEntityEvent>` | Emitted when the user clicks a list node |
| nodeDblClick | `EventEmitter<NodeEntityEvent>` | Emitted when the user double-clicks a list node |
| folderChange | `EventEmitter<NodeEntryEvent>` | Emitted when the current display folder changes |
| preview | `EventEmitter<NodeEntityEvent>` | Emitted when the user acts upon files with either single or double click (depends on `navigation-mode`). Useful for integration with the Viewer component. |
| ready | `EventEmitter<NodePaging>` | Emitted when the Document List has loaded all items and is ready for use |
| error | `EventEmitter<any>` | Emitted when the API fails to get the Document List data |
## Details
@ -104,7 +109,7 @@ best.
### DOM Events
Below are the DOM events the DocumentList component emits.
All of them are *bubbling*, meaning you can handle them in any component up the parent hierarchy, even if the DocumentList is wrapped by one or more other components.
All of them are _bubbling_, meaning you can handle them in any component up the parent hierarchy, even if the DocumentList is wrapped by one or more other components.
| Name | Description |
| ---- | ----------- |
@ -169,8 +174,6 @@ Set the `[display]` property to "gallery" to enable card view mode:
</adf-document-list>
```
### Pagination strategy
The Document List by default supports 2 types of pagination: **finite** and **infinite**:
@ -453,7 +456,7 @@ documentation for a full explanation of the component lifecycle.
### Underlying node object
The Document List component assigns an instance of
[MinimalNode](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/MinimalNode.md]
[MinimalNode]\(<https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/MinimalNode.md>]
(defined in the [Alfresco JS API](https://github.com/Alfresco/alfresco-js-api)) as the data context
for each row. You can make use of the properties of this object when defining custom columns:

23
docs/content-services/document-list.service.md
View File

@ -12,11 +12,11 @@ Implements node operations used by the Document List component.
### Methods
- `copyNode(nodeId: string = null, targetParentId: string = null): any`<br/>
- `copyNode(nodeId: string = null, targetParentId: string = null): Observable<any>`<br/>
Copy a node to destination node
- `nodeId: string = null` - The id of the node to be copied
- `targetParentId: string = null` - The id of the folder where the node will be copied
- **Returns** `any` - NodeEntry for the copied node
- **Returns** `Observable<any>` - NodeEntry for the copied node
- `createFolder(name: string = null, parentId: string = null): Observable<MinimalNodeEntity>`<br/>
Create a new folder in the path.
- `name: string = null` - Folder name
@ -39,25 +39,32 @@ Implements node operations used by the Document List component.
- `opts?: any = null` - (Optional) Options.
- `includeFields: string[] = []` - Extra information to include (available options are "aspectNames", "isLink" and "association")
- **Returns** `Observable<NodePaging>` - Details of the folder
- `getFolderNode(nodeId: string = null, includeFields: string[] = []): Promise<MinimalNodeEntryEntity>`<br/>
Gets a folder node via its node ID.
- `getFolderNode(nodeId: string = null, includeFields: string[] = []): Observable<MinimalNodeEntryEntity>`<br/>
- `nodeId: string = null` - ID of the folder node
- `includeFields: string[] = []` - Extra information to include (available options are "aspectNames", "isLink" and "association")
- **Returns** `Promise<MinimalNodeEntryEntity>` - Details of the folder
- **Returns** `Observable<MinimalNodeEntryEntity>` - Details of the folder
- `getMimeTypeIcon(mimeType: string = null): string`<br/>
Gets the icon that represents a MIME type.
- `mimeType: string = null` - MIME type to get the icon for
- **Returns** `string` - Path to the icon file
- `getNode(nodeId: string = null, includeFields: string[] = []): Observable<NodeEntry>`<br/>
Gets a node via its node ID.
- `nodeId: string = null` -
- `includeFields: string[] = []` - Extra information to include (available options are "aspectNames", "isLink" and "association")
- **Returns** `Observable<NodeEntry>` - Details of the folder
- `hasPermission(node: any = null, permission: PermissionsEnum | string = null): boolean`<br/>
Checks if a node has the specified permission.
- `node: any = null` - Target node
- `permission: PermissionsEnum | string = null` - Permission level to query
- **Returns** `boolean` - True if the node has the permission, false otherwise
- `moveNode(nodeId: string = null, targetParentId: string = null): any`<br/>
- `moveNode(nodeId: string = null, targetParentId: string = null): Observable<any>`<br/>
Move a node to destination node
- `nodeId: string = null` - The id of the node to be moved
- `targetParentId: string = null` - The id of the folder where the node will be moved
- **Returns** `any` - NodeEntry for the moved node
- **Returns** `Observable<any>` - NodeEntry for the moved node
## Details

14
docs/content-services/dropdown-breadcrumb.component.md
View File

@ -2,6 +2,7 @@
Added: v2.0.0
Status: Active
---
# Dropdown Breadcrumb Component
Indicates the current position within a navigation hierarchy using a dropdown menu.
@ -17,19 +18,22 @@ Indicates the current position within a navigation hierarchy using a dropdown me
</adf-dropdown-breadcrumb>
```
## Class members
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| folderNode | `MinimalNodeEntryEntity` | `null` | Active node, builds UI based on folderNode.path.elements collection. |
| root | `string` | `null` | (optional) Name of the root element of the breadcrumb. You can use this property to rename "Company Home" to "Personal Files" for example. You can use an i18n resource key for the property value. |
| rootId | `string` | `null` | (optional) The id of the root element. You can use this property to set a custom element the breadcrumb should start with. |
| -- | -- | -- | -- |
| folderNode | `MinimalNodeEntryEntity` | null | Active node, builds UI based on folderNode.path.elements collection. |
| root | `string` | null | (optional) Name of the root element of the breadcrumb. You can use this property to rename "Company Home" to "Personal Files" for example. You can use an i18n resource key for the property value. |
| rootId | `string` | null | (optional) The id of the root element. You can use this property to set a custom element the breadcrumb should start with. |
| target | `DocumentListComponent` | | (optional) Document List component to operate with. The list will update when the breadcrumb is clicked. |
| transform | `function` | | Transformation to be performed on the chosen/folder node before building the breadcrumb UI. Can be useful when custom formatting is needed for the breadcrumb. You can change the path elements from the node that are used to build the breadcrumb using this function. |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| -- | -- | -- |
| navigate | `EventEmitter<PathElementEntity>` | Emitted when the user clicks on a breadcrumb. |
## See also

11
docs/content-services/file-uploading-dialog.component.md
View File

@ -2,6 +2,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.
@ -12,17 +13,19 @@ Shows a dialog listing all the files uploaded with the Upload Button or Drag Are
<adf-file-uploading-dialog></adf-file-uploading-dialog>
```
## Class members
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| position | `string` | `'right'` | Dialog position. Can be 'left' or 'right'. |
| -- | -- | -- | -- |
| position | `string` | "right" | Dialog position. Can be 'left' or 'right'. |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| error | `EventEmitter<any>` | Emitted when a file upload goes in error |
| -- | -- | -- |
| error | `EventEmitter<any>` | Emitted when a file in the list has an error. |
## Details

8
docs/content-services/folder-create.directive.md
View File

@ -31,16 +31,16 @@ Creates folders.
| Name | Type | Default value | Description |
| -- | -- | -- | -- |
| nodeType | `string` | "cm:folder" | |
| adf-create-folder | `string` | DEFAULT_FOLDER_PARENT_ID | Parent folder where the new folder will be located after creation. |
| title | `string` | null | The title of the opened dialog. |
| nodeType | `string` | 'cm:folder' | The type of the node to be created. |
| title | `string` | null | |
### Events
| Name | Type | Description |
| -- | -- | -- |
| error | `EventEmitter<any>` | Emitted when an error occurs (for example a folder with same name already exists) |
| success | `EventEmitter<MinimalNodeEntryEntity>` | Emitted when the creation successfully happened |
| error | `EventEmitter<any>` | Emitted when the create folder give error for example a folder with same name already exist |
| success | `EventEmitter<MinimalNodeEntryEntity>` | |
## Details

6
docs/content-services/folder-edit.directive.md
View File

@ -32,14 +32,14 @@ Allows folders to be edited.
| Name | Type | Default value | Description |
| -- | -- | -- | -- |
| adf-edit-folder | `MinimalNodeEntryEntity` | | Folder node to edit. |
| title | `string` | null | The title of the opened dialog. |
| title | `string` | null | |
### Events
| Name | Type | Description |
| -- | -- | -- |
| error | `EventEmitter<any>` | Emitted when an error occurs (for example a folder with same name already exists) |
| success | `EventEmitter<MinimalNodeEntryEntity>` | Emitted when the edition successfully happened |
| error | `EventEmitter<any>` | Emitted when the edit/create folder give error for example a folder with same name already exist |
| success | `EventEmitter<MinimalNodeEntryEntity>` | |
## Details

4
docs/content-services/inherited-button.directive.md
View File

@ -2,6 +2,7 @@
Added: v2.3.0
Status: Active
---
# Inherit Permission directive
Update the current node by adding/removing the inherited permissions.
@ -15,6 +16,8 @@ Update the current node by adding/removing the inherited permissions.
(updated)="onUpdatedPermissions($node)">PERMISSION</button>
```
## Class members
### Properties
| Name | Type | Default value | Description |
@ -28,5 +31,6 @@ Update the current node by adding/removing the inherited permissions.
| updated | `EventEmitter<MinimalNodeEntryEntity>` | Emitted when the node is updated. |
## Details
This directive switches on/off the inheritance on the permission based on what is set on the node entity.
So if the node has inherited permissions, this will remove them viceversa if the node does not have the inherited permission this will add them.

9
docs/content-services/like.component.md
View File

@ -2,6 +2,7 @@
Added: v2.0.0
Status: Active
---
# Like component
Allows a user to add "likes" to an item.
@ -14,17 +15,19 @@ Allows a user to add "likes" to an item.
<adf-like [nodeId]="nodeId"></adf-like>
```
## Class members
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| -- | -- | -- | -- |
| nodeId | `string` | | Identifier of a node to apply likes to. |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| changeVote | `EventEmitter<{}>` | Emitted when the "vote" gets changed. |
| -- | -- | -- |
| changeVote | `EventEmitter<Object>` | Emitted when the "vote" gets changed. |
## See also

18
docs/content-services/node-lock.directive.md
View File

@ -8,12 +8,6 @@ Last reviewed: 2018-04-10
Locks a node.
When the directive is clicked a dialog is shown and you can lock or unlock a file (folder cannot be locked)
there are two types of lock: indefinite lock and time lock.
If the time is not selected the user will lock the file it until will not unlock it
When a file is locked it can be locked and unlocked by default only by the user that creates the lock but you can also allow the other file owners to modify it
![adf-lock](../docassets/images/lock-directive.png)
## Basic Usage
```html
@ -22,14 +16,22 @@ When a file is locked it can be locked and unlocked by default only by the user
</button>
```
## Class members
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| adf-node-lock | `MinimalNodeEntryEntity` | | Node to lock. |
| -- | -- | -- | -- |
| adf-node-lock | `MinimalNodeEntryEntity` | | |
## Details
When the directive is clicked a dialog is shown and you can lock or unlock a file (folder cannot be locked)
there are two types of lock: indefinite lock and time lock.
If the time is not selected the user will lock the file it until will not unlock it
When a file is locked it can be locked and unlocked by default only by the user that creates the lock but you can also allow the other file owners to modify it
![adf-lock](../docassets/images/lock-directive.png)
This calls the `openLockNodeDialog` method from the
[Content Node Dialog service](content-node-dialog.service.md) method when clicked,
and disables the target button if the provided node is not a file or the user doesn't

30
docs/content-services/node-permission.service.md
View File

@ -2,25 +2,31 @@
Added: v2.0.0
Status: Active
---
# Node Permission service
Manages the role permissions for the content nodes
## Methods
## Class members
- `getNodeRoles(node: MinimalNodeEntryEntity): Observable<string[]>`
Gets a list of roles for the current node.
- `node` - the target node
- `updatePermissionRoles(node: MinimalNodeEntryEntity, updatedPermissionRole: PermissionElement): Observable<MinimalNodeEntryEntity>`
Update the given permission for the related node
- `node` - the target node
- `updatedPermissionRole` the permission role to update/add
### Methods
- `getGroupMemeberByGroupName(groupName: string, opts?: any): Observable<GroupMemberPaging>`
Perform a call to the groups api to retrieve all the members related to that group name.
- `groupName` the members group name
- `opts` additional parameters to perform the call
- `getGroupMemeberByGroupName(groupName: string = null, opts?: any = null): Observable<GroupMemberPaging>`<br/>
- `groupName: string = null` -
- `opts?: any = null` - (Optional)
- **Returns** `Observable<GroupMemberPaging>` -
- `getNodeRoles(node: MinimalNodeEntryEntity = null): Observable<string[]>`<br/>
- `node: MinimalNodeEntryEntity = null` -
- **Returns** `Observable<string[]>` -
- `updatePermissionRoles(node: MinimalNodeEntryEntity = null, updatedPermissionRole: PermissionElement = null): Observable<MinimalNodeEntryEntity>`<br/>
- `node: MinimalNodeEntryEntity = null` -
- `updatedPermissionRole: PermissionElement = null` -
- **Returns** `Observable<MinimalNodeEntryEntity>` -
## Details

7
docs/content-services/node-share.directive.md
View File

@ -26,6 +26,8 @@ Creates and manages public shared links for files.
</adf-document-list>
```
## Class members
### Properties
| Name | Type | Default value | Description |
@ -33,22 +35,17 @@ Creates and manages public shared links for files.
| node | `MinimalNodeEntity` | | Nodes to share. |
| baseShareUrl | `string` | | baseShareUrl to add as prefix to the generated link |
## Details
This dialog will generate a link with the form "baseShareUrl + sharedId".
For example, if you set the input parameter as follows:
```
[baseShareUrl]="http://localhost:8080/myrouteForShareFile/"
```
...then the directive will ask the [Content service](../core/content.service.md) to generate
a `sharedId` for the file. This will create a URL like the following:
```
http://localhost:8080/myrouteForShareFile/NEW_GENERATED_SHAREID
```
To use this,ou will need to implement some code that gets the `NEW_GENERATED_SHAREID` with the router
and passes it to a [Viewer component](../core/viewer.component.md):

9
docs/content-services/permission-list.component.md
View File

@ -28,18 +28,19 @@ or custom template can be added:
</adf-permission-list>
```
## Class members
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| nodeId | `string` | `null` | ID of the node whose permissions you want to show. |
| -- | -- | -- | -- |
| nodeId | `string` | "" | |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| update | `PermissionElement` | Emitted when the permission is updated. |
| -- | -- | -- |
| update | `EventEmitter<PermissionElement>` | |
## Details

3
docs/content-services/permissions-style.model.md
View File

@ -2,10 +2,13 @@
Added: v2.0.0
Status: Active
---
# Permission Style model
Sets custom CSS styles for rows of a Document List according to the item's permissions.
## Class members
## Properties
| Property | Type | Description |

9
docs/content-services/rating.component.md
View File

@ -2,6 +2,7 @@
Added: v2.0.0
Status: Active
---
# Rating component
Allows a user to add ratings to an item.
@ -16,17 +17,19 @@ Allows a user to add ratings to an item.
</adf-rating>
```
## Class members
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| -- | -- | -- | -- |
| nodeId | `string` | | Identifier of the node to apply the rating to. |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| changeVote | `EventEmitter<{}>` | Emitted when the "vote" gets changed. |
| -- | -- | -- |
| changeVote | `EventEmitter<Object>` | Emitted when the "vote" gets changed. |
## See also

32
docs/content-services/rating.service.md
View File

@ -2,25 +2,31 @@
Added: v2.0.0
Status: Active
---
# Rating service
Manages ratings for items in Content Services.
## Methods
## Class members
- `getRating(nodeId: string, ratingType: any): any`
Gets the current user's rating for a node.
- `nodeId` - Node to get the rating from
- `ratingType` - Type of rating (can be "likes" or "fiveStar")
- `postRating(nodeId: string, ratingType: any, vote: any): any`
Adds the current user's rating for a node.
- `nodeId` - Target node for the rating
- `ratingType` - Type of rating (can be "likes" or "fiveStar")
- `vote` - Rating value (boolean for "likes", numeric 0..5 for "fiveStar")
- `deleteRating(nodeId: string, ratingType: any): any`
### Methods
- `deleteRating(nodeId: string = null, ratingType: any = null): any`<br/>
Removes the current user's rating for a node.
- `nodeId` - Target node
- `ratingType` - Type of rating to remove (can be "likes" or "fiveStar")
- `nodeId: string = null` - Target node
- `ratingType: any = null` - Type of rating to remove (can be "likes" or "fiveStar")
- **Returns** `any` -
- `getRating(nodeId: string = null, ratingType: any = null): any`<br/>
Gets the current user's rating for a node.
- `nodeId: string = null` - Node to get the rating from
- `ratingType: any = null` - Type of rating (can be "likes" or "fiveStar")
- **Returns** `any` -
- `postRating(nodeId: string = null, ratingType: any = null, vote: any = null): any`<br/>
Adds the current user's rating for a node.
- `nodeId: string = null` - Target node for the rating
- `ratingType: any = null` - Type of rating (can be "likes" or "fiveStar")
- `vote: any = null` - Rating value (boolean for "likes", numeric 0..5 for "fiveStar")
- **Returns** `any` -
## Details

4
docs/content-services/search-control.component.md
View File

@ -25,7 +25,7 @@ Displays a input text which shows find-as-you-type suggestions.
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| -- | -- | -- | -- |
| autocomplete | `boolean` | false | Toggles auto-completion of the search input field. |
| customQueryBody | `QueryBody` | | **Deprecated:** in 2.1.0 |
| expandable | `boolean` | true | Toggles whether to use an expanding search control. If false then a regular input is used. |
@ -37,7 +37,7 @@ Displays a input text which shows find-as-you-type suggestions.
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| -- | -- | -- |
| optionClicked | `EventEmitter<any>` | Emitted when a file item from the list of "find-as-you-type" results is selected. |
| searchChange | `EventEmitter<string>` | Emitted when the search term is changed. The search term is provided in the 'value' property of the returned object. If the term is less than three characters in length then the term is truncated to an empty string. |
| submit | `EventEmitter<any>` | Emitted when the search is submitted pressing ENTER button. The search term is provided as value of the event. |

17
docs/content-services/search-filter.component.md
View File

@ -14,25 +14,10 @@ Represents a main container component for custom search and faceted search setti
<adf-search-filter #settings></adf-search-filter>
```
## Class members
### Properties
For the property types please refer to the [Search Category interface](#categories).
| Property | Description |
| --- | --- |
| id | Unique identifier of the category. Also used to access QueryBuilder customizations for a particular widget. |
| name | Public display name for the category. |
| enabled | Toggles category availability. Set to `false` if you want to exclude a category from processing. |
| expanded | Toggles the expanded state of the category |
| component.selector | The id of the Angular component selector to render the Category |
| component.settings | An object containing component specific settings. Put any properties needed for the target component here. |
## Details
The component is based on dynamically created widgets to modify the resulting query and options,
and the [Search Query Builder service](search-query-builder.service.md)` to build and execute the search queries.
and the [Search Query Builder service](search-query-builder.service.md)\` to build and execute the search queries.
### Configuration

36
docs/content-services/search-query-builder.service.md
View File

@ -11,21 +11,27 @@ Stores information from all the custom search and faceted search widgets, compil
### Methods
- `addFilterQuery(query: string): void`
Adds a filter query to the search.
- `query` - Query text
- `removeFilterQuery(query: string): void`
Removes a previously added filter query from the search.
- `query` - Query text
- `getFacetQuery(label: string): FacetQuery`
Gets a facet query.
- `label` - Identifier of the target query
- `update(): void`
Rebuilds the query and triggers the `updated` event.
- `async execute()`
Executes the query.
- `buildQuery(): QueryBody`
Builds the query.
- `addFilterQuery(query: string = null)`<br/>
- `query: string = null` -
- `buildQuery(): QueryBody`<br/>
- **Returns** `QueryBody` -
- `execute(): Promise<void>`<br/>
- **Returns** `Promise<void>` -
- `getFacetQuery(label: string = null): FacetQuery`<br/>
- `label: string = null` -
- **Returns** `FacetQuery` -
- `removeFilterQuery(query: string = null)`<br/>
- `query: string = null` -
- `update()`<br/>
## Details

17
docs/content-services/search.component.md
View File

@ -8,6 +8,23 @@ Last reviewed: 2018-04-13
Searches items for supplied search terms.
## Contents
- [Basic usage](#basic-usage)
- [Class members](#class-members)
- [Properties](#properties)
- [Events](#events)
- [Details](#details)
- [Customise Search Results](#customise-search-results)
- [Attach an input field to the search](#attach-an-input-field-to-the-search)
- [Custom search configuration](#custom-search-configuration)
- [See Also](#see-also)
## Basic usage
```html

2
docs/content-services/sites-dropdown.component.md
View File

@ -18,6 +18,8 @@ Displays a dropdown menu to show and interact with the sites of the current user
</adf-sites-dropdown>
```
## Class members
### Properties
| Attribute | Type | Default | Description |

11
docs/content-services/tag-actions.component.md
View File

@ -2,6 +2,7 @@
Added: v2.0.0
Status: Active
---
# Tag Node Actions List component
Shows available actions for tags.
@ -16,16 +17,18 @@ Shows available actions for tags.
</adf-tag-node-actions-list>
```
## Class members
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| -- | -- | -- | -- |
| nodeId | `string` | | The identifier of a node. |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| successAdd | `EventEmitter<any>` | Emitted when a tag is added successfully. |
| -- | -- | -- |
| error | `EventEmitter<any>` | Emitted when an error occurs. |
| result | `EventEmitter<{}>` | Emitted when an action is chosen. |
| result | `EventEmitter<Object>` | Emitted when an action is chosen. |
| successAdd | `EventEmitter<any>` | Emitted when a tag is added successfully. |

7
docs/content-services/tag-list.component.md
View File

@ -2,19 +2,20 @@
Added: v2.0.0
Status: Active
---
# Tag List component
Shows tags for an item.
![Custom columns](../docassets/images/tag2.png)
## Basic Usage
## Class members
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| result | `EventEmitter<{}>` | Emitted when a tag is selected. |
| -- | -- | -- |
| result | `EventEmitter<Object>` | Emitted when a tag is selected. |
## See Also

9
docs/content-services/tag-node-list.component.md
View File

@ -2,6 +2,7 @@
Added: v2.0.0
Status: Active
---
# Tag Node List component
Shows tags for a node.
@ -16,14 +17,16 @@ Shows tags for a node.
</adf-tag-node-list>
```
## Class members
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| -- | -- | -- | -- |
| nodeId | `string` | | The identifier of a node. |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| results | `EventEmitter<{}>` | Emitted when a tag is selected. |
| -- | -- | -- |
| results | `EventEmitter<Object>` | Emitted when a tag is selected. |

4
docs/content-services/tag.service.md
View File

@ -17,9 +17,9 @@ Manages tags in Content Services.
- `nodeId: string = null` - ID of the target node
- `tagName: string = null` - Name of the tag to add
- **Returns** `any` - TagEntry object (defined in JSAPI) with details of the new tag
- `getAllTheTags(): any`<br/>
- `getAllTheTags(): Observable<any>`<br/>
Gets a list of all the tags already defined in the repository.
- **Returns** `any` - TagPaging object (defined in JSAPI) containing the tags
- **Returns** `Observable<any>` - TagPaging object (defined in JSAPI) containing the tags
- `getTagsByNodeId(nodeId: string = null): any`<br/>
Gets a list of tags added to a node.
- `nodeId: string = null` - ID of the target node

26
docs/content-services/upload-button.component.md
View File

@ -22,28 +22,30 @@ Activates a file upload.
<adf-file-uploading-dialog></adf-file-uploading-dialog>
```
## Class members
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| disabled | `boolean` | `false` | Toggles component disabled state (if there is no node permission checking). |
| uploadFolders | `boolean` | `false` | Allows/disallows upload folders (only for Chrome). |
| multipleFiles | `boolean` | `false` | Allows/disallows multiple files |
| versioning | `boolean` | `false` | Toggles versioning. |
| -- | -- | -- | -- |
| acceptedFilesType | `string` | "\*" | Filter for accepted file types. |
| disabled | `boolean` | false | Toggles component disabled state (if there is no node permission checking). |
| maxFilesSize | `number` | | Sets a limit on the maximum size (in bytes) of a file to be uploaded. Has no effect if undefined. |
| multipleFiles | `boolean` | false | Allows/disallows multiple files |
| rootFolderId | `string` | "-root-" | The ID of the root. Use the nodeId for Content Services or the taskId/processId for Process Services. |
| staticTitle | `string` | | Defines the text of the upload button. |
| tooltip | `string` | `null` | Custom tooltip text. |
| rootFolderId | `string` | `'-root-'` | The ID of the root. Use the nodeId for Content Services or the taskId/processId for Process Services. |
| acceptedFilesType | `string` | `'*'` | Filter for accepted file types. |
| tooltip | `string` | null | Custom tooltip text. |
| uploadFolders | `boolean` | false | Allows/disallows upload folders (only for Chrome). |
| versioning | `boolean` | false | Toggles versioning. |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| success | `EventEmitter<{}>` | Emitted when the file is uploaded successfully. |
| error | `EventEmitter<{}>` | Emitted when an error occurs. |
| createFolder | `EventEmitter<{}>` | Emitted when a folder is created. |
| -- | -- | -- |
| createFolder | `EventEmitter<Object>` | Emitted when a folder is created. |
| error | `EventEmitter<Object>` | Emitted when an error occurs. |
| permissionEvent | `EventEmitter<PermissionModel>` | Emitted when delete permission is missing. |
| success | `EventEmitter<Object>` | Emitted when the file is uploaded successfully. |
## Details

28
docs/content-services/upload-version-button.component.md
View File

@ -29,29 +29,31 @@ properties and events are the same except for the `node` property that specifies
to be versioned (this is a _required_ input parameter). However, some properties don't make
sense when applied to the Upload Version Button component, so they are simply ignored.
## Class members
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| node | `MinimalNodeEntryEntity` | | (**Required**) The node to be versioned. |
| disabled | `boolean` | `false` | Toggles component disabled state (if there is no node permission checking). |
| uploadFolders | `boolean` | `false` | Allows/disallows upload folders (only for Chrome). |
| multipleFiles | `boolean` | `false` | Allows/disallows multiple files |
| versioning | `boolean` | `false` | Toggles versioning. |
| -- | -- | -- | -- |
| acceptedFilesType | `string` | "\*" | Filter for accepted file types. |
| disabled | `boolean` | false | Toggles component disabled state (if there is no node permission checking). |
| maxFilesSize | `number` | | Sets a limit on the maximum size (in bytes) of a file to be uploaded. Has no effect if undefined. |
| multipleFiles | `boolean` | false | Allows/disallows multiple files |
| node | `MinimalNodeEntryEntity` | | (**Required**) The node to be versioned. |
| rootFolderId | `string` | "-root-" | The ID of the root. Use the nodeId for Content Services or the taskId/processId for Process Services. |
| staticTitle | `string` | | Defines the text of the upload button. |
| tooltip | `string` | `null` | Custom tooltip text. |
| rootFolderId | `string` | `'-root-'` | The ID of the root. Use the nodeId for Content Services or the taskId/processId for Process Services. |
| acceptedFilesType | `string` | `'*'` | Filter for accepted file types. |
| tooltip | `string` | null | Custom tooltip text. |
| uploadFolders | `boolean` | false | Allows/disallows upload folders (only for Chrome). |
| versioning | `boolean` | false | Toggles versioning. |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| success | `EventEmitter<{}>` | Emitted when the file is uploaded successfully. |
| error | `EventEmitter<{}>` | Emitted when an error occurs. |
| createFolder | `EventEmitter<{}>` | Emitted when a folder is created. |
| -- | -- | -- |
| createFolder | `EventEmitter<Object>` | Emitted when a folder is created. |
| error | `EventEmitter<Object>` | Emitted when an error occurs. |
| permissionEvent | `EventEmitter<PermissionModel>` | Emitted when delete permission is missing. |
| success | `EventEmitter<Object>` | Emitted when the file is uploaded successfully. |
## Details

21
docs/content-services/version-list.component.md
View File

@ -2,6 +2,7 @@
Added: v2.0.0
Status: Experimental
---
# Version List component
Displays the version history of a node in a Version Manager component
@ -12,22 +13,16 @@ Displays the version history of a node in a Version Manager component
<adf-version-list [node]="myNode"></adf-version-list>
```
## Class members
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| node | `MinimalNodeEntryEntity` | | Node whose version history you want to display. |
| showComments | `boolean` | true | Set this to false if version comments should not be displayed. |
| allowDownload | `boolean` | true | Toggles downloads of previous versions. Set this to false to not show the menu item for version download. |
### DOM events
All DOM events are bubbling and can be handled in the parent components up to the root application component.
| Name | Description |
| --- | --- |
| version-deleted | Raised after a version is deleted. |
| version-restored | Raised after a version is restored. |
| -- | -- | -- | -- |
| allowDownload | `boolean` | true | Enable/disable possibility to download a version of the current node. |
| id | `string` | | **Deprecated:** in 2.3.0 |
| node | `MinimalNodeEntryEntity` | | |
| showComments | `boolean` | true | |
## Details

18
docs/content-services/version-manager.component.md
View File

@ -22,20 +22,22 @@ Displays the version history of a node with the ability to upload a new version.
</adf-version-manager>
```
## Class members
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | --- | ----------- |
| node | [MinimalNodeEntryEntity](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md) | |The node you want to manage the version history of. |
| showComments | `boolean` | true | Set this to false if version comments should not be displayed. |
| allowDownload | `boolean` | true | Toggles downloads of previous versions. Set this to false to not show the menu item for version download. |
| -- | -- | -- | -- |
| allowDownload | `boolean` | true | |
| node | `MinimalNodeEntryEntity` | | |
| showComments | `boolean` | true | |
### Events
| Name | Description |
| --- | --- |
| uploadSuccess | Raised when the file is uploaded |
| uploadError | Emitted when an error occurs.|
| Name | Type | Description |
| -- | -- | -- |
| uploadError | `EventEmitter<Object>` | |
| uploadSuccess | `EventEmitter<Object>` | |
## Details

34
docs/content-services/webscript.component.md
View File

@ -2,10 +2,26 @@
Added: v2.0.0
Status: Active
---
# Webscript component
Provides access to Webscript features.
## Contents
- [Basic usage](#basic-usage)
- [Class members](#class-members)
- [Properties](#properties)
- [Events](#events)
- [Details](#details)
- [Webscript View HTML example](#webscript-view-html-example)
- [Webscript View DATATABLE example](#webscript-view-datatable-example)
- [Webscript View JSON example](#webscript-view-json-example)
## Basic usage
```html
@ -44,22 +60,24 @@ export class AppComponent {
}
```
## Class members
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| scriptPath | `string` | | (required) Path to the webscript (as defined by webscript). |
| -- | -- | -- | -- |
| contentType | `string` | "TEXT" | Content type to interpret the data received from the webscript. Can be "JSON" , "HTML" , "DATATABLE" or "TEXT" |
| contextRoot | `string` | "alfresco" | Path where the application is deployed |
| scriptArgs | `any` | | Arguments to pass to the webscript. |
| showData | `boolean` | `true` | Toggles whether to show or hide the data. |
| contextRoot | `string` | `'alfresco'` | Path where the application is deployed |
| servicePath | `string` | `'service'` | Path that the webscript service is mapped to. |
| contentType | `string` | `'TEXT'` | Content type to interpret the data received from the webscript. Can be "JSON" , "HTML" , "DATATABLE" or "TEXT" |
| scriptPath | `string` | | (required) Path to the webscript (as defined by webscript). |
| servicePath | `string` | "service" | Path that the webscript service is mapped to. |
| showData | `boolean` | true | Toggles whether to show or hide the data. |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| success | `EventEmitter<{}>` | Emitted when the operation succeeds. You can get the plain data from the webscript through the **success** event parameter and use it as you need in your application. |
| -- | -- | -- |
| success | `EventEmitter<Object>` | Emitted when the operation succeeds. You can get the plain data from the webscript through the **success** event parameter and use it as you need in your application. |
## Details

4
lib/config/DocProcessor/tools/tsInfo.js
View File

@ -157,6 +157,10 @@ exports.aggPhase = aggPhase;
function updatePhase(tree, pathname, aggData) {
var compName = angNameToClassName(path.basename(pathname, ".md"));
var classRef = aggData.projData.findReflectionByName(compName);
if (!classRef) {
// A doc file with no corresponding class (eg, Document Library Model).
return false;
}
var compData = new ComponentInfo(classRef);
var classType = compName.match(/component|directive|service/i);
if (classType) {

6
lib/config/DocProcessor/tools/tsInfo.ts
View File

@ -242,6 +242,12 @@ export function aggPhase(aggData) {
export function updatePhase(tree, pathname, aggData) {
let compName = angNameToClassName(path.basename(pathname, ".md"));
let classRef = aggData.projData.findReflectionByName(compName);
if (!classRef) {
// A doc file with no corresponding class (eg, Document Library Model).
return false;
}
let compData = new ComponentInfo(classRef);
let classType = compName.match(/component|directive|service/i);