inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

generate documentation (#7006)

Browse Source
This commit is contained in:
Eugenio Romano
2021-05-10 10:47:48 +01:00
committed by GitHub
parent 2d510776ea
commit d6a4f84161
68 changed files with 235 additions and 195 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/content-services/components/breadcrumb.component.md
View File

@@ -37,7 +37,7 @@ Indicates the current position within a navigation hierarchy.
| Name | Type | Description |
| ---- | ---- | ----------- |
| navigate | `any` | Emitted when the user clicks on a breadcrumb. |
| navigate | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PathElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PathElement.md)`>` | Emitted when the user clicks on a breadcrumb. |
## Details

8
docs/content-services/components/content-action.component.md
View File

@@ -97,10 +97,10 @@ export class MyView {
| Name | Type | Description |
| ---- | ---- | ----------- |
| error | `any` | Emitted when an error occurs during the action. Applies to copy and move actions. |
| execute | `any` | Emitted when the user selects the action from the menu. |
| permissionEvent | `any` | Emitted when a permission error occurs |
| success | `any` | Emitted when the action succeeds with the success string message. Applies to copy, move and delete actions. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs during the action. Applies to copy and move actions. |
| execute | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the user selects the action from the menu. |
| permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a permission error occurs |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the action succeeds with the success string message. Applies to copy, move and delete actions. |
## Details

2
docs/content-services/components/content-type-dialog.component.md
View File

@@ -43,7 +43,7 @@ The properties are described in the table below:
| nodeType | `string` | "" | current prefixed name of the content type selected |
If you don't want to manage the dialog yourself then it is easier to use the
methods of the Content Type [Property](../../../lib/content-services/src/lib/content-metadata/interfaces/property.interface.ts) Service, which create
methods of the Content Type [`Property`](../../../lib/content-services/src/lib/content-metadata/interfaces/property.interface.ts) Service, which create
the dialog for you.
### Usage example

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

@@ -38,7 +38,7 @@ Indicates the current position within a navigation hierarchy using a dropdown me
| Name | Type | Description |
| ---- | ---- | ----------- |
| navigate | `any` | Emitted when the user clicks on a breadcrumb. |
| navigate | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PathElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PathElement.md)`>` | Emitted when the user clicks on a breadcrumb. |
## Details

2
docs/content-services/components/like.component.md
View File

@@ -29,7 +29,7 @@ Allows a user to add "likes" to an item.
| Name | Type | Description |
| ---- | ---- | ----------- |
| changeVote | `any` | Emitted when the "vote" gets changed. |
| changeVote | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the "vote" gets changed. |
## See also

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

@@ -17,14 +17,13 @@ Shows node permissions as a table.
<adf-permission-list [nodeId]="nodeId"></adf-permission-list>
```
## Class members
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| nodeId | `string` | "" | ID of the node whose permissions you want to show. |
| nodeId | `string` | | ID of the node whose permissions you want to show. |
### Events

2
docs/content-services/components/rating.component.md
View File

@@ -40,7 +40,7 @@ If the average is decimal number it will be rounded.
| Name | Type | Description |
| ---- | ---- | ----------- |
| changeVote | `any` | Emitted when the "vote" gets changed. |
| changeVote | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the "vote" gets changed. |
## See also

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

@@ -32,5 +32,5 @@ Shows available actions for tags.
| Name | Type | Description |
| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| result | `any` | Emitted when an action is chosen. |
| result | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an action is chosen. |
| successAdd | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a tag is added successfully. |

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

@@ -17,7 +17,7 @@ Shows tags for an item.
| Name | Type | Description |
| ---- | ---- | ----------- |
| result | `any` | Emitted when a tag is selected. |
| result | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a tag is selected. |
## See Also

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

@@ -32,4 +32,4 @@ Shows tags for a node.
| Name | Type | Description |
| ---- | ---- | ----------- |
| results | `any` | Emitted when a tag is selected. |
| results | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a tag is selected. |

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

@@ -47,11 +47,11 @@ Activates a file upload.
| Name | Type | Description |
| ---- | ---- | ----------- |
| beginUpload | `any` | Emitted when the upload begins. |
| error | `any` | Emitted when an error occurs. |
| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../../lib/content-services/src/lib/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PermissionModel`](../../../lib/content-services/src/lib/document-list/models/permissions.model.ts)`>` | Emitted when create permission is missing. |
| success | `any` | Emitted when the file is uploaded successfully. |
| updateFileVersion | `any` | Emitted when dropping a file over another file to update the version. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the file is uploaded successfully. |
| updateFileVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<CustomEvent<any>>` | Emitted when dropping a file over another file to update the version. |
## Details

8
docs/content-services/components/upload-drag-area.component.md
View File

@@ -74,10 +74,10 @@ as the drag/drop target:
| Name | Type | Description |
| ---- | ---- | ----------- |
| beginUpload | `any` | Emitted when the upload begins. |
| error | `any` | Emitted when an error occurs. |
| success | `any` | Emitted when the file is uploaded successfully. |
| updateFileVersion | `any` | Emitted when dropping a file over another file to update the version. |
| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../../lib/content-services/src/lib/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the file is uploaded successfully. |
| updateFileVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<CustomEvent<any>>` | Emitted when dropping a file over another file to update the version. |
## Details

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

@@ -50,11 +50,11 @@ to enrich the features and decrease the restrictions currently applied to node v
| Name | Type | Description |
| ---- | ---- | ----------- |
| beginUpload | `any` | Emitted when the upload begins. |
| error | `any` | Emitted when an error occurs. |
| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../../lib/content-services/src/lib/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PermissionModel`](../../../lib/content-services/src/lib/document-list/models/permissions.model.ts)`>` | Emitted when create permission is missing. |
| success | `any` | Emitted when the file is uploaded successfully. |
| updateFileVersion | `any` | Emitted when dropping a file over another file to update the version. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the file is uploaded successfully. |
| updateFileVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<CustomEvent<any>>` | Emitted when dropping a file over another file to update the version. |
## Details

10
docs/content-services/components/version-upload.component.md
View File

@@ -30,11 +30,11 @@ Displays the new version's minor/major changes and the optional comment of a nod
| Name | Type | Description |
| ---- | ---- | ----------- |
| cancel | `any` | Emitted when an cancelling during upload. |
| commentChanged | `any` | Emitted when the comment is changed. |
| error | `any` | Emitted when an error occurs. |
| success | `any` | Emitted when the file is uploaded successfully. |
| versionChanged | `any` | Emitted when the version is changed. |
| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an cancelling during upload. |
| commentChanged | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the comment is changed. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the file is uploaded successfully. |
| versionChanged | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when the version is changed. |
## Details

2
docs/content-services/components/webscript.component.md
View File

@@ -75,7 +75,7 @@ export class AppComponent {
| Name | Type | Description |
| ---- | ---- | ----------- |
| success | `any` | 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`](https://angular.io/api/core/EventEmitter)`<any>` | 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