mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
Documentation build (#6762)
* move doc dependency in doctools * add ignore link * rebuild doc * version index * put it back some deps
This commit is contained in:
@@ -34,9 +34,9 @@ Creates and manages public shared links for files.
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| baseShareUrl | `string` | | Prefix to add to the generated link. |
|
||||
| node | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) | | [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to share. |
|
||||
| node | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) | | Node to share. |
|
||||
|
||||
## Details
|
||||
|
||||
|
@@ -39,15 +39,15 @@ Some sample CSS to show the drag and drop area:
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| enabled | `boolean` | true | Enables/disables drag-and-drop functionality. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| filesDropped | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<File[]>` | Emitted when one or more files are dragged and dropped onto the draggable element. |
|
||||
| folderEntityDropped | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a directory is dragged and dropped onto the draggable element. |
|
||||
| ---- | ---- | ----------- |
|
||||
| filesDropped | `any` | Emitted when one or more files are dragged and dropped onto the draggable element. |
|
||||
| folderEntityDropped | `any` | Emitted when a directory is dragged and dropped onto the draggable element. |
|
||||
|
||||
## Details
|
||||
|
||||
@@ -75,4 +75,4 @@ export class SomeComponent implements OnInit {
|
||||
|
||||
## See also
|
||||
|
||||
* [Upload Drag Area component](../components/upload-drag-area.component.md)
|
||||
- [Upload Drag Area component](../components/upload-drag-area.component.md)
|
||||
|
@@ -31,7 +31,7 @@ Creates folders.
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| nodeType | `string` | "cm:folder" | Type of node to create. |
|
||||
| parentNodeId | `string` | | Parent folder where the new folder will be located after creation. |
|
||||
| title | `string` | null | Title of folder creation dialog. |
|
||||
@@ -39,9 +39,9 @@ Creates folders.
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| ---- | ---- | ----------- |
|
||||
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs (eg, a folder with same name already exists). |
|
||||
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when the folder is created successfully. |
|
||||
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Node>` | Emitted when the folder is created successfully. |
|
||||
|
||||
## Details
|
||||
|
||||
@@ -52,4 +52,4 @@ then the dialog will emit a `success` event when it closes.
|
||||
|
||||
## See also
|
||||
|
||||
* [Folder Edit directive](folder-edit.directive.md)
|
||||
- [Folder Edit directive](folder-edit.directive.md)
|
||||
|
@@ -31,16 +31,16 @@ Allows folders to be edited.
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| folder | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | Folder node to edit. |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| folder | `Node` | | Folder node to edit. |
|
||||
| title | `string` | null | Title of folder edit dialog. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| ---- | ---- | ----------- |
|
||||
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs (eg, a folder with same name already exists). |
|
||||
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when the folder has been edited successfully. |
|
||||
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Node>` | Emitted when the folder has been edited successfully. |
|
||||
|
||||
## Details
|
||||
|
||||
|
@@ -23,15 +23,15 @@ Update the current node by adding/removing the inherited permissions.
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| nodeId | `string` | | ID of the node to add/remove inherited permissions. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| ---- | ---- | ----------- |
|
||||
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
|
||||
| updated | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when the node is updated. |
|
||||
| updated | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Node>` | Emitted when the node is updated. |
|
||||
|
||||
## Details
|
||||
|
||||
|
@@ -22,8 +22,8 @@ Locks or unlocks a node.
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to lock/unlock. |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| node | `Node` | | Node to lock/unlock. |
|
||||
|
||||
## Details
|
||||
|
||||
|
Reference in New Issue
Block a user