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

[ADF-3239] Fixed deprecated property descriptions (#3509)

Browse Source 
* [ADF-3239] Changed deprecated properties to include full description

* [ADF-3239] Updated deprecated properties of affected doc files

* [ADF-3239] Fixed badly formatted doc comment in tasklist
This commit is contained in:
Andy Stark
2018-06-20 13:04:21 +01:00
committed by Eugenio Romano
parent 4984cc4437
commit c1b12204f3
13 changed files with 31 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -31,13 +31,13 @@ Allows a user to select items from a Content Services repository.
| Name | Type | Default value | Description |
| -- | -- | -- | -- |
| currentFolderId | `string` | null | **Deprecated:** in 2.1.0 |
| dropdownHideMyFiles | `boolean` | false | **Deprecated:** in 2.1.0 |
| dropdownSiteList | [`SitePaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md) | null | **Deprecated:** in 2.1.0 |
| imageResolver | [`ImageResolver`](../../lib/content-services/document-list/data/image-resolver.model.ts) | null | **Deprecated:** in 2.1.0 |
| pageSize | `number` | | **Deprecated:** in 2.1.0 |
| rowFilter | [`RowFilter`](../../lib/content-services/document-list/data/row-filter.model.ts) | 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`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md) | null | (**Deprecated:** in 2.1.0) |
| imageResolver | [`ImageResolver`](../../lib/content-services/document-list/data/image-resolver.model.ts) | null | (**Deprecated:** in 2.1.0) |
| pageSize | `number` | | (**Deprecated:** in 2.1.0) |
| rowFilter | [`RowFilter`](../../lib/content-services/document-list/data/row-filter.model.ts) | null | (**Deprecated:** in 2.1.0) |
| title | `string` | null | (**Deprecated:** in 2.1.0) |
## Details

2
docs/content-services/file-draggable.directive.md
View File

@@ -46,7 +46,7 @@ Some sample CSS to show the drag and drop area:
| 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. |
| filesEntityDropped | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | **Deprecated:** in 2.4.0: use `filesDropped` instead. Emitted when one or more files are dragged and dropped onto the draggable element. |
| filesEntityDropped | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | (**Deprecated:** in 2.4.0: use `filesDropped` instead. Emitted when one or more files are dragged and dropped onto the draggable element.) |
| folderEntityDropped | `EventEmitter<any>` | Emitted when a directory is dragged and dropped onto the draggable element. |
## Details

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

@@ -27,7 +27,7 @@ Displays a input text which shows find-as-you-type suggestions.
| Name | Type | Default value | Description |
| -- | -- | -- | -- |
| autocomplete | `boolean` | false | Toggles auto-completion of the search input field. |
| customQueryBody | `QueryBody` | | **Deprecated:** in 2.1.0 |
| 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. |
| highlight | `boolean` | false | Toggles highlighting of the search term in the results. |
| inputType | `string` | "text" | Type of the input field to render, e.g. "search" or "text" (default). |

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

@@ -42,7 +42,7 @@ Searches items for supplied search terms.
| -- | -- | -- | -- |
| displayWith | `function \| null` | null | Function that maps an option's value to its display value in the trigger. |
| maxResults | `number` | 20 | Maximum number of results to show in the search. |
| queryBody | `QueryBody` | | **Deprecated:** in 2.1.0 |
| queryBody | `QueryBody` | | (**Deprecated:** in 2.1.0) |
| searchTerm | `string` | "" | Search term to use when executing the search. Updating this value will run a new search and update the results. |
| skipResults | `number` | 0 | Number of results to skip from the results pagination. |
| class | | | CSS class for display. |

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

@@ -21,7 +21,7 @@ Displays the version history of a node in a [Version Manager component](../conte
| Name | Type | Default value | Description |
| -- | -- | -- | -- |
| allowDownload | `boolean` | true | Enable/disable downloading a version of the current node. |
| id | `string` | | **Deprecated:** in 2.3.0 |
| id | `string` | | (**Deprecated:** in 2.3.0) |
| node | [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) | | The target node. |
| showActions | `boolean` | true | Toggles showing/hiding of version actions |
| showComments | `boolean` | true | Toggles showing/hiding of comments |