From 42d02146fdaef95158e5ec985db722264c22ea08 Mon Sep 17 00:00:00 2001 From: Eugenio Romano Date: Fri, 3 May 2019 14:30:35 +0100 Subject: [PATCH] [ADF-3.2.0] review link doc (#4689) * review link doc --- docs/README.md | 9 +- .../components/breadcrumb.component.md | 2 +- .../content-metadata-card.component.md | 16 +- .../content-node-selector-panel.component.md | 4 +- .../components/document-list.component.md | 4 +- .../dropdown-breadcrumb.component.md | 2 +- .../components/search-filter.component.md | 6 +- .../interfaces/search-widget.interface.md | 2 +- .../models/image-resolver.model.md | 2 +- .../models/row-filter.model.md | 2 +- .../services/custom-resources.service.md | 3 +- .../services/document-actions.service.md | 8 +- .../services/document-list.service.md | 32 +- .../services/folder-actions.service.md | 8 +- .../services/search-query-builder.service.md | 8 - docs/core/components/data-column.component.md | 5 +- docs/core/components/datatable.component.md | 2 +- .../components/error-content.component.md | 2 +- docs/core/components/form-field.component.md | 4 +- .../infinite-pagination.component.md | 2 +- .../components/sidenav-layout.component.md | 2 +- docs/core/components/start-form.component.md | 3 +- docs/core/components/viewer.component.md | 4 +- docs/core/directives/clipboard.directive.md | 4 +- docs/core/services/authentication.service.md | 4 +- docs/core/services/card-item-types.service.md | 14 +- docs/core/services/form-rendering.service.md | 14 +- docs/core/services/notification.service.md | 11 +- docs/core/services/process-content.service.md | 4 +- docs/core/services/renditions.service.md | 4 +- docs/core/services/storage.service.md | 2 + .../core/services/user-preferences.service.md | 4 + docs/extensions/services/extension.service.md | 16 +- .../components/app-list-cloud.component.md | 1 - .../components/form-cloud.component.md | 2 + ...orm-definition-selector-cloud.component.md | 7 +- .../components/people-cloud.component.md | 4 +- .../process-list-cloud.component.md | 3 +- .../services/form-cloud.service.md | 7 +- .../services/process-header-cloud.service.md | 5 + .../services/process-list-cloud.service.md | 7 +- .../services/start-process-cloud.service.md | 5 + .../services/start-task-cloud.service.md | 4 + .../services/task-cloud.service.md | 5 + .../services/task-list-cloud.service.md | 5 + .../components/form.component.md | 3 +- .../components/process-filters.component.md | 2 +- .../components/start-process.component.md | 2 +- .../services/process-filter.service.md | 4 +- .../services/process.service.md | 8 +- .../services/tasklist.service.md | 6 +- docs/release-notes/RelNote161.md | 4 +- docs/release-notes/RelNote170.md | 6 +- docs/release-notes/RelNote190.md | 2 +- docs/release-notes/RelNote200.md | 18 +- docs/release-notes/RelNote210.md | 4 +- docs/release-notes/RelNote220.md | 2 +- docs/release-notes/RelNote230.md | 14 +- docs/release-notes/RelNote240.md | 2 +- docs/release-notes/RelNote250.md | 6 +- docs/release-notes/RelNote260.md | 16 +- docs/release-notes/RelNote310.md | 371 +++++++------- docs/release-notes/RelNote320.md | 88 ++-- docs/tutorials/README.md | 6 +- docs/tutorials/content-metadata-component.md | 4 +- docs/upgrade-guide/upgrade26-30.md | 462 ++++++++++-------- docs/user-guide/app-extensions.md | 2 +- docs/user-guide/internationalization.md | 4 +- docs/versionIndex.md | 15 +- 69 files changed, 736 insertions(+), 579 deletions(-) diff --git a/docs/README.md b/docs/README.md index 007acbe6fa..01c8635c68 100644 --- a/docs/README.md +++ b/docs/README.md @@ -98,7 +98,7 @@ for more information about installing and using the source code. | [Info drawer layout component](core/components/info-drawer-layout.component.md) | Displays a sidebar-style information panel. | [Source](../lib/core/info-drawer/info-drawer-layout.component.ts) | | [Info Drawer Tab component](core/components/info-drawer-tab.component.md) | Renders tabs in a Info drawer component. | [Source](../lib/core/info-drawer/info-drawer.component.ts) | | [Info Drawer component](core/components/info-drawer.component.md) | Displays a sidebar-style information panel with tabs. | [Source](../lib/core/info-drawer/info-drawer.component.ts) | -| [JsonCell component](core/components/json-cell.component.md) | Show Json formated value inside datatable component. | [Source](../lib/core/datatable/components/datatable/json-cell.component.ts) | +| [Json Cell component](core/components/json-cell.component.md) | Shows a JSON-formatted value inside a datatable component. | [Source](../lib/core/datatable/components/datatable/json-cell.component.ts) | | [Language Menu component](core/components/language-menu.component.md) | Displays all the languages that are present in "app.config.json" and the default (EN). | [Source](../lib/core/language-menu/language-menu.component.ts) | | [Login Dialog Panel component](core/components/login-dialog-panel.component.md) | Shows and manages a login dialog. | [Source](../lib/core/login/components/login-dialog-panel.component.ts) | | [Login Dialog component](core/components/login-dialog.component.md) | Allows a user to perform a login via a dialog. | [Source](../lib/core/login/components/login-dialog.component.ts) | @@ -107,7 +107,7 @@ for more information about installing and using the source code. | [Sidebar action menu component](core/components/sidebar-action-menu.component.md) | Displays a sidebar-action menu information panel. | [Source](../lib/core/layout/components/sidebar-action/sidebar-action-menu.component.ts) | | [Sidenav Layout component](core/components/sidenav-layout.component.md) | Displays the standard three-region ADF application layout. | [Source](../lib/core/layout/components/sidenav-layout/sidenav-layout.component.ts) | | [Sorting Picker Component](core/components/sorting-picker.component.md) | Selects from a set of predefined sorting definitions and directions. | [Source](../lib/core/sorting-picker/sorting-picker.component.ts) | -| [Start Form component](core/components/start-form.component.md) | Displays the Start Form for a process. | [Source](../lib/process-services/form/start-form.component.ts) | +| [Start Form component](core/components/start-form.component.md) | Displays the Start Form for a process. | [Source](../lib/core/form/components/start-form.component.ts) | | [Text Mask directive](core/components/text-mask.component.md) | Implements text field input masks. | [Source](../lib/core/form/components/widgets/text/text-mask.component.ts) | | [Toolbar Divider Component](core/components/toolbar-divider.component.md) | Divides groups of elements in a Toolbar with a visual separator. | [Source](../lib/core/toolbar/toolbar-divider.component.ts) | | [Toolbar Title Component](core/components/toolbar-title.component.md) | Supplies custom HTML to be included in a Toolbar component title. | [Source](../lib/core/toolbar/toolbar-title.component.ts) | @@ -158,11 +158,11 @@ for more information about installing and using the source code. | [Format Space pipe](core/pipes/format-space.pipe.md) | Replaces all the white space in a string with a supplied character. | [Source](../lib/core/pipes/format-space.pipe.ts) | | [Full name pipe](core/pipes/full-name.pipe.md) | Joins the first and last name properties from a UserProcessModel object into a single string. | [Source](../lib/core/pipes/full-name.pipe.ts) | | [Mime Type Icon pipe](core/pipes/mime-type-icon.pipe.md) | Retrieves an icon to represent a MIME type. | [Source](../lib/core/pipes/mime-type-icon.pipe.ts) | +| [Multi Value pipe](core/pipes/multi-value.pipe.md) | Takes an array of strings and turns it into one string where items are separated by a separator. The default separator applied to the list is ', ', however, you can set your own separator in the params of the pipe. | [Source](../lib/core/pipes/multi-value.pipe.ts) | | [Node Name Tooltip pipe](core/pipes/node-name-tooltip.pipe.md) | Formats the tooltip for a Node. | [Source](../lib/core/pipes/node-name-tooltip.pipe.ts) | | [Text Highlight pipe](core/pipes/text-highlight.pipe.md) | Adds highlighting to words or sections of text that match a search string. | [Source](../lib/core/pipes/text-highlight.pipe.ts) | | [Time Ago pipe](core/pipes/time-ago.pipe.md) | Converts a recent past date into a number of days ago. | [Source](../lib/core/pipes/time-ago.pipe.ts) | | [User Initial pipe](core/pipes/user-initial.pipe.md) | Takes the name fields of a UserProcessModel object and extracts and formats the initials. | [Source](../lib/core/pipes/user-initial.pipe.ts) | -| [Multi value pipe](core/pipes/multi-value.pipe.md) | Takes a list of values to stringify them with a custom separator. | [Source](../lib/core/pipes/multi-value.pipe.ts) | ### Services @@ -408,7 +408,9 @@ for more information about installing and using the source code. | [App List Cloud Component](process-services-cloud/components/app-list-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows all deployed cloud application instances. | [Source](../lib/process-services-cloud/src/lib/app/components/app-list-cloud.component.ts) | | [Edit Process Filter Cloud component](process-services-cloud/components/edit-process-filter-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows/edits process filter details. | [Source](../lib/process-services-cloud/src/lib/process/process-filters/components/edit-process-filter-cloud.component.ts) | | [Edit Task Filter Cloud component](process-services-cloud/components/edit-task-filter-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Edits task filter details. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/components/edit-task-filter-cloud.component.ts) | +| [Form cloud custom outcomes component](process-services-cloud/components/form-cloud-custom-outcome.component.md) | Supplies custom outcome buttons to be included in Form cloud component. | [Source](../lib/process-services-cloud/src/lib/form/components/form-cloud-custom-outcomes.component.ts) | | [Form cloud component](process-services-cloud/components/form-cloud.component.md) | Shows a form from Process Services. | [Source](../lib/process-services-cloud/src/lib/form/components/form-cloud.component.ts) | +| [Form definition selector Cloud componet](process-services-cloud/components/form-definition-selector-cloud.component.md) | Allows one form to be selected. | [Source](../lib/process-services-cloud/src/lib/form-definition-selector/components/form-definition-selector-cloud.component.ts) | | [Group Cloud component](process-services-cloud/components/group-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Searches Groups. | [Source](../lib/process-services-cloud/src/lib/group/components/group-cloud.component.ts) | | [People Cloud Component](process-services-cloud/components/people-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Allows one or more users to be selected (with auto-suggestion) based on the input parameters. | [Source](../lib/process-services-cloud/src/lib/task/start-task/components/people-cloud/people-cloud.component.ts) | | [Process Filters Cloud Component](process-services-cloud/components/process-filters-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Lists all available process filters and allows to select a filter. | [Source](../lib/process-services-cloud/src/lib/process/process-filters/components/process-filters-cloud.component.ts) | @@ -417,6 +419,7 @@ for more information about installing and using the source code. | [Start Process Cloud Component](process-services-cloud/components/start-process-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Starts a process. | [Source](../lib/process-services-cloud/src/lib/process/start-process/components/start-process-cloud.component.ts) | | [Start Task Cloud Component](process-services-cloud/components/start-task-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Creates/starts a new task for the specified app. | [Source](../lib/process-services-cloud/src/lib/task/start-task/components/start-task-cloud.component.ts) | | [Task Filters Cloud component](process-services-cloud/components/task-filters-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows all available filters. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/components/task-filters-cloud.component.ts) | +| [Form cloud component](process-services-cloud/components/task-form-cloud.component.md) | Shows a form for a task. | [Source](../lib/process-services-cloud/src/lib/form/components/task-form-cloud.component.ts) | | [Task Header Cloud Component](process-services-cloud/components/task-header-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows all the information related to a task. | [Source](../lib/process-services-cloud/src/lib/task/task-header/components/task-header-cloud.component.ts) | | [Task List Cloud component](process-services-cloud/components/task-list-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Renders a list containing all the tasks matched by the parameters specified. | [Source](../lib/process-services-cloud/src/lib/task/task-list/components/task-list-cloud.component.ts) | diff --git a/docs/content-services/components/breadcrumb.component.md b/docs/content-services/components/breadcrumb.component.md index 17b3f4c773..41cac36dee 100644 --- a/docs/content-services/components/breadcrumb.component.md +++ b/docs/content-services/components/breadcrumb.component.md @@ -36,7 +36,7 @@ Indicates the current position within a navigation hierarchy. | Name | Type | Description | | ---- | ---- | ----------- | -| navigate | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | 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/development/src/api/content-rest-api/docs/PathElement.md)`>` | Emitted when the user clicks on a breadcrumb. | ## Details diff --git a/docs/content-services/components/content-metadata-card.component.md b/docs/content-services/components/content-metadata-card.component.md index c280ae6f69..6a16df841e 100644 --- a/docs/content-services/components/content-metadata-card.component.md +++ b/docs/content-services/components/content-metadata-card.component.md @@ -11,6 +11,18 @@ Displays and edits metadata related to a node. ![Content metadata screenshot](../../docassets/images/ContentMetadata.png) +## Contents + +- [Basic Usage](#basic-usage) +- [Class members](#class-members) + - [Properties](#properties) +- [Details](#details) + - [Application config presets](#application-config-presets) + - [Layout oriented config](#layout-oriented-config) + - [Displaying all properties](#displaying-all-properties) +- [What happens when there is a whitelisted aspect in the config but the given node doesn't relate to that aspect](#what-happens-when-there-is-a-whitelisted-aspect-in-the-config-but-the-given-node-doesnt-relate-to-that-aspect) +- [Multi value card properties](#multi-value-card-properties) + ## Basic Usage ```html @@ -28,13 +40,13 @@ Displays and edits metadata related to a node. | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | +| displayAspect | `string` | null | (optional) This flag displays desired aspect when open for the first time fields. | | displayEmpty | `boolean` | false | (optional) This flag displays/hides empty metadata fields. | | multi | `boolean` | false | (optional) This flag allows the component to display more than one accordion at a time. | | node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) | | (required) The node entity to fetch metadata about | | preset | `string` | | (required) Name of the metadata preset, which defines aspects and their properties. | | readOnly | `boolean` | false | (optional) This flag sets the metadata in read only mode preventing changes. | | displayDefaultProperties | `boolean` | | (optional) This flag displays/hides the metadata properties. | -| displayAspect | `string` | | (optional) This flag displays the desired metadata property in the expanded card | ## Details @@ -217,7 +229,6 @@ The result of this config would be two accordion groups with the following prope | kitten:favourite-food | | kitten:recommended-food | - ### Displaying all properties You can list all the properties by simply adding the `includeAll: boolean` to your config. This config will display all the aspects and properties available for that specific file. @@ -277,6 +288,7 @@ Nothing - since this aspect is not related to the node, it will simply be ignore displayed. The aspects to be displayed are calculated as an intersection of the preset's aspects and the aspects related to the node. ## Multi value card properties + Multi value properties are displayed one after another separated by a comma. This card makes use of the [Multi Value Pipe](../../core/pipes/multi-value.pipe.ts). To customize the separator used by this card you can set it in your `app.config.json` inside your content-metadata configuration: diff --git a/docs/content-services/components/content-node-selector-panel.component.md b/docs/content-services/components/content-node-selector-panel.component.md index f8fd6191bc..6dd81efed8 100644 --- a/docs/content-services/components/content-node-selector-panel.component.md +++ b/docs/content-services/components/content-node-selector-panel.component.md @@ -34,12 +34,12 @@ Opens a [Content Node Selector](content-node-selector.component.md) in its own | currentFolderId | `string` | null | [Node](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) 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`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md) | null | Custom site for site dropdown. This is the same as the `siteList`. property of the Sites Dropdown component (see its doc page for more information). | -| imageResolver | [`ImageResolver`](../../../lib/content-services/document-list/data/image-resolver.model.ts) | null | Custom image resolver function. See the [Image Resolver Model](../models/image-resolver.model.md) page for more information. | +| imageResolver | [`ImageResolver`](../../../lib/content-services/document-list/data/image-resolver.model.ts) | null | Custom image resolver function. See the [Image Resolver Model](image-resolver.model.md) page for more information. | | isSelectionValid | [`ValidationFunction`](../../../lib/content-services/content-node-selector/content-node-selector-panel.component.ts) | 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. | | where | `string` | | Custom _where_ filter function. See the [Document List component](../../content-services/components/document-list.component.md) for more information. | | excludeSiteContent | `string[]` | | Custom list of site content componentIds. Used to filter out the corresponding items from the displayed nodes | -| rowFilter | [`RowFilter`](../../../lib/content-services/document-list/data/row-filter.model.ts) | | Custom row filter function. See the [Row Filter Model](../models/row-filter.model.md) page for more information. | +| rowFilter | [`RowFilter`](../../../lib/content-services/document-list/data/row-filter.model.ts) | | Custom row filter function. See the [Row Filter Model](row-filter.model.md) page for more information. | ### Events diff --git a/docs/content-services/components/document-list.component.md b/docs/content-services/components/document-list.component.md index f8847b463a..5ffa33eec2 100644 --- a/docs/content-services/components/document-list.component.md +++ b/docs/content-services/components/document-list.component.md @@ -62,7 +62,7 @@ Displays the documents from a repository. | contextMenuActions | `boolean` | false | Toggles context menus for each row | | display | `string` | DisplayMode.List | Change the display mode of the table. Can be "list" or "gallery". | | emptyFolderImageUrl | `string` | | Custom image for empty folder. Default value: './assets/images/empty_doc_lib.svg' | -| imageResolver | `any \| null` | null | Custom function to choose image file paths to show. See the [Image Resolver Model](../models/image-resolver.model.md) page for more information. | +| imageResolver | `any \| null` | null | Custom function to choose image file paths to show. See the [Image Resolver Model](image-resolver.model.md) page for more information. | | 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). | @@ -82,7 +82,7 @@ Displays the documents from a repository. | thumbnails | `boolean` | false | Show document thumbnails rather than icons | | where | `string` | | Filters the [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) list using the _where_ condition of the REST API (for example, isFolder=true). See the REST API documentation for more information. | | currentFolderId | `string` | | The ID of the folder node to display or a reserved string alias for special sources | -| rowFilter | [`RowFilter`](../../../lib/content-services/document-list/data/row-filter.model.ts) | | Custom function to choose whether to show or hide rows. See the [Row Filter Model](../models/row-filter.model.md) page for more information. | +| rowFilter | [`RowFilter`](../../../lib/content-services/document-list/data/row-filter.model.ts) | | Custom function to choose whether to show or hide rows. See the [Row Filter Model](row-filter.model.md) page for more information. | ### Events diff --git a/docs/content-services/components/dropdown-breadcrumb.component.md b/docs/content-services/components/dropdown-breadcrumb.component.md index 315069123f..15b160b34b 100644 --- a/docs/content-services/components/dropdown-breadcrumb.component.md +++ b/docs/content-services/components/dropdown-breadcrumb.component.md @@ -37,7 +37,7 @@ Indicates the current position within a navigation hierarchy using a dropdown me | Name | Type | Description | | ---- | ---- | ----------- | -| navigate | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | 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/development/src/api/content-rest-api/docs/PathElement.md)`>` | Emitted when the user clicks on a breadcrumb. | ## Details diff --git a/docs/content-services/components/search-filter.component.md b/docs/content-services/components/search-filter.component.md index be4e7445a3..8d53ab733e 100644 --- a/docs/content-services/components/search-filter.component.md +++ b/docs/content-services/components/search-filter.component.md @@ -19,8 +19,8 @@ Represents a main container component for custom search and faceted search setti - [Categories and widgets](#categories-and-widgets) - [Facet Fields](#facet-fields) - [Facet Queries](#facet-queries) - - [Highlight](#highlight) - [Facet Intervals](#facet-intervals) + - [Highlight](#highlight) - [See also](#see-also) ## Basic usage @@ -451,7 +451,6 @@ An example query for search highlighting could look like this: } } } - ``` The example above changes the highlighting prefix and postfix from the default to '¿?' for all @@ -479,7 +478,8 @@ then be added in each node entry response. An example partial response is shown } ] }, - ``` +``` + ## See also - [Search Query Builder service](../services/search-query-builder.service.md) diff --git a/docs/content-services/interfaces/search-widget.interface.md b/docs/content-services/interfaces/search-widget.interface.md index 9775c479a4..28ed0b48ed 100644 --- a/docs/content-services/interfaces/search-widget.interface.md +++ b/docs/content-services/interfaces/search-widget.interface.md @@ -36,7 +36,7 @@ export interface SearchWidget { | ---- | ---- | ------------- | ----------- | | id | `string` | | Unique identifying value for the widget | | settings | [`SearchWidgetSettings`](../../../lib/content-services/search/search-widget-settings.interface.ts) | | Settings for component properties | -| context | [`SearchQueryBuilderService`](../services/search-query-builder.service.md) | | Instance of the [Search Query Builder service](../services/search-query-builder.service.md) to process the query | +| context | [`SearchQueryBuilderService`](../../content-services/services/search-query-builder.service.md) | | Instance of the [Search Query Builder service](../services/search-query-builder.service.md) to process the query | ## Details diff --git a/docs/content-services/models/image-resolver.model.md b/docs/content-services/models/image-resolver.model.md index 154f77b0ee..1ea0d8592f 100644 --- a/docs/content-services/models/image-resolver.model.md +++ b/docs/content-services/models/image-resolver.model.md @@ -11,7 +11,7 @@ Defines the Image Resolver function used by the [Document List Component](../com ## Definitions -- `type` **ImageResolver** = (row: [`DataRow`](../../../lib/core/datatable/data/data-row.model.ts), column: [`DataColumn`](../../../lib/core/datatable/data/data-column.model.ts)) => `string` +- `type` **[ImageResolver](../../../lib/content-services/document-list/data/image-resolver.model.ts)** = (row: [`DataRow`](../../../lib/core/datatable/data/data-row.model.ts), column: [`DataColumn`](../../../lib/core/datatable/data/data-column.model.ts)) => `string` - _row:_ [`DataRow`](../../../lib/core/datatable/data/data-row.model.ts) - Data that defines the row - _column:_ [`DataColumn`](../../../lib/core/datatable/data/data-column.model.ts) - Data that defines the column - **Returns** File path for the image diff --git a/docs/content-services/models/row-filter.model.md b/docs/content-services/models/row-filter.model.md index 9107ff37d5..894c8c4530 100644 --- a/docs/content-services/models/row-filter.model.md +++ b/docs/content-services/models/row-filter.model.md @@ -11,7 +11,7 @@ Defines the Row Filter function used by the [Document List Component](../compone ## Definitions -- `type` **RowFilter** = (value: [`ShareDataRow`](../../../lib/content-services/document-list/data/share-data-row.model.ts), index: `number`, array: [`ShareDataRow`](../../../lib/content-services/document-list/data/share-data-row.model.ts)`[]`) => any +- `type` **[RowFilter](../../../lib/content-services/document-list/data/row-filter.model.ts)** = (value: [`ShareDataRow`](../../../lib/content-services/document-list/data/share-data-row.model.ts), index: `number`, array: [`ShareDataRow`](../../../lib/content-services/document-list/data/share-data-row.model.ts)`[]`) => any - _value:_ [`ShareDataRow`](../../../lib/content-services/document-list/data/share-data-row.model.ts) - Data that defines the row - _index:_ `number` - Index of the row within the list - _array:_ [`ShareDataRow`](../../../lib/content-services/document-list/data/share-data-row.model.ts)`[]` - The full set of rows for the list diff --git a/docs/content-services/services/custom-resources.service.md b/docs/content-services/services/custom-resources.service.md index a969fd6898..4041a54945 100644 --- a/docs/content-services/services/custom-resources.service.md +++ b/docs/content-services/services/custom-resources.service.md @@ -23,10 +23,11 @@ Manages Document List information that is specific to a user. - _node:_ `any` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) object - _nodeId:_ `string` - ID of the node object - **Returns** `string` - ID value -- **getRecentFiles**(personId: `string`, pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/NodePaging.md)`>`
+- **getRecentFiles**(personId: `string`, pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), filters?: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/NodePaging.md)`>`
Gets files recently accessed by a user. - _personId:_ `string` - ID of the user - _pagination:_ [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results + - _filters:_ `string[]` - (Optional) Specifies additional filters to apply (joined with **AND**) - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/NodePaging.md)`>` - List of nodes for the recently used files - **hasCorrespondingNodeIds**(nodeId: `string`): `boolean`
Does the well-known alias have a corresponding node ID? diff --git a/docs/content-services/services/document-actions.service.md b/docs/content-services/services/document-actions.service.md index 7fb31d2ba2..5a6001abc3 100644 --- a/docs/content-services/services/document-actions.service.md +++ b/docs/content-services/services/document-actions.service.md @@ -17,14 +17,14 @@ Implements the document menu actions for the [Document List component](../compon Checks if actions can be executed for an item. - _nodeEntry:_ [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) - Item to receive an action - **Returns** `boolean` - True if the action can be executed on this item, false otherwise -- **getHandler**(key: `string`): `ContentActionHandler`
+- **getHandler**(key: `string`): [`ContentActionHandler`](../../../lib/content-services/document-list/models/content-action.model.ts)
Gets the handler for an action. - _key:_ `string` - Identifier of the action - - **Returns** `ContentActionHandler` - The handler for the action -- **setHandler**(key: `string`, handler: `ContentActionHandler`): `boolean`
+ - **Returns** [`ContentActionHandler`](../../../lib/content-services/document-list/models/content-action.model.ts) - The handler for the action +- **setHandler**(key: `string`, handler: [`ContentActionHandler`](../../../lib/content-services/document-list/models/content-action.model.ts)): `boolean`
Sets a new handler for an action. - _key:_ `string` - Identifier of the action - - _handler:_ `ContentActionHandler` - Handler for the action + - _handler:_ [`ContentActionHandler`](../../../lib/content-services/document-list/models/content-action.model.ts) - Handler for the action - **Returns** `boolean` - False if the key was an empty/null string, true otherwise ## Details diff --git a/docs/content-services/services/document-list.service.md b/docs/content-services/services/document-list.service.md index 9daf4d3ef4..139b0795ea 100644 --- a/docs/content-services/services/document-list.service.md +++ b/docs/content-services/services/document-list.service.md @@ -13,22 +13,15 @@ Implements node operations used by the [Document List component](../components/d ### Methods -- **copyNode**(nodeId: `string`, targetParentId: `string`): `any`
+- **copyNode**(nodeId: `string`, targetParentId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`
Copy a node to destination node - _nodeId:_ `string` - The id of the node to be copied - _targetParentId:_ `string` - The id of the folder where the node will be copied - - **Returns** `any` - [NodeEntry](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) for the copied node + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - NodeEntry for the copied node - **deleteNode**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Deletes a node. - _nodeId:_ `string` - ID of the node to delete - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty response when the operation is complete -- **getDefaultMimeTypeIcon**(): `string`
- Gets a default icon for MIME types with no specific icon. - - **Returns** `string` - Path to the icon file -- **getDocumentThumbnailUrl**(node: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)): `string`
- Get thumbnail URL for the given document node. - - _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/development/src/api/content-rest-api/docs/Node.md) to get URL for. - - **Returns** `string` - Thumbnail URL string - **getFolder**(folder: `string`, opts?: `any`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/NodePaging.md)`>`
Gets the folder node with the specified relative name path below the root node. - _folder:_ `string` - Path to folder. @@ -40,20 +33,29 @@ Implements node operations used by the [Document List component](../components/d - _nodeId:_ `string` - ID of the folder node - _includeFields:_ `string[]` - Extra information to include (available options are "aspectNames", "isLink" and "association") - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - Details of the folder -- **getMimeTypeIcon**(mimeType: `string`): `string`
- Gets the icon that represents a MIME type. - - _mimeType:_ `string` - MIME type to get the icon for - - **Returns** `string` - Path to the icon file - **getNode**(nodeId: `string`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`
Gets a node via its node ID. - _nodeId:_ `string` - ID of the target node - _includeFields:_ `string[]` - Extra information to include (available options are "aspectNames", "isLink" and "association") - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - Details of the folder -- **moveNode**(nodeId: `string`, targetParentId: `string`): `any`
+- **isCustomSourceService**(nodeId: `any`): `boolean`
+ + - _nodeId:_ `any` - + - **Returns** `boolean` - + +- **loadFolderByNodeId**(nodeId: `string`, pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), includeFields: `string[]`, where?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DocumentLoaderNode`](../../../lib/content-services/document-list/models/document-folder.model.ts)`>`
+ + - _nodeId:_ `string` - + - _pagination:_ [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - + - _includeFields:_ `string[]` - + - _where:_ `string` - (Optional) + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DocumentLoaderNode`](../../../lib/content-services/document-list/models/document-folder.model.ts)`>` - + +- **moveNode**(nodeId: `string`, targetParentId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`
Moves a node to destination node. - _nodeId:_ `string` - The id of the node to be moved - _targetParentId:_ `string` - The id of the folder where the node will be moved - - **Returns** `any` - [NodeEntry](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) for the moved node + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - NodeEntry for the moved node ## Details diff --git a/docs/content-services/services/folder-actions.service.md b/docs/content-services/services/folder-actions.service.md index fc508d6817..2c1697bfbc 100644 --- a/docs/content-services/services/folder-actions.service.md +++ b/docs/content-services/services/folder-actions.service.md @@ -17,14 +17,14 @@ Implements the folder menu actions for the [Document List component](../componen Checks if an action is available for a particular item. - _nodeEntry:_ [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) - Item to check - **Returns** `boolean` - True if the action is available, false otherwise -- **getHandler**(key: `string`): `ContentActionHandler`
+- **getHandler**(key: `string`): [`ContentActionHandler`](../../../lib/content-services/document-list/models/content-action.model.ts)
Gets the handler function for an action. - _key:_ `string` - Identifier for the action - - **Returns** `ContentActionHandler` - The handler function -- **setHandler**(key: `string`, handler: `ContentActionHandler`): `boolean`
+ - **Returns** [`ContentActionHandler`](../../../lib/content-services/document-list/models/content-action.model.ts) - The handler function +- **setHandler**(key: `string`, handler: [`ContentActionHandler`](../../../lib/content-services/document-list/models/content-action.model.ts)): `boolean`
Sets a new handler function for an action. - _key:_ `string` - Identifier for the action - - _handler:_ `ContentActionHandler` - The new handler function + - _handler:_ [`ContentActionHandler`](../../../lib/content-services/document-list/models/content-action.model.ts) - The new handler function - **Returns** `boolean` - True if the key was a valid action identifier, false otherwise ## Details diff --git a/docs/content-services/services/search-query-builder.service.md b/docs/content-services/services/search-query-builder.service.md index 8b04806a22..ac180cf915 100644 --- a/docs/content-services/services/search-query-builder.service.md +++ b/docs/content-services/services/search-query-builder.service.md @@ -11,14 +11,6 @@ Stores information from all the custom search and faceted search widgets, compil ## Class members -### Events - -| Name | Type | Details | -| --- | --- | --- | -| updated | QueryBody | Raised when query gets updated but before query is executed | -| executed | ResultSetPaging | Raised when query gets executed and results are available | -| error | any | Raised when search api emits internal error | - ### Methods - **addFilterQuery**(query: `string`)
diff --git a/docs/core/components/data-column.component.md b/docs/core/components/data-column.component.md index e8c197b8dc..8d845e8ff2 100644 --- a/docs/core/components/data-column.component.md +++ b/docs/core/components/data-column.component.md @@ -20,7 +20,7 @@ Defines column properties for DataTable, Tasklist, Document List and other compo - [Custom tooltips](#custom-tooltips) - [Column Template](#column-template) - [Styling Techniques](#styling-techniques) - - [Using the `copyContent` option](#using-the-copycontent-option) + - [Using the copyContent option](#using-the-copycontent-option) - [See also](#see-also) ## Basic Usage @@ -303,7 +303,7 @@ Now you can declare columns and assign the `desktop-only` class where needed: ### Using the `copyContent` option When the `copyContent` property is true, a -Clipboard directive +[Clipboard directive](../../core/directives/clipboard.directive.md) is added to each cell in the column. This lets the user copy the cell content to the clipboard with a mouse click. @@ -328,6 +328,7 @@ HTML `` element example: ``` + ## See also - [Document list component](../../content-services/components/document-list.component.md) diff --git a/docs/core/components/datatable.component.md b/docs/core/components/datatable.component.md index 45f125f9a5..8def0c4c8b 100644 --- a/docs/core/components/datatable.component.md +++ b/docs/core/components/datatable.component.md @@ -311,7 +311,7 @@ while the data for the table is loading: } ``` -###Styling transcluded content +\###Styling transcluded content When adding your custom templates you can style them as you like. However, for an out of the box experience, if you want to apply datatable styles to your column you will need to follow this structure: diff --git a/docs/core/components/error-content.component.md b/docs/core/components/error-content.component.md index 08e89eb195..79b32f4789 100644 --- a/docs/core/components/error-content.component.md +++ b/docs/core/components/error-content.component.md @@ -23,7 +23,7 @@ this.router.navigate(['/error', errorCode]); | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| errorCode | `string` | "UNKNOWN" | Error code associated with this error. | +| errorCode | `string` | | Error code associated with this error. | | returnButtonUrl | `string` | "/" | Target URL for the return button. | | secondaryButtonUrl | `string` | "report-issue" | Target URL for the secondary button. | diff --git a/docs/core/components/form-field.component.md b/docs/core/components/form-field.component.md index 8c1b96959d..8416db91b0 100644 --- a/docs/core/components/form-field.component.md +++ b/docs/core/components/form-field.component.md @@ -38,8 +38,8 @@ uses `` components to render the form fields. Forms defined in APS have the following default mappings for the form fields: -| _APS [Form](../../../lib/process-services/task-list/models/form.model.ts) Designer_ Widget | Field Type | Component Type | -| ------------------------------------------------------------------------------------------ | ---------- | -------------- | +| _APS [`Form`](../../../lib/process-services/task-list/models/form.model.ts) Designer_ Widget | Field Type | Component Type | +| -------------------------------------------------------------------------------------------- | ---------- | -------------- | | Text | text | [`TextWidgetComponent`](../../../lib/core/form/components/widgets/text/text.widget.ts) | | Multi-line text | multi-line-text | [`MultilineTextWidgetComponentComponent`](../../../lib/core/form/components/widgets/multiline-text/multiline-text.widget.ts) | | Number | integer | [`NumberWidgetComponent`](../../../lib/core/form/components/widgets/number/number.widget.ts) | diff --git a/docs/core/components/infinite-pagination.component.md b/docs/core/components/infinite-pagination.component.md index 790ed345fb..0ea6844b7a 100644 --- a/docs/core/components/infinite-pagination.component.md +++ b/docs/core/components/infinite-pagination.component.md @@ -40,7 +40,7 @@ Adds "infinite" pagination to the component it is used with. | ---- | ---- | ------------- | ----------- | | isLoading | `boolean` | false | Is a new page loading? | | pageSize | `number` | | Number of items that are added with each "load more" event. | -| target | | | Component that provides custom pagination support. | +| target | [`PaginatedComponent`](../../../lib/core/pagination/paginated-component.interface.ts) | | Component that provides custom pagination support. | ### Events diff --git a/docs/core/components/sidenav-layout.component.md b/docs/core/components/sidenav-layout.component.md index 9909512001..b5a0b87028 100644 --- a/docs/core/components/sidenav-layout.component.md +++ b/docs/core/components/sidenav-layout.component.md @@ -69,13 +69,13 @@ sub-components (note the use of `` in the sub-components' body sect | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | +| direction | `string` | "ltr" | The direction of the layout. 'ltr' or 'rtl' | | expandedSidenav | `boolean` | true | Should the navigation region be expanded initially? | | hideSidenav | `boolean` | false | Toggles showing/hiding the navigation region. | | position | `string` | "start" | The side that the drawer is attached to. Possible values are 'start' and 'end'. | | sidenavMax | `number` | | Maximum size of the navigation region. | | sidenavMin | `number` | | Minimum size of the navigation region. | | stepOver | `number` | | Screen size at which display switches from small screen to large screen configuration. | -| direction | `string` | `ltr` | The direction of the layout. 'ltr' or 'rtl' | ### Events diff --git a/docs/core/components/start-form.component.md b/docs/core/components/start-form.component.md index 75c5488137..d31a41c4fc 100644 --- a/docs/core/components/start-form.component.md +++ b/docs/core/components/start-form.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-06-08 --- -# [Start Form component](../../../lib/core/form/components/start-form.component.ts "Defined in start-form.component.ts") +# [Start Form component](../../../lib/process-services/form/start-form.component.ts "Defined in start-form.component.ts") Displays the Start [`Form`](../../../lib/process-services/task-list/models/form.model.ts) for a process. @@ -42,7 +42,6 @@ Displays the Start [`Form`](../../../lib/process-services/task-list/models/form. | readOnlyForm | `boolean` | false | Is the form read-only (ie, can't be edited)? | | saveMetadata | `boolean` | false | Toggle saving of form metadata. | | showCompleteButton | `boolean` | true | Toggle rendering of the `Complete` outcome button. | -| showDebugButton | `boolean` | false | Toggle debug options. | | showOutcomeButtons | `boolean` | true | Should form outcome buttons be shown? | | showRefreshButton | `boolean` | true | Should the refresh button be shown? | | showSaveButton | `boolean` | true | Toggle rendering of the `Save` outcome button. | diff --git a/docs/core/components/viewer.component.md b/docs/core/components/viewer.component.md index a2a23ea68d..3d917e4c7c 100644 --- a/docs/core/components/viewer.component.md +++ b/docs/core/components/viewer.component.md @@ -24,7 +24,7 @@ See it live: [Viewer Quickstart](https://embed.plnkr.co/iTuG1lFIXfsP95l6bDW6/) - [Custom file parameters](#custom-file-parameters) - [Supported file formats](#supported-file-formats) - [Content Renditions](#content-renditions) - - [Configuring PDF.js library](#configuring-pdf-js-library) + - [Configuring PDF.js library](#configuring-pdfjs-library) - [Extending the Viewer](#extending-the-viewer) - [Custom layout](#custom-layout) - [Printing](#printing) @@ -475,7 +475,7 @@ Note: For the pdf viewer the value has to be within the range of 25 - 1000. "adf-viewer": { "pdf-viewer-scaling": 150 } - + In the same way you can set a default zoom scaling value for the image viewer by adding the following code in `app.config.json`. "adf-viewer": { diff --git a/docs/core/directives/clipboard.directive.md b/docs/core/directives/clipboard.directive.md index 7d586277af..0a29f4839f 100644 --- a/docs/core/directives/clipboard.directive.md +++ b/docs/core/directives/clipboard.directive.md @@ -27,8 +27,8 @@ Copies text to the clipboard. | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| adf-clipboard | `string` | | Translation key or message for the tooltip. | -| clipboard-notification | `string` | | Translation key or message for snackbar notification. | +| message | `string` | | Translation key or message for snackbar notification. | +| placeholder | `string` | | Translation key or message for the tooltip. | | target | [`HTMLInputElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement)` \| `[`HTMLTextAreaElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTextAreaElement) | | Reference to the HTML element containing the text to copy. | ## Details diff --git a/docs/core/services/authentication.service.md b/docs/core/services/authentication.service.md index 17e244bdbf..7e18bb6ab8 100644 --- a/docs/core/services/authentication.service.md +++ b/docs/core/services/authentication.service.md @@ -81,9 +81,9 @@ Provides authentication to ACS and APS. - _password:_ `string` - Password for the login - _rememberMe:_ `boolean` - Stores the user's login details if true - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Object with auth type ("ECM", "BPM" or "ALL") and auth ticket -- **logout**(): `any`
+- **logout**(): [`Observable`](http://reactivex.io/documentation/observable.html)``
Logs the user out. - - **Returns** `any` - Response event called when logout is complete + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Response event called when logout is complete - **setRedirect**(url: [`RedirectionModel`](../../../lib/core/models/redirection.model.ts))
Sets the URL to redirect to after login. - _url:_ [`RedirectionModel`](../../../lib/core/models/redirection.model.ts) - URL to redirect to diff --git a/docs/core/services/card-item-types.service.md b/docs/core/services/card-item-types.service.md index 3aba8f86f6..8da233dd35 100644 --- a/docs/core/services/card-item-types.service.md +++ b/docs/core/services/card-item-types.service.md @@ -13,27 +13,27 @@ Maps type names to field component types for the [Card View component](../compon ### Methods -- **getComponentTypeResolver**(type: `string`, defaultValue: `Type<__type>` = `this.defaultValue`): `DynamicComponentResolveFunction`
- Gets the currently active DynamicComponentResolveFunction for a field type. +- **getComponentTypeResolver**(type: `string`, defaultValue: `Type<__type>` = `this.defaultValue`): [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts)
+ Gets the currently active [DynamicComponentResolveFunction](../../../lib/core/services/dynamic-component-mapper.service.ts) for a field type. - _type:_ `string` - The type whose resolver you want - _defaultValue:_ `Type<__type>` - Default type returned for types that are not yet mapped - - **Returns** `DynamicComponentResolveFunction` - Resolver function + - **Returns** [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts) - Resolver function - **resolveComponentType**(model: [`DynamicComponentModel`](../../../lib/core/services/dynamic-component-mapper.service.ts), defaultValue: `Type<__type>` = `this.defaultValue`): `Type<__type>`
Finds the component type that is needed to render a form field. - _model:_ [`DynamicComponentModel`](../../../lib/core/services/dynamic-component-mapper.service.ts) - [Form](../../../lib/process-services/task-list/models/form.model.ts) field model for the field to render - _defaultValue:_ `Type<__type>` - Default type returned for field types that are not yet mapped. - **Returns** `Type<__type>` - Component type -- **setComponentTypeResolver**(type: `string`, resolver: `DynamicComponentResolveFunction`, override: `boolean` = `true`)
- Sets or optionally replaces a DynamicComponentResolveFunction for a field type. +- **setComponentTypeResolver**(type: `string`, resolver: [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts), override: `boolean` = `true`)
+ Sets or optionally replaces a [DynamicComponentResolveFunction](../../../lib/core/services/dynamic-component-mapper.service.ts) for a field type. - _type:_ `string` - The type whose resolver you want to set - - _resolver:_ `DynamicComponentResolveFunction` - The new resolver function + - _resolver:_ [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts) - The new resolver function - _override:_ `boolean` - The new resolver will only replace an existing one if this parameter is true ## Details The [Card View component](../components/card-view.component.md) uses this service to find the component type that is required to display a particular field type (text, date, etc). The service -maps a type name string to a corresponding `DynamicComponentResolveFunction` that takes a +maps a type name string to a corresponding [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts) that takes a model object as a parameter and returns the component type needed to display that model. The default mapping is shown below: diff --git a/docs/core/services/form-rendering.service.md b/docs/core/services/form-rendering.service.md index 1551307936..011b850746 100644 --- a/docs/core/services/form-rendering.service.md +++ b/docs/core/services/form-rendering.service.md @@ -13,20 +13,20 @@ Maps a form field type string onto the corresponding form [widget component](../ ### Methods -- **getComponentTypeResolver**(type: `string`, defaultValue: `Type<__type>` = `this.defaultValue`): `DynamicComponentResolveFunction`
- Gets the currently active DynamicComponentResolveFunction for a field type. +- **getComponentTypeResolver**(type: `string`, defaultValue: `Type<__type>` = `this.defaultValue`): [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts)
+ Gets the currently active [DynamicComponentResolveFunction](../../../lib/core/services/dynamic-component-mapper.service.ts) for a field type. - _type:_ `string` - The type whose resolver you want - _defaultValue:_ `Type<__type>` - Default type returned for types that are not yet mapped - - **Returns** `DynamicComponentResolveFunction` - Resolver function + - **Returns** [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts) - Resolver function - **resolveComponentType**(model: [`DynamicComponentModel`](../../../lib/core/services/dynamic-component-mapper.service.ts), defaultValue: `Type<__type>` = `this.defaultValue`): `Type<__type>`
Finds the component type that is needed to render a form field. - _model:_ [`DynamicComponentModel`](../../../lib/core/services/dynamic-component-mapper.service.ts) - [Form](../../../lib/process-services/task-list/models/form.model.ts) field model for the field to render - _defaultValue:_ `Type<__type>` - Default type returned for field types that are not yet mapped. - **Returns** `Type<__type>` - Component type -- **setComponentTypeResolver**(type: `string`, resolver: `DynamicComponentResolveFunction`, override: `boolean` = `true`)
- Sets or optionally replaces a DynamicComponentResolveFunction for a field type. +- **setComponentTypeResolver**(type: `string`, resolver: [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts), override: `boolean` = `true`)
+ Sets or optionally replaces a [DynamicComponentResolveFunction](../../../lib/core/services/dynamic-component-mapper.service.ts) for a field type. - _type:_ `string` - The type whose resolver you want to set - - _resolver:_ `DynamicComponentResolveFunction` - The new resolver function + - _resolver:_ [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts) - The new resolver function - _override:_ `boolean` - The new resolver will only replace an existing one if this parameter is true ## Details @@ -34,7 +34,7 @@ Maps a form field type string onto the corresponding form [widget component](../ The [`Form`](../../../lib/process-services/task-list/models/form.model.ts) Field component uses this service to choose which widget to use to render an instance of a form field. The [`Form`](../../../lib/process-services/task-list/models/form.model.ts) Field model stores the field type name as a string (see the table below). The [`Form`](../../../lib/process-services/task-list/models/form.model.ts) Rendering service maintains a mapping between each type name and -a corresponding `DynamicComponentResolveFunction`. The function takes a [`FormFieldModel`](../../core/models/form-field.model.md) object as its argument and +a corresponding [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts). The function takes a [`FormFieldModel`](../../core/models/form-field.model.md) object as its argument and uses the data from the object to determine which widget should be used to render the field. In some cases, the field type string alone is enough to determine the widget type and so the function diff --git a/docs/core/services/notification.service.md b/docs/core/services/notification.service.md index 676af8ef51..28a729fd8e 100644 --- a/docs/core/services/notification.service.md +++ b/docs/core/services/notification.service.md @@ -17,16 +17,16 @@ Shows a notification message with optional feedback. - **dismissSnackMessageAction**()
dismiss the notification snackbar -- **openSnackMessage**(message: `string`, config: `number|MatSnackBarConfig` = [`NotificationService`](../../core/services/notification.service.md)`.DEFAULT_DURATION_MESSAGE`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)``
+- **openSnackMessage**(message: `string`, config?: `number|MatSnackBarConfig`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)``
Opens a SnackBar notification to show a message. - _message:_ `string` - The message (or resource key) to show. - - _config:_ `number|MatSnackBarConfig` - Time before notification disappears after being shown or MatSnackBarConfig object + - _config:_ `number|MatSnackBarConfig` - (Optional) Time before notification disappears after being shown or MatSnackBarConfig object - **Returns** [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`` - Information/control object for the SnackBar -- **openSnackMessageAction**(message: `string`, action: `string`, config: `number|MatSnackBarConfig` = [`NotificationService`](../../core/services/notification.service.md)`.DEFAULT_DURATION_MESSAGE`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)``
+- **openSnackMessageAction**(message: `string`, action: `string`, config?: `number|MatSnackBarConfig`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)``
Opens a SnackBar notification with a message and a response button. - _message:_ `string` - The message (or resource key) to show. - _action:_ `string` - Caption for the response button - - _config:_ `number|MatSnackBarConfig` - Time before notification disappears after being shown or MatSnackBarConfig object + - _config:_ `number|MatSnackBarConfig` - (Optional) Time before notification disappears after being shown or MatSnackBarConfig object - **Returns** [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`` - Information/control object for the SnackBar ## Details @@ -93,11 +93,10 @@ export class MyComponent implements OnInit { } } ``` + The default message duration is 5000 ms that is used only if you don't pass a custom duration in the parameters of openSnackMessageAction/openSnackMessage methods. You can also change the default 5000 ms adding the following configuration in the app.config.json: ```json - "notificationDefaultDuration" : "7000" - ``` diff --git a/docs/core/services/process-content.service.md b/docs/core/services/process-content.service.md index 06da886eb9..df09795d8d 100644 --- a/docs/core/services/process-content.service.md +++ b/docs/core/services/process-content.service.md @@ -18,12 +18,12 @@ Manipulates content related to a Process Instance or Task Instance in APS. - _content:_ `any` - File to associate - _opts:_ `any` - (Optional) Options supported by JS-API - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Details of created content -- **createTaskRelatedContent**(taskId: `string`, file: `any`, opts?: `any`): `any`
+- **createTaskRelatedContent**(taskId: `string`, file: `any`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Associates an uploaded file with a task instance. - _taskId:_ `string` - ID of the target task - _file:_ `any` - File to associate - _opts:_ `any` - (Optional) Options supported by JS-API - - **Returns** `any` - Details of created content + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Details of created content - **createTemporaryRawRelatedContent**(file: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RelatedContentRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/RelatedContentRepresentation.md)`>`
Create temporary related content from an uploaded file. - _file:_ `any` - File to use for content diff --git a/docs/core/services/renditions.service.md b/docs/core/services/renditions.service.md index 3da126c3f3..f3f4220c86 100644 --- a/docs/core/services/renditions.service.md +++ b/docs/core/services/renditions.service.md @@ -13,13 +13,13 @@ Manages prearranged conversions of content to different formats. ### Methods -- **convert**(nodeId: `string`, encoding: `string`, pollingInterval: `number` = `1000`, retries: `number` = `5`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **convert**(nodeId: `string`, encoding: `string`, pollingInterval: `number` = `1000`, retries: `number` = `5`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RenditionEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/RenditionEntry.md)`>`
Repeatedly attempts to create a rendition, through to success or failure. - _nodeId:_ `string` - ID of the target node - _encoding:_ `string` - Name of the rendition encoding - _pollingInterval:_ `number` - Time interval (in milliseconds) between checks for completion - _retries:_ `number` - Number of attempts to make before declaring failure - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - True if the rendition was created, false otherwise + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RenditionEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/RenditionEntry.md)`>` - True if the rendition was created, false otherwise - **createRendition**(nodeId: `string`, encoding: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<__type>`
Creates a rendition for a node. - _nodeId:_ `string` - ID of the target node diff --git a/docs/core/services/storage.service.md b/docs/core/services/storage.service.md index 1b904d49c4..9fd0101998 100644 --- a/docs/core/services/storage.service.md +++ b/docs/core/services/storage.service.md @@ -15,6 +15,8 @@ Stores items in the form of key-value pairs. - **clear**()
Removes all currently stored items. +- **getAppPrefix**()
+ Sets the prefix that is used for the local storage of the app It assigns the string that is defined i the app config, empty prefix otherwise. - **getItem**(key: `string`): `string|null`
Gets an item. - _key:_ `string` - Key to identify the item diff --git a/docs/core/services/user-preferences.service.md b/docs/core/services/user-preferences.service.md index 78e5deac19..ea39b6cc93 100644 --- a/docs/core/services/user-preferences.service.md +++ b/docs/core/services/user-preferences.service.md @@ -43,6 +43,10 @@ Stores preferences for the app and for individual components. - **setStoragePrefix**(value: `string`)
Sets the active storage prefix for preferences. - _value:_ `string` - Name of the prefix +- **setWithoutStore**(property: `string`, value: `any`)
+ Sets a preference property. + - _property:_ `string` - Name of the property + - _value:_ `any` - New value for the property ## Details diff --git a/docs/extensions/services/extension.service.md b/docs/extensions/services/extension.service.md index f3904f526e..53a41f2782 100644 --- a/docs/extensions/services/extension.service.md +++ b/docs/extensions/services/extension.service.md @@ -13,10 +13,10 @@ Manages and runs basic extension functionality. ### Methods -- **evaluateRule**(ruleId: `string`, context: [`RuleContext`](../../../lib/extensions/src/lib/config/rule.extensions.ts)): `boolean`
+- **evaluateRule**(ruleId: `string`, context?: [`RuleContext`](../../../lib/extensions/src/lib/config/rule.extensions.ts)): `boolean`
Evaluates a rule. - _ruleId:_ `string` - ID of the rule to evaluate - - _context:_ [`RuleContext`](../../../lib/extensions/src/lib/config/rule.extensions.ts) - Parameter object for the evaluator with details of app state + - _context:_ [`RuleContext`](../../../lib/extensions/src/lib/config/rule.extensions.ts) - (Optional) (optional) Custom rule execution context. - **Returns** `boolean` - True if the rule passed, false otherwise - **getActionById**(id: `string`): [`ActionRef`](../../../lib/extensions/src/lib/config/action.extensions.ts)
Retrieves an action using its ID value. @@ -30,10 +30,16 @@ Manages and runs basic extension functionality. Retrieves a registered [extension component](../../../lib/extensions/src/lib/services/component-register.service.ts) using its ID value. - _id:_ `string` - The ID value to look for - **Returns** `Type<>` - The component or null if not found -- **getEvaluator**(key: `string`): `RuleEvaluator`
- Retrieves a RuleEvaluator function using its key name. +- **getElements**(key: `string`, fallback: `Array<>` = `[]`): `Array<>`
+ + - _key:_ `string` - + - _fallback:_ `Array<>` - + - **Returns** `Array<>` - + +- **getEvaluator**(key: `string`): [`RuleEvaluator`](../../../lib/extensions/src/lib/config/rule.extensions.ts)
+ Retrieves a [RuleEvaluator](../../../lib/extensions/src/lib/config/rule.extensions.ts) function using its key name. - _key:_ `string` - Key name to look for - - **Returns** `RuleEvaluator` - RuleEvaluator or null if not found + - **Returns** [`RuleEvaluator`](../../../lib/extensions/src/lib/config/rule.extensions.ts) - [RuleEvaluator](../../../lib/extensions/src/lib/config/rule.extensions.ts) or null if not found - **getFeature**(key: `string`): `any[]`
Gets features by key. - _key:_ `string` - Key string, using dot notation diff --git a/docs/process-services-cloud/components/app-list-cloud.component.md b/docs/process-services-cloud/components/app-list-cloud.component.md index 234585d6a8..490ae0f84d 100644 --- a/docs/process-services-cloud/components/app-list-cloud.component.md +++ b/docs/process-services-cloud/components/app-list-cloud.component.md @@ -41,7 +41,6 @@ For example : "alfresco-deployed-apps" : [{"name": "simple-app"}] ``` - ## Class members ### Properties diff --git a/docs/process-services-cloud/components/form-cloud.component.md b/docs/process-services-cloud/components/form-cloud.component.md index 3b75144917..8736b93555 100644 --- a/docs/process-services-cloud/components/form-cloud.component.md +++ b/docs/process-services-cloud/components/form-cloud.component.md @@ -12,6 +12,7 @@ Shows a [`form`](../../../lib/process-services-cloud/src/lib/form/models/form-cl ## Contents - [Basic Usage](#basic-usage) + - [Custom form outcomes template](#custom-form-outcomes-template) - [Empty form template](#empty-form-template) - [Class members](#class-members) - [Properties](#properties) @@ -98,6 +99,7 @@ The template defined inside `empty-form` will be shown when no form definition i | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when any error occurs. | | executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. | | formCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormCloud`](../../../lib/process-services-cloud/src/lib/form/models/form-cloud.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. | +| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | | | formDataRefreshed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormCloud`](../../../lib/process-services-cloud/src/lib/form/models/form-cloud.model.ts)`>` | Emitted when form values are refreshed due to a data property change. | | formError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormFieldModel`](../../core/models/form-field.model.md)`[]>` | Emitted when the supplied form values have a validation error. | | formLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormCloud`](../../../lib/process-services-cloud/src/lib/form/models/form-cloud.model.ts)`>` | Emitted when the form is loaded or reloaded. | diff --git a/docs/process-services-cloud/components/form-definition-selector-cloud.component.md b/docs/process-services-cloud/components/form-definition-selector-cloud.component.md index c4ee8d865a..2da112cdc3 100644 --- a/docs/process-services-cloud/components/form-definition-selector-cloud.component.md +++ b/docs/process-services-cloud/components/form-definition-selector-cloud.component.md @@ -1,5 +1,4 @@ - -# [Form Definition Selector Cloud](../../../lib/process-services-cloud/src/lib/form-definition-selector/components/form-definition-selector-cloud.component.ts "Defined in form-definition-selector-cloud.component.ts") +# [Form Definition Selector Cloud](../../../lib/process-services-cloud/src/lib/form/components/form-definition-selector-cloud.component.ts "Defined in form-definition-selector-cloud.component.ts") Allows one form to be selected. @@ -18,10 +17,10 @@ Allows one form to be selected. | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| appName | `string` | | (**required**) Name of the application. If specified, this shows the users who have access to the app. +| appName | `string` | | Name of the application. If specified, this shows the users who have access to the app. | ### Events | Name | Type | Description | | ---- | ---- | ----------- | -| selectForm | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`string`](../../../lib/core/userinfo/models/identity-user.model.ts)`>` | Emitted when a form is selected. | +| selectForm | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a form is selected. | diff --git a/docs/process-services-cloud/components/people-cloud.component.md b/docs/process-services-cloud/components/people-cloud.component.md index f42dce375f..da3cc9df6b 100644 --- a/docs/process-services-cloud/components/people-cloud.component.md +++ b/docs/process-services-cloud/components/people-cloud.component.md @@ -28,8 +28,8 @@ Allows one or more users to be selected (with auto-suggestion) based on the inpu | mode | `string` | | User selection mode (single/multiple). | | preSelectUsers | [`IdentityUserModel`](../../../lib/core/userinfo/models/identity-user.model.ts)`[]` | | Array of users to be pre-selected. All users in the array are pre-selected in multi selection mode, but only the first user is pre-selected in single selection mode. Mandatory properties are: id, email, username | | roles | `string[]` | | Role names of the users to be listed. | -| validate | `Boolean` | false | This flag enables the validation on the preSelectUsers passed as input. In case the flag is true the components call the identity service to verify the validity of the information passed as input. Otherwise, no check will be done. | -| title | `string` | | Translation key for the input placeholder | +| title | `string` | | Placeholder translation key | +| validate | `Boolean` | false | This flag enables the validation on the preSelectUsers passed as input. In case the flag is true the components call the [identity service](../../../lib/testing/src/lib/core/actions/identity/identity.service.ts) to verify the validity of the information passed as input. Otherwise, no check will be done. | ### Events diff --git a/docs/process-services-cloud/components/process-list-cloud.component.md b/docs/process-services-cloud/components/process-list-cloud.component.md index 07036c0723..5b12220bed 100644 --- a/docs/process-services-cloud/components/process-list-cloud.component.md +++ b/docs/process-services-cloud/components/process-list-cloud.component.md @@ -50,7 +50,7 @@ when the process list is empty: | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| appName | `string` | "" | The name of the application. | +| appName | `string` | | The name of the application. | | businessKey | `string` | "" | Filter the processes to display only the ones with this businessKey value. | | id | `string` | "" | Filter the processes to display only the ones with this ID. | | initiator | `string` | "" | Name of the initiator of the process. | @@ -190,7 +190,6 @@ The configuration related to the pagination can be changed from the `app.config. "size": 20, "supportedPageSizes": [ 5, 10, 15, 20 ] }, - ``` ## See also diff --git a/docs/process-services-cloud/services/form-cloud.service.md b/docs/process-services-cloud/services/form-cloud.service.md index aeca24c579..0c06cef312 100644 --- a/docs/process-services-cloud/services/form-cloud.service.md +++ b/docs/process-services-cloud/services/form-cloud.service.md @@ -40,6 +40,11 @@ class MyComponent { - _nodeId:_ `any` - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - +- **getBasePath**(appName: `string`): `string`
+ + - _appName:_ `string` - + - **Returns** `string` - + - **getForm**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets a form definition. - _appName:_ `string` - Name of the app @@ -82,4 +87,4 @@ class MyComponent { ## See also -- [Form cloud component](../components/form-cloud.component.md) +- [Form cloud component](../components/form-cloud.component.md) diff --git a/docs/process-services-cloud/services/process-header-cloud.service.md b/docs/process-services-cloud/services/process-header-cloud.service.md index 381fc9a2ae..bdabe7fdeb 100644 --- a/docs/process-services-cloud/services/process-header-cloud.service.md +++ b/docs/process-services-cloud/services/process-header-cloud.service.md @@ -13,6 +13,11 @@ Manages cloud process instances. ### Methods +- **getBasePath**(appName: `string`): `string`
+ + - _appName:_ `string` - + - **Returns** `string` - + - **getProcessInstanceById**(appName: `string`, processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>`
Gets details of a process instance. - _appName:_ `string` - Name of the app diff --git a/docs/process-services-cloud/services/process-list-cloud.service.md b/docs/process-services-cloud/services/process-list-cloud.service.md index dc0261825d..30d836300b 100644 --- a/docs/process-services-cloud/services/process-list-cloud.service.md +++ b/docs/process-services-cloud/services/process-list-cloud.service.md @@ -13,6 +13,11 @@ Searches processes. ### Methods +- **getBasePath**(appName: `string`): `string`
+ + - _appName:_ `string` - + - **Returns** `string` - + - **getProcessByRequest**(requestNode: [`ProcessQueryCloudRequestModel`](../../../lib/process-services-cloud/src/lib/process/process-list/models/process-cloud-query-request.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
Finds a process using an object with optional query properties. - _requestNode:_ [`ProcessQueryCloudRequestModel`](../../../lib/process-services-cloud/src/lib/process/process-list/models/process-cloud-query-request.model.ts) - Query object @@ -36,4 +41,4 @@ For example : ## See also -- [App list cloud component](../components/app-list-cloud.component.md) +- [App list cloud component](../components/app-list-cloud.component.md) diff --git a/docs/process-services-cloud/services/start-process-cloud.service.md b/docs/process-services-cloud/services/start-process-cloud.service.md index fa3c19b55e..466a9017b8 100644 --- a/docs/process-services-cloud/services/start-process-cloud.service.md +++ b/docs/process-services-cloud/services/start-process-cloud.service.md @@ -13,6 +13,11 @@ Gets process definitions and starts processes. ### Methods +- **getBasePath**(appName: `string`): `string`
+ + - _appName:_ `string` - + - **Returns** `string` - + - **getProcessDefinitions**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-definition-cloud.model.ts)`[]>`
Gets the process definitions associated with an app. - _appName:_ `string` - Name of the target app diff --git a/docs/process-services-cloud/services/start-task-cloud.service.md b/docs/process-services-cloud/services/start-task-cloud.service.md index d9aa6f3a35..05632e5dab 100644 --- a/docs/process-services-cloud/services/start-task-cloud.service.md +++ b/docs/process-services-cloud/services/start-task-cloud.service.md @@ -17,6 +17,10 @@ Starts standalone tasks. Creates a new standalone task. - _taskDetails:_ [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) - Details of the task to create - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Details of the newly created task +- **getBasePath**(appName: `string`): `string`
+ + - _appName:_ `string` - + - **Returns** `string` - ## Details diff --git a/docs/process-services-cloud/services/task-cloud.service.md b/docs/process-services-cloud/services/task-cloud.service.md index 23ff3ae9dc..8589f850a3 100644 --- a/docs/process-services-cloud/services/task-cloud.service.md +++ b/docs/process-services-cloud/services/task-cloud.service.md @@ -36,6 +36,11 @@ Manages task cloud. - _appName:_ `string` - Name of the app - _taskId:_ `string` - ID of the task to complete - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Details of the task that was completed +- **getBasePath**(appName: `string`): `string`
+ + - _appName:_ `string` - + - **Returns** `string` - + - **getTaskById**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
Gets details of a task. - _appName:_ `string` - Name of the app diff --git a/docs/process-services-cloud/services/task-list-cloud.service.md b/docs/process-services-cloud/services/task-list-cloud.service.md index 36ab32c940..9151185ceb 100644 --- a/docs/process-services-cloud/services/task-list-cloud.service.md +++ b/docs/process-services-cloud/services/task-list-cloud.service.md @@ -13,6 +13,11 @@ Searches tasks. ### Methods +- **getBasePath**(appName: `string`): `string`
+ + - _appName:_ `string` - + - **Returns** `string` - + - **getTaskByRequest**(requestNode: [`TaskQueryCloudRequestModel`](../../../lib/process-services-cloud/src/lib/task/task-list/models/filter-cloud-model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
Finds a task using an object with optional query properties. - _requestNode:_ [`TaskQueryCloudRequestModel`](../../../lib/process-services-cloud/src/lib/task/task-list/models/filter-cloud-model.ts) - Query object diff --git a/docs/process-services/components/form.component.md b/docs/process-services/components/form.component.md index 351371144c..281684db21 100644 --- a/docs/process-services/components/form.component.md +++ b/docs/process-services/components/form.component.md @@ -7,7 +7,7 @@ Last reviewed: 2019-01-16 # [Form component](../../../lib/process-services/form/form.component.ts "Defined in form.component.ts") -Shows a [`Form`](../../../lib/core/form/components/widgets/core/form.model.ts) from APS +Shows a [`Form`](../../../lib/process-services/task-list/models/form.model.ts) from APS (See it live: [Form Quickstart](https://embed.plnkr.co/YSLXTqb3DtMhVJSqXKkE/)) @@ -67,7 +67,6 @@ Any content in the body of `` will be shown when no form definition is | readOnly | `boolean` | false | Toggle readonly state of the form. Forces all form widgets to render as readonly if enabled. | | saveMetadata | `boolean` | false | Toggle saving of form metadata. | | showCompleteButton | `boolean` | true | Toggle rendering of the `Complete` outcome button. | -| showDebugButton | `boolean` | false | Toggle debug options. | | showRefreshButton | `boolean` | true | Toggle rendering of the `Refresh` button. | | showSaveButton | `boolean` | true | Toggle rendering of the `Save` outcome button. | | showTitle | `boolean` | true | Toggle rendering of the form title. | diff --git a/docs/process-services/components/process-filters.component.md b/docs/process-services/components/process-filters.component.md index 09f63642ee..6f35ad45b1 100644 --- a/docs/process-services/components/process-filters.component.md +++ b/docs/process-services/components/process-filters.component.md @@ -17,7 +17,7 @@ Collection of criteria used to filter process instances, which may be customized - [Events](#events) - [Details](#details) - [How filter the activiti process filters](#how-filter-the-activiti-process-filters) - - [`FilterParamsModel`](../../../lib/process-services/task-list/models/filter.model.ts) + - [FilterParamsModel](#filterparamsmodel) - [See also](#see-also) ## Basic Usage diff --git a/docs/process-services/components/start-process.component.md b/docs/process-services/components/start-process.component.md index fb1e5cee29..7b3eed1271 100644 --- a/docs/process-services/components/start-process.component.md +++ b/docs/process-services/components/start-process.component.md @@ -44,7 +44,7 @@ Starts a process. | processFilterSelector | `boolean` | true | (optional) Parameter to enable selection of process when filtering. | | showSelectProcessDropdown | `boolean` | true | Hide or show the process selection dropdown. | | values | [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.ts) | | Parameter to pass form field values in the start form if one is associated. | -| variables | [`ProcessInstanceVariable`](../../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]` | | Variables in the input to the process [RestVariable](https://github.com/Alfresco/alfresco-js-api/tree/master/src/alfresco-activiti-rest-api/docs/RestVariable.md). | +| variables | [`ProcessInstanceVariable`](../../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]` | | Variables in the input to the process [`RestVariable`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/activiti-rest-api/docs/RestVariable.md). | ### Events diff --git a/docs/process-services/services/process-filter.service.md b/docs/process-services/services/process-filter.service.md index a77588b9e7..6cb6c30fa5 100644 --- a/docs/process-services/services/process-filter.service.md +++ b/docs/process-services/services/process-filter.service.md @@ -17,10 +17,10 @@ Manage Process Filters, which are pre-configured Process Instance queries. Adds a filter. - _filter:_ [`FilterProcessRepresentationModel`](../../../lib/process-services/process-list/models/filter-process.model.ts) - The filter to add - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../../lib/process-services/process-list/models/filter-process.model.ts)`>` - The filter just added -- **callApiProcessFilters**(appId?: `number`): `any`
+- **callApiProcessFilters**(appId?: `number`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`ResultListDataRepresentationUserProcessInstanceFilterRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/activiti-rest-api/docs/ResultListDataRepresentation%C2%ABUserProcessInstanceFilterRepresentation%C2%BB.md)`>`
Calls `getUserProcessInstanceFilters` from the Alfresco JS API. - _appId:_ `number` - (Optional) ID of the target app - - **Returns** `any` - List of filter details + - **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`ResultListDataRepresentationUserProcessInstanceFilterRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/activiti-rest-api/docs/ResultListDataRepresentation%C2%ABUserProcessInstanceFilterRepresentation%C2%BB.md)`>` - List of filter details - **createDefaultFilters**(appId: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../../lib/process-services/process-list/models/filter-process.model.ts)`[]>`
Creates and returns the default filters for an app. - _appId:_ `number` - ID of the target app diff --git a/docs/process-services/services/process.service.md b/docs/process-services/services/process.service.md index 644c1e6c5c..d95a63c6d1 100644 --- a/docs/process-services/services/process.service.md +++ b/docs/process-services/services/process.service.md @@ -17,10 +17,10 @@ Manages process instances, process variables, and process audit Log. Cancels a process instance. - _processInstanceId:_ `string` - ID of process to cancel - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null response notifying when the operation is complete -- **createOrUpdateProcessInstanceVariables**(processInstanceId: `string`, variables: `RestVariable[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceVariable`](../../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]>`
+- **createOrUpdateProcessInstanceVariables**(processInstanceId: `string`, variables: [`RestVariable`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/activiti-rest-api/docs/RestVariable.md)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceVariable`](../../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]>`
Creates or updates variables for a process instance. - _processInstanceId:_ `string` - ID of the target process - - _variables:_ `RestVariable[]` - Variables to update + - _variables:_ [`RestVariable`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/activiti-rest-api/docs/RestVariable.md)`[]` - Variables to update - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceVariable`](../../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]>` - Array of instance variable info - **deleteProcessInstanceVariable**(processInstanceId: `string`, variableName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Deletes a variable for a process instance. @@ -39,10 +39,10 @@ Manages process instances, process variables, and process audit Log. Gets Process Instance metadata. - _processInstanceId:_ `string` - ID of the target process - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstance`](../../../lib/process-services/process-list/models/process-instance.model.ts)`>` - Metadata for the instance -- **getProcessDefinitions**(appId?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionRepresentation`](../../../lib/process-services/process-list/models/process-definition.model.ts)`[]>`
+- **getProcessDefinitions**(appId?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/activiti-rest-api/docs/ProcessDefinitionRepresentation.md)`[]>`
Gets process definitions associated with an app. - _appId:_ `number` - (Optional) ID of a target app - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionRepresentation`](../../../lib/process-services/process-list/models/process-definition.model.ts)`[]>` - Array of process definitions + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/activiti-rest-api/docs/ProcessDefinitionRepresentation.md)`[]>` - Array of process definitions - **getProcessInstanceVariables**(processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceVariable`](../../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]>`
Gets the variables for a process instance. - _processInstanceId:_ `string` - ID of the target process diff --git a/docs/process-services/services/tasklist.service.md b/docs/process-services/services/tasklist.service.md index da5d24525c..fe3b84a713 100644 --- a/docs/process-services/services/tasklist.service.md +++ b/docs/process-services/services/tasklist.service.md @@ -36,10 +36,10 @@ Manages Task Instances. Claims a task for the current user. - _taskId:_ `string` - ID of the task to claim - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/task-list/models/task-details.model.ts)`>` - Details of the claimed task -- **completeTask**(taskId: `string`): `any`
+- **completeTask**(taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gives completed status to a task. - _taskId:_ `string` - ID of the target task - - **Returns** `any` - Null response notifying when the operation is complete + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null response notifying when the operation is complete - **createNewTask**(task: [`TaskDetailsModel`](../../../lib/process-services/task-list/models/task-details.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/task-list/models/task-details.model.ts)`>`
Creates a new standalone task. - _task:_ [`TaskDetailsModel`](../../../lib/process-services/task-list/models/task-details.model.ts) - Details of the new task @@ -110,7 +110,7 @@ Manages Task Instances. - **updateTask**(taskId: `any`, updated: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/task-list/models/task-details.model.ts)`>`
Updates the details (name, description, due date) for a task. - _taskId:_ `any` - ID of the task to update - - _updated:_ `any` - Data to update the task (as a `TaskUpdateRepresentation` instance). + - _updated:_ `any` - Data to update the task (as a [`TaskUpdateRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/activiti-rest-api/docs/TaskUpdateRepresentation.md) instance). - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/task-list/models/task-details.model.ts)`>` - Updated task details ## Details diff --git a/docs/release-notes/RelNote161.md b/docs/release-notes/RelNote161.md index 6e43800c37..495e8d9944 100644 --- a/docs/release-notes/RelNote161.md +++ b/docs/release-notes/RelNote161.md @@ -422,8 +422,8 @@ Below you can find a detailed list of tickets addressed in the new release. For - \[[ADF-810](https://issues.alfresco.com/jira/browse/ADF-810)] - Radio button list is selecting the first value behind the scenes when nothing is selected - 1963 Github - \[[ADF-833](https://issues.alfresco.com/jira/browse/ADF-833)] - Data table - single and double click - \[[ADF-842](https://issues.alfresco.com/jira/browse/ADF-842)] - Error is received in console log when a form is completed -- \[[ADF-883](https://issues.alfresco.com/jira/browse/ADF-883)] - [`UserInfo`](../../lib/content-services/document-list/models/document-library.model.ts) - Build errors -- \[[ADF-884](https://issues.alfresco.com/jira/browse/ADF-884)] - [`FormComponent`](../core/components/form.component.md) - Compilation error +- \[[ADF-883](https://issues.alfresco.com/jira/browse/ADF-883)] - [`UserInfo`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/UserInfo.md) - Build errors +- \[[ADF-884](https://issues.alfresco.com/jira/browse/ADF-884)] - [`FormComponent`](../process-services/components/form.component.md) - Compilation error - \[[ADF-893](https://issues.alfresco.com/jira/browse/ADF-893)] - Create Attachment Task/Process - Compilation error - \[[ADF-897](https://issues.alfresco.com/jira/browse/ADF-897)] - ActivitiPeopleList - use the prexif adf - \[[ADF-906](https://issues.alfresco.com/jira/browse/ADF-906)] - data property on activiti-form component do not react on changes - 2007 Github diff --git a/docs/release-notes/RelNote170.md b/docs/release-notes/RelNote170.md index 272311d50a..337110e61a 100644 --- a/docs/release-notes/RelNote170.md +++ b/docs/release-notes/RelNote170.md @@ -246,8 +246,8 @@ Two new methods has been added into the alfresco-js-api to support retrieve the | API | Name | HTTP method | URL | Description | | --- | ---- | ----------- | --- | ----------- | -| _ActivitiPublicRestApi.TaskApi_ | [**getTaskAuditJson**](https://github.com/Alfresco/alfresco-js-api/blob/a82ce3bbe56cb0944f8771d14193704b571adf96/src/alfresco-activiti-rest-api/docs/TaskApi.md#getTaskAuditJson) | **GET** | /api/enterprise/tasks/{taskId}/audit | Retrieve audit infromation in json format | -| _ActivitiPublicRestApi.TaskApi_ | [**getTaskAuditPdf**](https://github.com/Alfresco/alfresco-js-api/blob/a82ce3bbe56cb0944f8771d14193704b571adf96/src/alfresco-activiti-rest-api/docs/TaskApi.md#getTaskAuditPdf) | **GET** | /app/rest/tasks/{taskId}/audit | Retrieve the task audit infromation in pdf format | +| _ActivitiPublicRestApi.[TaskApi](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api-legacy/activiti-rest-api/docs/TaskApi.md)_ | [**getTaskAuditJson**](https://github.com/Alfresco/alfresco-js-api/blob/a82ce3bbe56cb0944f8771d14193704b571adf96/src/alfresco-activiti-rest-api/docs/TaskApi.md#getTaskAuditJson) | **GET** | /api/enterprise/tasks/{taskId}/audit | Retrieve audit infromation in json format | +| _ActivitiPublicRestApi.[TaskApi](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api-legacy/activiti-rest-api/docs/TaskApi.md)_ | [**getTaskAuditPdf**](https://github.com/Alfresco/alfresco-js-api/blob/a82ce3bbe56cb0944f8771d14193704b571adf96/src/alfresco-activiti-rest-api/docs/TaskApi.md#getTaskAuditPdf) | **GET** | /app/rest/tasks/{taskId}/audit | Retrieve the task audit infromation in pdf format | For further details about those endepoints please refer to the [official documentation](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/TaskApi.md) @@ -343,7 +343,7 @@ Release Notes - Apps Development Framework - Version 1.7. - \[[ADF-819](https://issues.alfresco.com/jira/browse/ADF-819)] - Snackbar does not appear when uploading files via DnD - \[[ADF-923](https://issues.alfresco.com/jira/browse/ADF-923)] - Involved user should not be able to see 'Complete' button as active in a task. - \[[ADF-939](https://issues.alfresco.com/jira/browse/ADF-939)] - [Login] Sign in button does not stay at the bottom -- \[[ADF-943](https://issues.alfresco.com/jira/browse/ADF-943)] - APS ContentApi is not present on index.d.ts and SitesApi is not complete +- \[[ADF-943](https://issues.alfresco.com/jira/browse/ADF-943)] - APS [ContentApi](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/api/content.api.ts) is not present on index.d.ts and [SitesApi](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/api/sites.api.ts) is not complete - \[[ADF-945](https://issues.alfresco.com/jira/browse/ADF-945)] - 'Undefined' is displayed in 'attach file' widget after restore. - \[[ADF-950](https://issues.alfresco.com/jira/browse/ADF-950)] - when the [`Form`](../../lib/process-services/task-list/models/form.model.ts) in readonly mode you can edit the date - \[[ADF-957](https://issues.alfresco.com/jira/browse/ADF-957)] - Duplicate Rest calls are made for fields where Rest end points are given diff --git a/docs/release-notes/RelNote190.md b/docs/release-notes/RelNote190.md index 6889541ad8..7daf7ca80b 100644 --- a/docs/release-notes/RelNote190.md +++ b/docs/release-notes/RelNote190.md @@ -350,7 +350,7 @@ Release Notes - Apps Development Framework - Version 1.9. - \[[ADF-1249](https://issues.alfresco.com/jira/browse/ADF-1249)] - Remove mdl from ng2-activiti-diagrams - \[[ADF-1250](https://issues.alfresco.com/jira/browse/ADF-1250)] - Remove mdl from ng2-activiti-analytics - \[[ADF-1251](https://issues.alfresco.com/jira/browse/ADF-1251)] - Remove mdl from demo shell -- \[[ADF-1492](https://issues.alfresco.com/jira/browse/ADF-1492)] - Document List - Export [`ContentNodeSelectorComponent`](../content-services/components/content-node-selector.component.md) and [ContentNodeSelectorComponentData](../../lib/content-services/content-node-selector/content-node-selector.component-data.interface.ts) +- \[[ADF-1492](https://issues.alfresco.com/jira/browse/ADF-1492)] - Document List - Export [`ContentNodeSelectorComponent`](../content-services/components/content-node-selector.component.md) and [`ContentNodeSelectorComponentData`](../../lib/content-services/content-node-selector/content-node-selector.component-data.interface.ts) - \[[ADF-1496](https://issues.alfresco.com/jira/browse/ADF-1496)] - Remove "Disable upload button when user has no permissions" switch. - \[[ADF-1504](https://issues.alfresco.com/jira/browse/ADF-1504)] - Rename UserInfoComponentModule to [`UserInfoModule`](../../lib/core/userinfo/userinfo.module.ts) - \[[ADF-1515](https://issues.alfresco.com/jira/browse/ADF-1515)] - Internationalization - ADF strings review diff --git a/docs/release-notes/RelNote200.md b/docs/release-notes/RelNote200.md index 26ba665fe2..a82a38475d 100644 --- a/docs/release-notes/RelNote200.md +++ b/docs/release-notes/RelNote200.md @@ -232,7 +232,7 @@ For more details please refer to [Upload button documentation](../content-servic ### 8. Register Alfresco file type icons within the mat-icon -All the ADF MIME type icons are now registered into the [MatIconRegistry](https://material.angular.io/components/icon/api). This improvement allows you to use all the icons through the mat-icon tag: +All the ADF MIME type icons are now registered into the [`MatIconRegistry`](https://material.angular.io/components/icon/api). This improvement allows you to use all the icons through the mat-icon tag: ![](images/Untitled.gif) @@ -256,7 +256,7 @@ The [log service](../core/services/log.service.md) provides 6 level of logs: TRA ### 10. Favorite node directive -The [NodeFavoriteDirective](../core/directives/node-favorite.directive.md) instance can be bound to a button to retrieve and manage a favorites node list: +The [`NodeFavoriteDirective`](../core/directives/node-favorite.directive.md) instance can be bound to a button to retrieve and manage a favorites node list: ``` For more details refer to the : -- [Claim task directive](../process-services-cloud/directives/claim-task.directive.md) + +- [Claim task directive](../process-services-cloud/directives/claim-task.directive.md) #### EditTaskComponent allows sorting and actions customization + You can supply various _filter properties_ to edit that will determine which tasks are found by a filter. @@ -88,9 +95,11 @@ displayed in the editor. However, you can also choose which sort properties to show using the `sortProperties` array. For more details refer to the : -- [Edit Task Filter Cloud component](../process-services-cloud/components/edit-task-filter-cloud.component.md) + +- [Edit Task Filter Cloud component](../process-services-cloud/components/edit-task-filter-cloud.component.md) #### EditProcessComponent allow sorting and actions customization + You can supply various _filter properties_ to edit that will determine which tasks are found by a filter. @@ -99,15 +108,18 @@ displayed in the editor. However, you can also choose which properties to show using the `filterProperties` array. For more details refer to the : -- [Edit Process Filter Cloud component](../process-services-cloud/components/edit-process-filter-cloud.component.md) - + +- [Edit Process Filter Cloud component](../process-services-cloud/components/edit-process-filter-cloud.component.md) + #### Complete task directive ```html ``` + For more details refer to the : -- [Complete task directive](../process-services-cloud/directives/complete-task.directive.md) + +- [Complete task directive](../process-services-cloud/directives/complete-task.directive.md) ### Enhanced DocumentList @@ -132,8 +144,9 @@ First, set the `stickyHeader` property of your datatable to `true`: ``` For more details refer to the : -- [Document List Component](../content-services/components/document-list.component.md) -- [DataTable component](../core/components/datatable.component.md) + +- [Document List Component](../content-services/components/document-list.component.md) +- [DataTable component](../core/components/datatable.component.md) ### Enhanced Metadata viewer @@ -165,7 +178,8 @@ Futhermore, you can also exclude specific aspects by adding the `exclude` proper ``` For more details refer to the : -- [Content Metadata Card component](../content-services/components/content-metadata-card.component.md) + +- [Content Metadata Card component](../content-services/components/content-metadata-card.component.md) ### Search pattern highlight @@ -195,17 +209,15 @@ An example query for search highlighting could look like this: } } } - ``` - The example above changes the highlighting prefix and postfix from the default to '¿?' for all fields except the "description" field, which uses '()' instead. The highlight information will then be added in each node entry response. For more details refer to the : -- [Search Filter component highlight](../content-services/components/search-filter.component.md#highlight) +- [Search Filter component highlight](../content-services/components/search-filter.component.md#highlight) ### Facet Intervals @@ -263,8 +275,8 @@ by its `label`. The code snippet just above will result in the following display ![Facet Intervals](../docassets/images/search-facet-intervals.png) For more details refer to the : -- [Facet intervals section of the Search Filter Component docs](../content-services/components/search-filter.component.md#facet-intervals) +- [Facet intervals section of the Search Filter Component docs](../content-services/components/search-filter.component.md#facet-intervals) ### SSO Role AuthGuard @@ -287,7 +299,8 @@ const appRoutes: Routes = [ ``` For more details refer to the : -- [Facet intervals](../core/services/auth-guard-sso-role.service.md) + +- [Facet intervals](../core/services/auth-guard-sso-role.service.md) ### Improved accessibility @@ -326,345 +339,345 @@ Please refer to the [official documentation](http://docs.alfresco.com/) for furt ## Issues addressed Below is the list of JIRA issues that were closed for this release. - + ### Documentation -- [ADF-271](https://issues.alfresco.com/jira/browse/ADF-271) - ADD all valid fields that the tasklist can display - 1643 Github +- [ADF-271](https://issues.alfresco.com/jira/browse/ADF-271) - ADD all valid fields that the tasklist can display - 1643 Github -- [ADF-449](https://issues.alfresco.com/jira/browse/ADF-449) - Missing documentation for content-action in Data table +- [ADF-449](https://issues.alfresco.com/jira/browse/ADF-449) - Missing documentation for content-action in Data table -- [ADF-588](https://issues.alfresco.com/jira/browse/ADF-588) - tasks/processes - more documentation about the available fields +- [ADF-588](https://issues.alfresco.com/jira/browse/ADF-588) - tasks/processes - more documentation about the available fields -- [ADF-3040](https://issues.alfresco.com/jira/browse/ADF-3040) - Markdown templates sometimes add whitespace incorrectly +- [ADF-3040](https://issues.alfresco.com/jira/browse/ADF-3040) - Markdown templates sometimes add whitespace incorrectly -- [ADF-4008](https://issues.alfresco.com/jira/browse/ADF-4008) - Add the documentation for the default columns available in adf-process-list-cloud +- [ADF-4008](https://issues.alfresco.com/jira/browse/ADF-4008) - Add the documentation for the default columns available in adf-process-list-cloud -- [ADF-4146](https://issues.alfresco.com/jira/browse/ADF-4146) - How to migrate an application from ADF 2.6 to ADF 3.0 +- [ADF-4146](https://issues.alfresco.com/jira/browse/ADF-4146) - How to migrate an application from ADF 2.6 to ADF 3.0 -- [ADF-4152](https://issues.alfresco.com/jira/browse/ADF-4152) - Add subfolders to docs library folders to represent class types +- [ADF-4152](https://issues.alfresco.com/jira/browse/ADF-4152) - Add subfolders to docs library folders to represent class types -- [ADF-4160](https://issues.alfresco.com/jira/browse/ADF-4160) - Clarify the behaviour of the InfoDrawer configuration for default * +- [ADF-4160](https://issues.alfresco.com/jira/browse/ADF-4160) - Clarify the behaviour of the InfoDrawer configuration for default \* -- [ADF-4189](https://issues.alfresco.com/jira/browse/ADF-4189) - Improve `allowDropFiles` prop description for Document List docs +- [ADF-4189](https://issues.alfresco.com/jira/browse/ADF-4189) - Improve `allowDropFiles` prop description for Document List docs -- [ADF-4190](https://issues.alfresco.com/jira/browse/ADF-4190) - Fix source file paths generated by auto-linking tools +- [ADF-4190](https://issues.alfresco.com/jira/browse/ADF-4190) - Fix source file paths generated by auto-linking tools -- [ADF-4228](https://issues.alfresco.com/jira/browse/ADF-4228) - Tutorial on how to switch an ADF app to be able to support RTL languages +- [ADF-4228](https://issues.alfresco.com/jira/browse/ADF-4228) - Tutorial on how to switch an ADF app to be able to support RTL languages -- [ADF-4239](https://issues.alfresco.com/jira/browse/ADF-4239) - Update introduction text +- [ADF-4239](https://issues.alfresco.com/jira/browse/ADF-4239) - Update introduction text -- [ADF-4249](https://issues.alfresco.com/jira/browse/ADF-4249) - Doc review for 3.1 +- [ADF-4249](https://issues.alfresco.com/jira/browse/ADF-4249) - Doc review for 3.1 -- [ADF-4260](https://issues.alfresco.com/jira/browse/ADF-4260) - How to migrate an application from ADF 3.0 to ADF 3.1 +- [ADF-4260](https://issues.alfresco.com/jira/browse/ADF-4260) - How to migrate an application from ADF 3.0 to ADF 3.1 -- [ADF-4262](https://issues.alfresco.com/jira/browse/ADF-4262) - Release note for version 3.1.0 +- [ADF-4262](https://issues.alfresco.com/jira/browse/ADF-4262) - Release note for version 3.1.0 -- [ADF-4285](https://issues.alfresco.com/jira/browse/ADF-4285) - The documentation of content metadata component is misleading +- [ADF-4285](https://issues.alfresco.com/jira/browse/ADF-4285) - The documentation of [content metadata component](../../lib/content-services/content-metadata/components/content-metadata/content-metadata.component.ts) is misleading -- [ADF-4294](https://issues.alfresco.com/jira/browse/ADF-4294) - Creating the list of third party Open Source for ADF 3.1 (to be done as last task) +- [ADF-4294](https://issues.alfresco.com/jira/browse/ADF-4294) - Creating the list of third party Open Source for ADF 3.1 (to be done as last task) -- [ADF-4300](https://issues.alfresco.com/jira/browse/ADF-4300) - Add the sort properties for edit task cloud component +- [ADF-4300](https://issues.alfresco.com/jira/browse/ADF-4300) - Add the sort properties for edit task cloud component ### Feature -- [ADF-3497](https://issues.alfresco.com/jira/browse/ADF-3497) - Facet intervals on search filter +- [ADF-3497](https://issues.alfresco.com/jira/browse/ADF-3497) - Facet intervals on search filter -- [ADF-3677](https://issues.alfresco.com/jira/browse/ADF-3677) - SearchQueryBuilderService to support highlight +- [ADF-3677](https://issues.alfresco.com/jira/browse/ADF-3677) - [SearchQueryBuilderService](../content-services/services/search-query-builder.service.md) to support highlight -- [ADF-3735](https://issues.alfresco.com/jira/browse/ADF-3735) - SSO Login Error for login component +- [ADF-3735](https://issues.alfresco.com/jira/browse/ADF-3735) - SSO Login Error for [login component](../core/components/login.component.md) -- [ADF-3798](https://issues.alfresco.com/jira/browse/ADF-3798) - [Demo Shell] [APS2] Show Task list related to a Process +- [ADF-3798](https://issues.alfresco.com/jira/browse/ADF-3798) - [Demo Shell][aps2] Show Task list related to a Process -- [ADF-4003](https://issues.alfresco.com/jira/browse/ADF-4003) - Add roles filtering to PeopleCloudComponent +- [ADF-4003](https://issues.alfresco.com/jira/browse/ADF-4003) - Add roles filtering to [PeopleCloudComponent](../process-services-cloud/components/people-cloud.component.md) -- [ADF-4078](https://issues.alfresco.com/jira/browse/ADF-4078) - Fixed headers in the document list +- [ADF-4078](https://issues.alfresco.com/jira/browse/ADF-4078) - Fixed headers in the document list -- [ADF-4099](https://issues.alfresco.com/jira/browse/ADF-4099) - The metadata group is always showed even though the properties are not there +- [ADF-4099](https://issues.alfresco.com/jira/browse/ADF-4099) - The metadata group is always showed even though the properties are not there -- [ADF-4122](https://issues.alfresco.com/jira/browse/ADF-4122) - Sticky header on DataTable +- [ADF-4122](https://issues.alfresco.com/jira/browse/ADF-4122) - Sticky header on DataTable -- [ADF-4125](https://issues.alfresco.com/jira/browse/ADF-4125) - Simplify extension load in extension module +- [ADF-4125](https://issues.alfresco.com/jira/browse/ADF-4125) - Simplify extension load in extension module -- [ADF-4127](https://issues.alfresco.com/jira/browse/ADF-4127) - Claim a task on the new generation of BPM engines +- [ADF-4127](https://issues.alfresco.com/jira/browse/ADF-4127) - Claim a task on the new generation of BPM engines -- [ADF-4128](https://issues.alfresco.com/jira/browse/ADF-4128) - Task Cloud completion/back +- [ADF-4128](https://issues.alfresco.com/jira/browse/ADF-4128) - Task Cloud completion/back -- [ADF-4162](https://issues.alfresco.com/jira/browse/ADF-4162) - Adding the "includeAll" type of object to the presets configurations of the InforDrawer +- [ADF-4162](https://issues.alfresco.com/jira/browse/ADF-4162) - Adding the "includeAll" type of object to the presets configurations of the InforDrawer -- [ADF-4221](https://issues.alfresco.com/jira/browse/ADF-4221) - Avoiding to show a group of metadata, if any of the properties are empty +- [ADF-4221](https://issues.alfresco.com/jira/browse/ADF-4221) - Avoiding to show a group of metadata, if any of the properties are empty -- [ADF-4225](https://issues.alfresco.com/jira/browse/ADF-4225) - Viewer extension accept multiple file type +- [ADF-4225](https://issues.alfresco.com/jira/browse/ADF-4225) - Viewer extension accept multiple file type -- [ADF-4267](https://issues.alfresco.com/jira/browse/ADF-4267) - Sticky header on Document List +- [ADF-4267](https://issues.alfresco.com/jira/browse/ADF-4267) - Sticky header on Document List ### Epic -- [ADF-9](https://issues.alfresco.com/jira/browse/ADF-9) - Document list feature +- [ADF-9](https://issues.alfresco.com/jira/browse/ADF-9) - Document list feature -- [ADF-14](https://issues.alfresco.com/jira/browse/ADF-14) - Destination picker (copy/move) +- [ADF-14](https://issues.alfresco.com/jira/browse/ADF-14) - Destination picker (copy/move) -- [ADF-262](https://issues.alfresco.com/jira/browse/ADF-262) - File viewer +- [ADF-262](https://issues.alfresco.com/jira/browse/ADF-262) - File viewer -- [ADF-1452](https://issues.alfresco.com/jira/browse/ADF-1452) - Documentation +- [ADF-1452](https://issues.alfresco.com/jira/browse/ADF-1452) - Documentation -- [ADF-1463](https://issues.alfresco.com/jira/browse/ADF-1463) - Adding of automated tests +- [ADF-1463](https://issues.alfresco.com/jira/browse/ADF-1463) - Adding of automated tests -- [ADF-3296](https://issues.alfresco.com/jira/browse/ADF-3296) - APS 2.x & Activiti 7 compatibility +- [ADF-3296](https://issues.alfresco.com/jira/browse/ADF-3296) - APS 2.x & Activiti 7 compatibility -- [ADF-3349](https://issues.alfresco.com/jira/browse/ADF-3349) - Activiti 7+ support +- [ADF-3349](https://issues.alfresco.com/jira/browse/ADF-3349) - Activiti 7+ support -- [ADF-3741](https://issues.alfresco.com/jira/browse/ADF-3741) - Support for Activiti version 7 (and APS 2), maintaining the backward compatibility with APS 1.x. +- [ADF-3741](https://issues.alfresco.com/jira/browse/ADF-3741) - Support for Activiti version 7 (and APS 2), maintaining the backward compatibility with APS 1.x. -- [ADF-3742](https://issues.alfresco.com/jira/browse/ADF-3742) - Extensibility of ADF applications +- [ADF-3742](https://issues.alfresco.com/jira/browse/ADF-3742) - Extensibility of ADF applications -- [ADF-3857](https://issues.alfresco.com/jira/browse/ADF-3857) - Accessibility +- [ADF-3857](https://issues.alfresco.com/jira/browse/ADF-3857) - Accessibility -- [ADF-4246](https://issues.alfresco.com/jira/browse/ADF-4246) - Testing Microsoft Internet Explorer +- [ADF-4246](https://issues.alfresco.com/jira/browse/ADF-4246) - Testing Microsoft Internet Explorer ### Story -- [ADF-2129](https://issues.alfresco.com/jira/browse/ADF-2129) - Results highlighting (P2) +- [ADF-2129](https://issues.alfresco.com/jira/browse/ADF-2129) - Results highlighting (P2) + +- [ADF-3472](https://issues.alfresco.com/jira/browse/ADF-3472) - Whitelisting metadata by default with the ability to hide some of them by configuration + -- [ADF-3472](https://issues.alfresco.com/jira/browse/ADF-3472) - Whitelisting metadata by default with the ability to hide some of them by configuration - ### Bug -- [ADF-1713](https://issues.alfresco.com/jira/browse/ADF-1713) - Small adjustments for Task and Process for consistency - Demo Shell +- [ADF-1713](https://issues.alfresco.com/jira/browse/ADF-1713) - Small adjustments for Task and Process for consistency - Demo Shell -- [ADF-1954](https://issues.alfresco.com/jira/browse/ADF-1954) - [IE11] Breadcrumbs are not well aligned +- [ADF-1954](https://issues.alfresco.com/jira/browse/ADF-1954) - [IE11] Breadcrumbs are not well aligned -- [ADF-2971](https://issues.alfresco.com/jira/browse/ADF-2971) - Mandatory search config +- [ADF-2971](https://issues.alfresco.com/jira/browse/ADF-2971) - Mandatory search config -- [ADF-3401](https://issues.alfresco.com/jira/browse/ADF-3401) - The filter facets are not reseted when user makes a new search query +- [ADF-3401](https://issues.alfresco.com/jira/browse/ADF-3401) - The filter facets are not reseted when user makes a new search query -- [ADF-3444](https://issues.alfresco.com/jira/browse/ADF-3444) - Site list displays only a certain number of sites. +- [ADF-3444](https://issues.alfresco.com/jira/browse/ADF-3444) - Site list displays only a certain number of sites. -- [ADF-3604](https://issues.alfresco.com/jira/browse/ADF-3604) - 'Sign in' and copyrights is displayed on login dialog from 'Attach Folder' from Share. +- [ADF-3604](https://issues.alfresco.com/jira/browse/ADF-3604) - 'Sign in' and copyrights is displayed on login dialog from 'Attach Folder' from Share. -- [ADF-3678](https://issues.alfresco.com/jira/browse/ADF-3678) - Custom Process Filter - Different results in APS than in ADF +- [ADF-3678](https://issues.alfresco.com/jira/browse/ADF-3678) - Custom Process Filter - Different results in APS than in ADF -- [ADF-3843](https://issues.alfresco.com/jira/browse/ADF-3843) - Is not possible to change theInfinite pagination pageSize +- [ADF-3843](https://issues.alfresco.com/jira/browse/ADF-3843) - Is not possible to change theInfinite pagination pageSize -- [ADF-3861](https://issues.alfresco.com/jira/browse/ADF-3861) - [508 compliance] Multi-select, hamburger menu (row-based action menu) should be 508 compliant +- [ADF-3861](https://issues.alfresco.com/jira/browse/ADF-3861) - [508 compliance] Multi-select, hamburger menu (row-based action menu) should be 508 compliant -- [ADF-3862](https://issues.alfresco.com/jira/browse/ADF-3862) - [508 compliance] Documents and images should be readable +- [ADF-3862](https://issues.alfresco.com/jira/browse/ADF-3862) - [508 compliance] Documents and images should be readable -- [ADF-3863](https://issues.alfresco.com/jira/browse/ADF-3863) - [508 compliance] The user should be informed of what the label is that he/she is selecting +- [ADF-3863](https://issues.alfresco.com/jira/browse/ADF-3863) - [508 compliance] The user should be informed of what the label is that he/she is selecting -- [ADF-3878](https://issues.alfresco.com/jira/browse/ADF-3878) - Created date value of Column column should be in upper case +- [ADF-3878](https://issues.alfresco.com/jira/browse/ADF-3878) - Created date value of Column column should be in upper case -- [ADF-3934](https://issues.alfresco.com/jira/browse/ADF-3934) - People Cloud Component - Remove the concept of assignee +- [ADF-3934](https://issues.alfresco.com/jira/browse/ADF-3934) - [People Cloud Component](../process-services-cloud/components/people-cloud.component.md) - Remove the concept of assignee -- [ADF-3979](https://issues.alfresco.com/jira/browse/ADF-3979) - GroupCloudComponent should be able to detect "preSelectGroups" input changes +- [ADF-3979](https://issues.alfresco.com/jira/browse/ADF-3979) - [GroupCloudComponent](../process-services-cloud/components/group-cloud.component.md) should be able to detect "preSelectGroups" input changes -- [ADF-3989](https://issues.alfresco.com/jira/browse/ADF-3989) - The list of apps in 'appName' filter is duplicated after switching between saved filters +- [ADF-3989](https://issues.alfresco.com/jira/browse/ADF-3989) - The list of apps in 'appName' filter is duplicated after switching between saved filters -- [ADF-3995](https://issues.alfresco.com/jira/browse/ADF-3995) - 'ProcessInstanceId' value is not displayed into a saved filter +- [ADF-3995](https://issues.alfresco.com/jira/browse/ADF-3995) - 'ProcessInstanceId' value is not displayed into a saved filter -- [ADF-4023](https://issues.alfresco.com/jira/browse/ADF-4023) - [Demo-shell] Pagination layout is broken in Process List Cloud +- [ADF-4023](https://issues.alfresco.com/jira/browse/ADF-4023) - [Demo-shell] Pagination layout is broken in Process List Cloud -- [ADF-4058](https://issues.alfresco.com/jira/browse/ADF-4058) - Process Cloud - 502 Bad Gateway when try to create an task or an process +- [ADF-4058](https://issues.alfresco.com/jira/browse/ADF-4058) - Process Cloud - 502 Bad Gateway when try to create an task or an process -- [ADF-4065](https://issues.alfresco.com/jira/browse/ADF-4065) - The input field to add comments is visible when permission is denied. +- [ADF-4065](https://issues.alfresco.com/jira/browse/ADF-4065) - The input field to add comments is visible when permission is denied. -- [ADF-4068](https://issues.alfresco.com/jira/browse/ADF-4068) - Tasks - Able to add a description with spaces +- [ADF-4068](https://issues.alfresco.com/jira/browse/ADF-4068) - Tasks - Able to add a description with spaces -- [ADF-4076](https://issues.alfresco.com/jira/browse/ADF-4076) - Error when accessing Active Task after closing process diagram +- [ADF-4076](https://issues.alfresco.com/jira/browse/ADF-4076) - Error when accessing Active Task after closing process diagram -- [ADF-4097](https://issues.alfresco.com/jira/browse/ADF-4097) - [Demo shell] Add comment button not displayed in Comment section +- [ADF-4097](https://issues.alfresco.com/jira/browse/ADF-4097) - [Demo shell] Add comment button not displayed in Comment section -- [ADF-4143](https://issues.alfresco.com/jira/browse/ADF-4143) - LastModifiedFrom and LastModifiedTo fields of edit task filter cloud component validations are wrong +- [ADF-4143](https://issues.alfresco.com/jira/browse/ADF-4143) - LastModifiedFrom and LastModifiedTo fields of [edit task filter cloud component](../process-services-cloud/components/edit-task-filter-cloud.component.md) validations are wrong -- [ADF-4148](https://issues.alfresco.com/jira/browse/ADF-4148) - [kerberos] Text Viewer Component not passing the withCredentials parameter +- [ADF-4148](https://issues.alfresco.com/jira/browse/ADF-4148) - [kerberos] Text [Viewer Component](../core/components/viewer.component.md) not passing the withCredentials parameter -- [ADF-4153](https://issues.alfresco.com/jira/browse/ADF-4153) - Unable to open the Task Details page. +- [ADF-4153](https://issues.alfresco.com/jira/browse/ADF-4153) - Unable to open the Task Details page. -- [ADF-4154](https://issues.alfresco.com/jira/browse/ADF-4154) - Unit tests failing after upgrade to ADF 3.1.0-beta3 +- [ADF-4154](https://issues.alfresco.com/jira/browse/ADF-4154) - Unit tests failing after upgrade to ADF 3.1.0-beta3 -- [ADF-4156](https://issues.alfresco.com/jira/browse/ADF-4156) - Regression in TaskListComponent Caused by in-place Date Formatting +- [ADF-4156](https://issues.alfresco.com/jira/browse/ADF-4156) - Regression in [TaskListComponent](../process-services/components/task-list.component.md) Caused by in-place Date Formatting -- [ADF-4165](https://issues.alfresco.com/jira/browse/ADF-4165) - ADF 3.0 Not able to login with implicitFlow false +- [ADF-4165](https://issues.alfresco.com/jira/browse/ADF-4165) - ADF 3.0 Not able to login with implicitFlow false -- [ADF-4179](https://issues.alfresco.com/jira/browse/ADF-4179) - adf- prefix missing - style not applied to facet-buttons +- [ADF-4179](https://issues.alfresco.com/jira/browse/ADF-4179) - adf- prefix missing - style not applied to facet-buttons -- [ADF-4183](https://issues.alfresco.com/jira/browse/ADF-4183) - Login dialog does not redirect correctly after page reload +- [ADF-4183](https://issues.alfresco.com/jira/browse/ADF-4183) - Login dialog does not redirect correctly after page reload -- [ADF-4196](https://issues.alfresco.com/jira/browse/ADF-4196) - Datatable component not always selects the row after click +- [ADF-4196](https://issues.alfresco.com/jira/browse/ADF-4196) - Datatable component not always selects the row after click -- [ADF-4199](https://issues.alfresco.com/jira/browse/ADF-4199) - The 'Locally set' permission label is not displayed properly in the UI screen. +- [ADF-4199](https://issues.alfresco.com/jira/browse/ADF-4199) - The 'Locally set' permission label is not displayed properly in the UI screen. -- [ADF-4202](https://issues.alfresco.com/jira/browse/ADF-4202) - Not able to start a standalone task using start task cloud component +- [ADF-4202](https://issues.alfresco.com/jira/browse/ADF-4202) - Not able to start a standalone task using [start task cloud component](../process-services-cloud/components/start-task-cloud.component.md) -- [ADF-4205](https://issues.alfresco.com/jira/browse/ADF-4205) - Error in console when User tries to add user or group to permissions. +- [ADF-4205](https://issues.alfresco.com/jira/browse/ADF-4205) - Error in console when User tries to add user or group to permissions. -- [ADF-4215](https://issues.alfresco.com/jira/browse/ADF-4215) - Locale doesn't change when a user changes the browser locale +- [ADF-4215](https://issues.alfresco.com/jira/browse/ADF-4215) - Locale doesn't change when a user changes the browser locale -- [ADF-4220](https://issues.alfresco.com/jira/browse/ADF-4220) - [SSO] Not able to login with implicitFlow false after changing the config +- [ADF-4220](https://issues.alfresco.com/jira/browse/ADF-4220) - [SSO] Not able to login with implicitFlow false after changing the config -- [ADF-4229](https://issues.alfresco.com/jira/browse/ADF-4229) - Big space issue in case of RTL ADF application +- [ADF-4229](https://issues.alfresco.com/jira/browse/ADF-4229) - Big space issue in case of RTL ADF application -- [ADF-4230](https://issues.alfresco.com/jira/browse/ADF-4230) - Pagination arrows in the wrong order, in case or RTL ADF application +- [ADF-4230](https://issues.alfresco.com/jira/browse/ADF-4230) - Pagination arrows in the wrong order, in case or RTL ADF application -- [ADF-4281](https://issues.alfresco.com/jira/browse/ADF-4281) - Completed processes default filters is not doing the correct call +- [ADF-4281](https://issues.alfresco.com/jira/browse/ADF-4281) - Completed processes default filters is not doing the correct call -- [ADF-4282](https://issues.alfresco.com/jira/browse/ADF-4282) - The name of the content is not well aligned in documentList on small devices +- [ADF-4282](https://issues.alfresco.com/jira/browse/ADF-4282) - The name of the content is not well aligned in documentList on small devices -- [ADF-4287](https://issues.alfresco.com/jira/browse/ADF-4287) - The alignment in datatable is wrong +- [ADF-4287](https://issues.alfresco.com/jira/browse/ADF-4287) - The alignment in datatable is wrong -- [ADF-4301](https://issues.alfresco.com/jira/browse/ADF-4301) - [Accessibility] Not able to navigate through tasks in task list using tab +- [ADF-4301](https://issues.alfresco.com/jira/browse/ADF-4301) - [Accessibility] Not able to navigate through tasks in task list using tab -- [ADF-4305](https://issues.alfresco.com/jira/browse/ADF-4305) - DocumentList - CardViewMode - Field values missing in the display. +- [ADF-4305](https://issues.alfresco.com/jira/browse/ADF-4305) - DocumentList - CardViewMode - Field values missing in the display. -- [ADF-4313](https://issues.alfresco.com/jira/browse/ADF-4313) - [Demo shell] Form field looks like an editable field in task header after task was completed +- [ADF-4313](https://issues.alfresco.com/jira/browse/ADF-4313) - [Demo shell] [Form](../../lib/process-services/task-list/models/form.model.ts) field looks like an editable field in task header after task was completed -- [ADF-4316](https://issues.alfresco.com/jira/browse/ADF-4316) - People component table is not well aligned +- [ADF-4316](https://issues.alfresco.com/jira/browse/ADF-4316) - [People component](../process-services/components/people.component.md) table is not well aligned -- [ADF-4318](https://issues.alfresco.com/jira/browse/ADF-4318) - Process definition is not automatically selected if the app contains more than one +- [ADF-4318](https://issues.alfresco.com/jira/browse/ADF-4318) - Process definition is not automatically selected if the app contains more than one ### Task -- [ADF-3873](https://issues.alfresco.com/jira/browse/ADF-3873) - Create automated tests for edit process filters +- [ADF-3873](https://issues.alfresco.com/jira/browse/ADF-3873) - Create automated tests for edit process filters -- [ADF-3888](https://issues.alfresco.com/jira/browse/ADF-3888) - Implement automated tests for all the properties of task list and edit task filters components +- [ADF-3888](https://issues.alfresco.com/jira/browse/ADF-3888) - Implement automated tests for all the properties of task list and edit task filters components -- [ADF-3976](https://issues.alfresco.com/jira/browse/ADF-3976) - EditTaskComponent - Be able to customise the sorting and actions +- [ADF-3976](https://issues.alfresco.com/jira/browse/ADF-3976) - EditTaskComponent - Be able to customise the sorting and actions -- [ADF-3977](https://issues.alfresco.com/jira/browse/ADF-3977) - EditProcessComponent - Be able to change the sort and actions +- [ADF-3977](https://issues.alfresco.com/jira/browse/ADF-3977) - EditProcessComponent - Be able to change the sort and actions -- [ADF-3978](https://issues.alfresco.com/jira/browse/ADF-3978) - Travis on dev branch - should not run the jobs Create docker pr Deploy docker pr +- [ADF-3978](https://issues.alfresco.com/jira/browse/ADF-3978) - Travis on dev branch - should not run the jobs Create docker pr Deploy docker pr -- [ADF-3981](https://issues.alfresco.com/jira/browse/ADF-3981) - Automate Login Component manual test C291854 +- [ADF-3981](https://issues.alfresco.com/jira/browse/ADF-3981) - Automate [Login Component](../core/components/login.component.md) manual test C291854 -- [ADF-3986](https://issues.alfresco.com/jira/browse/ADF-3986) - [ProcessListCloudComponent] Be able to filter process with all possible params +- [ADF-3986](https://issues.alfresco.com/jira/browse/ADF-3986) - [ProcessListCloudComponent] Be able to filter process with all possible params -- [ADF-4004](https://issues.alfresco.com/jira/browse/ADF-4004) - Automate attach file test case +- [ADF-4004](https://issues.alfresco.com/jira/browse/ADF-4004) - Automate attach file test case -- [ADF-4012](https://issues.alfresco.com/jira/browse/ADF-4012) - Automate ADF-3872 - to be able to set default columns in adf-process-list-cloud +- [ADF-4012](https://issues.alfresco.com/jira/browse/ADF-4012) - Automate ADF-3872 - to be able to set default columns in adf-process-list-cloud -- [ADF-4015](https://issues.alfresco.com/jira/browse/ADF-4015) - automate ADF-3982 - Should be able to filter tasks with all possible params +- [ADF-4015](https://issues.alfresco.com/jira/browse/ADF-4015) - automate ADF-3982 - Should be able to filter tasks with all possible params -- [ADF-4045](https://issues.alfresco.com/jira/browse/ADF-4045) - Automate test infinite pagination delete +- [ADF-4045](https://issues.alfresco.com/jira/browse/ADF-4045) - Automate test infinite pagination delete -- [ADF-4048](https://issues.alfresco.com/jira/browse/ADF-4048) - PeopleCloud - Improve the preselectUsers +- [ADF-4048](https://issues.alfresco.com/jira/browse/ADF-4048) - PeopleCloud - Improve the preselectUsers -- [ADF-4061](https://issues.alfresco.com/jira/browse/ADF-4061) - Automate test for navigating to a non empty folder in >= 2nd page +- [ADF-4061](https://issues.alfresco.com/jira/browse/ADF-4061) - Automate test for navigating to a non empty folder in >= 2nd page -- [ADF-4064](https://issues.alfresco.com/jira/browse/ADF-4064) - Remove multiple elements locators +- [ADF-4064](https://issues.alfresco.com/jira/browse/ADF-4064) - Remove multiple elements locators -- [ADF-4067](https://issues.alfresco.com/jira/browse/ADF-4067) - [APS2] Application Name input should have the same name in all components +- [ADF-4067](https://issues.alfresco.com/jira/browse/ADF-4067) - [APS2] Application Name input should have the same name in all components -- [ADF-4083](https://issues.alfresco.com/jira/browse/ADF-4083) - Parse 'escaped' empty spaced labels inside facetFields or facetIntervals +- [ADF-4083](https://issues.alfresco.com/jira/browse/ADF-4083) - Parse 'escaped' empty spaced labels inside facetFields or facetIntervals -- [ADF-4089](https://issues.alfresco.com/jira/browse/ADF-4089) - contentListPage refactoring +- [ADF-4089](https://issues.alfresco.com/jira/browse/ADF-4089) - contentListPage refactoring -- [ADF-4094](https://issues.alfresco.com/jira/browse/ADF-4094) - Automate Permissions Component +- [ADF-4094](https://issues.alfresco.com/jira/browse/ADF-4094) - Automate Permissions Component -- [ADF-4121](https://issues.alfresco.com/jira/browse/ADF-4121) - Fixing failing e2e tests +- [ADF-4121](https://issues.alfresco.com/jira/browse/ADF-4121) - Fixing failing e2e tests -- [ADF-4123](https://issues.alfresco.com/jira/browse/ADF-4123) - Process Cloud Instance Details Header component +- [ADF-4123](https://issues.alfresco.com/jira/browse/ADF-4123) - Process Cloud Instance Details Header component -- [ADF-4124](https://issues.alfresco.com/jira/browse/ADF-4124) - [Demo Shell] TaskListCloud with the filter on a Process instance +- [ADF-4124](https://issues.alfresco.com/jira/browse/ADF-4124) - [Demo Shell] TaskListCloud with the filter on a Process instance -- [ADF-4132](https://issues.alfresco.com/jira/browse/ADF-4132) - [Artificial Intelligence] Smart viewer for ADF recognising entities +- [ADF-4132](https://issues.alfresco.com/jira/browse/ADF-4132) - [Artificial Intelligence] Smart viewer for ADF recognising entities -- [ADF-4145](https://issues.alfresco.com/jira/browse/ADF-4145) - [Artificial Intelligence] Transformation Services added to the ACS instance in the ADF development pipeline +- [ADF-4145](https://issues.alfresco.com/jira/browse/ADF-4145) - [Artificial Intelligence] Transformation Services added to the ACS instance in the ADF development pipeline -- [ADF-4147](https://issues.alfresco.com/jira/browse/ADF-4147) - Add a way to test selectionMode on demo-shell for task list cloud component +- [ADF-4147](https://issues.alfresco.com/jira/browse/ADF-4147) - Add a way to test selectionMode on demo-shell for [task list cloud component](../process-services-cloud/components/task-list-cloud.component.md) -- [ADF-4149](https://issues.alfresco.com/jira/browse/ADF-4149) - e2e tests - Move the pages from the e2e folder to the adf-testing +- [ADF-4149](https://issues.alfresco.com/jira/browse/ADF-4149) - e2e tests - Move the pages from the e2e folder to the adf-testing -- [ADF-4155](https://issues.alfresco.com/jira/browse/ADF-4155) - AppList - be able to show the list of apps even in case the deployment service is missing +- [ADF-4155](https://issues.alfresco.com/jira/browse/ADF-4155) - AppList - be able to show the list of apps even in case the deployment service is missing -- [ADF-4158](https://issues.alfresco.com/jira/browse/ADF-4158) - No Alfresco-supplied docker image should run as root +- [ADF-4158](https://issues.alfresco.com/jira/browse/ADF-4158) - No Alfresco-supplied docker image should run as root -- [ADF-4159](https://issues.alfresco.com/jira/browse/ADF-4159) - DemoShell add nested-menu +- [ADF-4159](https://issues.alfresco.com/jira/browse/ADF-4159) - DemoShell add nested-menu -- [ADF-4184](https://issues.alfresco.com/jira/browse/ADF-4184) - Add Arabic i18n support +- [ADF-4184](https://issues.alfresco.com/jira/browse/ADF-4184) - Add Arabic i18n support -- [ADF-4192](https://issues.alfresco.com/jira/browse/ADF-4192) - Remove spinner check from editTaskFilter tests +- [ADF-4192](https://issues.alfresco.com/jira/browse/ADF-4192) - Remove spinner check from editTaskFilter tests -- [ADF-4195](https://issues.alfresco.com/jira/browse/ADF-4195) - Automate tests for SSO login with implicitFlow false +- [ADF-4195](https://issues.alfresco.com/jira/browse/ADF-4195) - Automate tests for SSO login with implicitFlow false -- [ADF-4201](https://issues.alfresco.com/jira/browse/ADF-4201) - About component improvements +- [ADF-4201](https://issues.alfresco.com/jira/browse/ADF-4201) - [About component](../core/components/about.component.md) improvements -- [ADF-4208](https://issues.alfresco.com/jira/browse/ADF-4208) - [E2E] Make the pipeline green again ! +- [ADF-4208](https://issues.alfresco.com/jira/browse/ADF-4208) - [E2E] Make the pipeline green again ! -- [ADF-4217](https://issues.alfresco.com/jira/browse/ADF-4217) - [Yeoman generator] Remove APS2 and leave Activiti only. +- [ADF-4217](https://issues.alfresco.com/jira/browse/ADF-4217) - [Yeoman generator] Remove APS2 and leave Activiti only. -- [ADF-4222](https://issues.alfresco.com/jira/browse/ADF-4222) - Fix the compilation errors on the Development branch, so that this can be added to the rules. +- [ADF-4222](https://issues.alfresco.com/jira/browse/ADF-4222) - Fix the compilation errors on the Development branch, so that this can be added to the rules. -- [ADF-4223](https://issues.alfresco.com/jira/browse/ADF-4223) - Export folder-name dialog validators +- [ADF-4223](https://issues.alfresco.com/jira/browse/ADF-4223) - Export folder-name dialog validators -- [ADF-4233](https://issues.alfresco.com/jira/browse/ADF-4233) - DemoShell - Change nested menu layout +- [ADF-4233](https://issues.alfresco.com/jira/browse/ADF-4233) - DemoShell - Change nested menu layout ### Feature (Task) -- [ADF-3945](https://issues.alfresco.com/jira/browse/ADF-3945) - Provide a way to change the infinite pagination pageSize +- [ADF-3945](https://issues.alfresco.com/jira/browse/ADF-3945) - Provide a way to change the infinite pagination pageSize -- [ADF-4038](https://issues.alfresco.com/jira/browse/ADF-4038) - Add appName filter parameter for people/group demo component +- [ADF-4038](https://issues.alfresco.com/jira/browse/ADF-4038) - Add appName filter parameter for people/group demo component -- [ADF-4095](https://issues.alfresco.com/jira/browse/ADF-4095) - Automate C268974 - Inherit Permission +- [ADF-4095](https://issues.alfresco.com/jira/browse/ADF-4095) - Automate C268974 - Inherit Permission -- [ADF-4100](https://issues.alfresco.com/jira/browse/ADF-4100) - Automate C274691 Dropdown menu +- [ADF-4100](https://issues.alfresco.com/jira/browse/ADF-4100) - Automate C274691 Dropdown menu -- [ADF-4101](https://issues.alfresco.com/jira/browse/ADF-4101) - Automate C276978 - Add user +- [ADF-4101](https://issues.alfresco.com/jira/browse/ADF-4101) - Automate C276978 - Add user -- [ADF-4102](https://issues.alfresco.com/jira/browse/ADF-4102) - Automate - C276980 - Duplicate user/group +- [ADF-4102](https://issues.alfresco.com/jira/browse/ADF-4102) - Automate - C276980 - Duplicate user/group -- [ADF-4103](https://issues.alfresco.com/jira/browse/ADF-4103) - Automate - C276982 - Remove User/Group +- [ADF-4103](https://issues.alfresco.com/jira/browse/ADF-4103) - Automate - C276982 - Remove User/Group -- [ADF-4104](https://issues.alfresco.com/jira/browse/ADF-4104) - Automate - C277014 - Role - Dropdown +- [ADF-4104](https://issues.alfresco.com/jira/browse/ADF-4104) - Automate - C277014 - Role - Dropdown -- [ADF-4105](https://issues.alfresco.com/jira/browse/ADF-4105) - Automate C277002 - Role - Site Dropdown +- [ADF-4105](https://issues.alfresco.com/jira/browse/ADF-4105) - Automate C277002 - Role - Site Dropdown -- [ADF-4106](https://issues.alfresco.com/jira/browse/ADF-4106) - Automate C276993 - Role - Consumer +- [ADF-4106](https://issues.alfresco.com/jira/browse/ADF-4106) - Automate C276993 - Role - Consumer -- [ADF-4107](https://issues.alfresco.com/jira/browse/ADF-4107) - Automate C276994 - Role - Site Consumer +- [ADF-4107](https://issues.alfresco.com/jira/browse/ADF-4107) - Automate C276994 - Role - Site Consumer -- [ADF-4108](https://issues.alfresco.com/jira/browse/ADF-4108) - Automate - C276996 - Role - Contributor +- [ADF-4108](https://issues.alfresco.com/jira/browse/ADF-4108) - Automate - C276996 - Role - Contributor -- [ADF-4109](https://issues.alfresco.com/jira/browse/ADF-4109) - Automate C276997 - Role - Site Contributor +- [ADF-4109](https://issues.alfresco.com/jira/browse/ADF-4109) - Automate C276997 - Role - Site Contributor -- [ADF-4110](https://issues.alfresco.com/jira/browse/ADF-4110) - Automate - C277000 - Role - Editor +- [ADF-4110](https://issues.alfresco.com/jira/browse/ADF-4110) - Automate - C277000 - Role - Editor -- [ADF-4111](https://issues.alfresco.com/jira/browse/ADF-4111) - Automate C277003 - Role - Collaborator +- [ADF-4111](https://issues.alfresco.com/jira/browse/ADF-4111) - Automate C277003 - Role - Collaborator -- [ADF-4112](https://issues.alfresco.com/jira/browse/ADF-4112) - Automate C277005 Role - Site Collaborator +- [ADF-4112](https://issues.alfresco.com/jira/browse/ADF-4112) - Automate C277005 Role - Site Collaborator -- [ADF-4113](https://issues.alfresco.com/jira/browse/ADF-4113) - Automate C277004 Role - Coordinator +- [ADF-4113](https://issues.alfresco.com/jira/browse/ADF-4113) - Automate C277004 Role - Coordinator -- [ADF-4114](https://issues.alfresco.com/jira/browse/ADF-4114) - Automate - C277006 Role - Site Manager +- [ADF-4114](https://issues.alfresco.com/jira/browse/ADF-4114) - Automate - C277006 Role - Site Manager -- [ADF-4115](https://issues.alfresco.com/jira/browse/ADF-4115) - Automate C277100 - EVERYONE group +- [ADF-4115](https://issues.alfresco.com/jira/browse/ADF-4115) - Automate C277100 - EVERYONE group -- [ADF-4116](https://issues.alfresco.com/jira/browse/ADF-4116) - Automate C277118 - Site Consumer - Add new version +- [ADF-4116](https://issues.alfresco.com/jira/browse/ADF-4116) - Automate C277118 - Site Consumer - Add new version -- [ADF-4117](https://issues.alfresco.com/jira/browse/ADF-4117) - Automate C279881 - No permissions +- [ADF-4117](https://issues.alfresco.com/jira/browse/ADF-4117) - Automate C279881 - No permissions -- [ADF-4120](https://issues.alfresco.com/jira/browse/ADF-4120) - automate ADF-3989 - The list of apps in 'appName' filter is duplicated after switching between saved filters +- [ADF-4120](https://issues.alfresco.com/jira/browse/ADF-4120) - automate ADF-3989 - The list of apps in 'appName' filter is duplicated after switching between saved filters -- [ADF-4126](https://issues.alfresco.com/jira/browse/ADF-4126) - Automate ADF-4003 - Add roles filtering to PeopleCloudComponent +- [ADF-4126](https://issues.alfresco.com/jira/browse/ADF-4126) - Automate ADF-4003 - Add roles filtering to [PeopleCloudComponent](../process-services-cloud/components/people-cloud.component.md) -- [ADF-4129](https://issues.alfresco.com/jira/browse/ADF-4129) - Automate ADF-4066 - Task doesn't have an assignee when the assignee is empty from Start Task form +- [ADF-4129](https://issues.alfresco.com/jira/browse/ADF-4129) - Automate ADF-4066 - Task doesn't have an assignee when the assignee is empty from Start Task form -- [ADF-4151](https://issues.alfresco.com/jira/browse/ADF-4151) - Automation test for code editor displayed when opening a .js file +- [ADF-4151](https://issues.alfresco.com/jira/browse/ADF-4151) - Automation test for code editor displayed when opening a .js file -- [ADF-4166](https://issues.alfresco.com/jira/browse/ADF-4166) - Move apps-section-cloud.e2e.ts to adf-testing +- [ADF-4166](https://issues.alfresco.com/jira/browse/ADF-4166) - Move apps-section-cloud.e2e.ts to adf-testing -- [ADF-4197](https://issues.alfresco.com/jira/browse/ADF-4197) - Automation test for redirection after page reload +- [ADF-4197](https://issues.alfresco.com/jira/browse/ADF-4197) - Automation test for redirection after page reload -- [ADF-4209](https://issues.alfresco.com/jira/browse/ADF-4209) - [E2E] Fix Core tests +- [ADF-4209](https://issues.alfresco.com/jira/browse/ADF-4209) - [E2E] Fix Core tests -- [ADF-4210](https://issues.alfresco.com/jira/browse/ADF-4210) - [E2E] Fix Content-services and Search tests +- [ADF-4210](https://issues.alfresco.com/jira/browse/ADF-4210) - [E2E] Fix Content-services and Search tests -- [ADF-4211](https://issues.alfresco.com/jira/browse/ADF-4211) - Fix process-services-cloud tests +- [ADF-4211](https://issues.alfresco.com/jira/browse/ADF-4211) - Fix process-services-cloud tests -- [ADF-4218](https://issues.alfresco.com/jira/browse/ADF-4218) - [E2E] Fix Insight tests +- [ADF-4218](https://issues.alfresco.com/jira/browse/ADF-4218) - [E2E] Fix Insight tests -- [ADF-4226](https://issues.alfresco.com/jira/browse/ADF-4226) - Implement automated test for infinitePagination - -- [ADF-4244](https://issues.alfresco.com/jira/browse/ADF-4244) - Fix search tests +- [ADF-4226](https://issues.alfresco.com/jira/browse/ADF-4226) - Implement automated test for infinitePagination +- [ADF-4244](https://issues.alfresco.com/jira/browse/ADF-4244) - Fix search tests Please refer to the [Alfresco issue tracker](https://issues.alfresco.com/jira/projects/ADF/issues/ADF-581?filter=allopenissues) for other known issues in this release. If you have any questions about the release, please contact us using [Gitter](https://gitter.im/Alfresco/alfresco-ng2-components). diff --git a/docs/release-notes/RelNote320.md b/docs/release-notes/RelNote320.md index 9c62a840f8..c464189552 100644 --- a/docs/release-notes/RelNote320.md +++ b/docs/release-notes/RelNote320.md @@ -18,24 +18,18 @@ versions of ADF. - [New package versions](#new-package-versions) - [Goals for this release](#goals-for-this-release) - [More on Activiti 7](#more-on-activiti-7) - -[New permission template to app list](new-permission-template-to-app-list) - -[Cloud form definition selector component](cloud-form-definition-selector-component) - [Five more languages supported](#five-more-languages-supported) - [List separator configuration in multi-value metadata](#list-separator-configuration-in-multi-value-metadata) - - [Confirm Dialog third extra button option and custom HTML message](#confirm-dialog-third-extra-button-option-and-custom-html-message) - - [Configuration option to change the dafault viewer zoom](#configuration-option-to-change-the-dafault-viewer-zoom) - - [Drop events for DataTable component](#drop-events-for-dataTable-component) + - [Option to chose which panel to show first in info drawer](#option-to-chose-which-panel-to-show-first-in-info-drawer) + - [Confirm Dialog third extra button option and custom HTML message](#confirm-dialog-third-extra-button-option-and--custom-html-message) + - [Configuration option to change the default viewer zoom](#configuration-option-to-change-the-default-viewer-zoom) + - [Drop events for DataTable component](#drop-events-for-datatable-component) - [Sidenav Layout Direction property](#sidenav-layout-direction-property) - [Custom local storages prefix property](#custom-local-storages-prefix-property) - - [Datatable Component new Json cell type](#datatable-component-new-json-cell-type) + - [Datatable Component new Json cell type](#datatable-component-new--json-cell-type) - [Localisation](#localisation) - [References](#references) - [Issues addressed](#issues-addressed) - - [Documentation](#documentation) - - [Feature](#feature) - - [Bug](#bug) - - [Task](#task) - - [Feature (Task)](#feature-task) ## New package versions @@ -60,16 +54,18 @@ Below are the most important new features of this release: - [More on Activiti 7](#more-on-activiti-7) - [Five more languages supported](#five-more-languages-supported) - [Event handling during header row action](#event-handling-during-header-row-action) -- [List separator configuration in multi-value metadata](#list-separator-configuration-in-multi-value-metadata) +- [List separator configuration in multi-value metadata](#list-separator-configuration-in-multi-value-metadata) ### More on Activiti 7 In ADF 3.0.0 (released in February) we announced the introduction of the new `*Cloud` package. This contains a set of components to support [Activiti 7](https://www.activiti.org/), the next generation Cloud Native implementation of Activiti BPM Engine. With the ADF 3.2 release, the journey continues with more supported features, like: #### New permission template to app list + A new message template is now displayed when a user doesn't have permissions #### Cloud form definition selector component + Cloud form definition selector component is a dropdown that shows all the form present in your app: ```html @@ -78,8 +74,10 @@ Cloud form definition selector component is a dropdown that shows all the form p (selectForm)="onFormSelect($event)"> ``` + For more details refer to the: -- [DataTable component](../process-services-cloud/components/form-definition-selector-cloud.component.md ). + +- [DataTable component](../process-services-cloud/components/form-definition-selector-cloud.component.md). ### Five more languages supported @@ -97,37 +95,41 @@ As of this version of ADF, developers can configure the list separator of multi- "multi-value-pipe-separator" : " - " } ``` + For more details refer to the: -- [Content Metadata Card component](../content-services/components/content-metadata-card.component.md) + +- [Content Metadata Card component](../content-services/components/content-metadata-card.component.md) ### Option to chose which panel to show first in info drawer -Is now possible define which aspect show expanded by default in the metadata card applying the optional property ```displayAspect``` +Is now possible define which aspect show expanded by default in the metadata card applying the optional property `displayAspect` ![feature-1](https://user-images.githubusercontent.com/14145706/56648273-a45efd80-66a0-11e9-866b-4f13c7df4b80.gif) For more details refer to the: -- [Content Metadata Card component](../content-services/components/content-metadata-card.component.md) -### Confirm Dialog third extra button option and custom HTML message +- [Content Metadata Card component](../content-services/components/content-metadata-card.component.md) +### Confirm Dialog third extra button option and custom HTML message Is now possible add an extra button in the Confirm Dialog #### Dialog inputs -| Name | Type | Default value | Description | -| ---- | ---- | ---- | ----------- | -| title | `string` | `Confirm` | It will be placed in the dialog title section. | + +| Name | Type | Default value | Description | +| ---- | ---- | ------------- | ----------- | +| title | `string` | `Confirm` | It will be placed in the dialog title section. | | yesLabel | `string` | `yes` | It will be placed first in the dialog action section | -| noLabel | `string` | `no`| It will be placed last in the dialog action section | -| thirdOptionLabel (optional) | `string` | | It is not a mandatory input. it will be rendered in between yes and no label | +| noLabel | `string` | `no` | It will be placed last in the dialog action section | +| thirdOptionLabel (optional) | `string` | | It is not a mandatory input. it will be rendered in between yes and no label | | message | `string` | `Do you want to proceed?` | It will be rendered in the dialog content area | -| htmlContent | `HTML` | | It will be rendered in the dialog content area | +| htmlContent | `HTML` | | It will be rendered in the dialog content area | ![yes-all](https://user-images.githubusercontent.com/14145706/56139451-87e30700-5fb6-11e9-8121-e58008231df2.png) - + For more details refer to the: -- [Confirm Dialog](../content-services/dialogs/confirm.dialog.md) + +- [Confirm Dialog](../content-services/dialogs/confirm.dialog.md) ### Configuration option to change the default viewer zoom @@ -146,16 +148,18 @@ In the same way, you can set a default zoom scaling value for the image viewer b "adf-viewer": { "image-viewer-scaling": 150 } -``` +``` By default, the viewer's zoom scaling is set to 100%. For more details refer to the: -- [Viewer Component](../docs/core/components/viewer.component.md) -### Drop events for DataTable component +- [Viewer Component](../docs/core/components/viewer.component.md) + +### Drop events for DataTable component #### Drop Events + Below are the four new DOM events emitted by the DataTable component. These events bubble up the component tree and can be handled by any parent component. @@ -203,38 +207,42 @@ Given that DataTable raises bubbling DOM events, you can handle drop behavior fr ``` -### Sidenav Layout Direction property +### Sidenav Layout Direction property + If you use the [Sidenav Layout component](../core/components/sidenav-layout.component.md) you can choose set the direction property in it using the property direction ans set it to **'rtl'** - ```html +```html + [direction]="'rtl'"> ...... ``` ![preview](https://user-images.githubusercontent.com/3947156/55820667-507ee100-5b04-11e9-81ee-a9951982b237.gif) -### Custom local storages prefix property +### Custom local storages prefix property + If you are using multiple ADF apps, you might want to set the following configuration so that the apps have specific storages and are independent of others when setting and getting data from the local storage. In order to achieve this, you will only need to set your app identifier under the `storagePrefix` property of the app in your `app.config.json` file. - ```json + +```json "application": { - "storagePrefix": "ADF_Identifier" + "storagePrefix": "ADF_Identifier" } ``` -### Datatable Component new Json cell type +### Datatable Component new Json cell type + The datale is now able to render in a better way JSON text : Show Json formated value inside datatable component. - ```html +```html - - - + + + ``` @@ -259,10 +267,10 @@ Please refer to the [official documentation](http://docs.alfresco.com/) for furt ## Issues addressed Below is the list of JIRA issues that were closed for this release. - Release Notes - Apps Development Framework - Version 3.2.0 +

Documentation

    diff --git a/docs/tutorials/README.md b/docs/tutorials/README.md index 818adbef2d..fd191e8235 100644 --- a/docs/tutorials/README.md +++ b/docs/tutorials/README.md @@ -6,17 +6,17 @@ Github only: true # Tutorials | Name | Level | Abstract | -| -- | -- | -- | +| ---- | ----- | -------- | | [**Creating your first ADF application**](creating-your-first-adf-application.md) | Basic | This tutorial shows you how to set up your development environment and create an ADF application. | | [**Creating your ADF application using Yeoman**](creating-the-app-using-yeoman.md) | Basic | In this tutorial you are going to see how to create an ADF application from scratch, using the [Yeoman scaffolding tool](http://yeoman.io/). | | [**Creating your Alfresco JavaScript application**](creating-javascript-app-using-alfresco-js-api.md) | Basic | In this tutorial you will learn how to create an application in JavaScript from scratch to interact with Alfresco. | | [**Adding a new component**](new-component.md) | Basic | In this tutorial, you will learn how to create a component using [Angular CLI](https://cli.angular.io/) within an existing application. | | [**Adding a new view**](new-view.md) | Beginner | In this tutorial you will learn how to create a new view in your application and how to access it using a defined endpoint. | | [**Using ADF Components**](using-components.md) | Basic | In this tutorial you will learn how to extend, use and configure ADF Components. | -| [**Basic theming**](basic-theming.md) | Beginner | In this tutorial you will see how to theme an ADF app by modifying the CSS. | +| [**Basic theming**](basic-theming.md) | Beginner | In this tutorial you will see how to theme an ADF app by modifying the CSS. | | [**Customizing the Login component**](customising-login.md) | Intermediate | In this tutorial you will learn how to customize the [Login component](../core/components/login.component.md) following the technical documentation. | | [**Working with a Data Table**](working-with-data-table.md) | Intermediate | In this tutorial you will learn how to populate a DataTable component. | | [**Working with the Nodes API Service**](working-with-nodes-api-service.md) | Intermediate | In this tutorial you will learn how to use the [`NodesApiService`](../core/services/nodes-api.service.md). | | [**Working with Nodes using the JS API**](working-with-nodes-js-api.md) | Intermediate | In this tutorial you will learn how to use the [`AlfrescoCoreRestApi`](https://github.com/Alfresco/alfresco-js-api/tree/master/src/alfresco-core-rest-api). | -| [**Content metadata component**](content-metadata-component.md) | Advanced | In this tutorial you will learn how to work with the [`ContentMetadataComponent`](../content-services/components/content-metadata-card.component.md). | +| [**Content metadata component**](content-metadata-component.md) | Advanced | In this tutorial you will learn how to work with the [`ContentMetadataComponent`](../../lib/content-services/content-metadata/components/content-metadata/content-metadata.component.ts). | | [**Building an ADF application on top of Activiti Cloud 7.0.0 GA Community Edition**](activiti-7-and-adf.md) | Intermediate | This tutorial shows how to configure an ADF app to connect to Activiti Cloud 7. | diff --git a/docs/tutorials/content-metadata-component.md b/docs/tutorials/content-metadata-component.md index 58d1b7eff8..27e064f376 100644 --- a/docs/tutorials/content-metadata-component.md +++ b/docs/tutorials/content-metadata-component.md @@ -5,13 +5,13 @@ Level: Advanced # Content metadata component -In this tutorial you will learn how to work with the [`ContentMetadataComponent`](../content-services/components/content-metadata-card.component.md). +In this tutorial you will learn how to work with the [`ContentMetadataComponent`](../../lib/content-services/content-metadata/components/content-metadata/content-metadata.component.ts). This component is used to render the standard and custom metadata of generic content item (called a _node_) stored in Alfresco Content Services. With the usual approach "learning by doing", you will see here some practical examples you might find useful in your own applicatioin. As a starting point, we will use and customize the [Alfresco Content App](https://github.com/Alfresco/alfresco-content-app). ## About the `ContentMetadataComponent` -As described in the [`ContentMetadataComponent`](../content-services/components/content-metadata-card.component.md) documentation, the `adf-content-metadata-card` tag has some useful attributes, included the `preset` attribute, which is used to point to a collection of aspects/properties to render. +As described in the [`ContentMetadataComponent`](../../lib/content-services/content-metadata/components/content-metadata/content-metadata.component.ts) documentation, the `adf-content-metadata-card` tag has some useful attributes, included the `preset` attribute, which is used to point to a collection of aspects/properties to render. Below, you can see the `preset` value requesting to render all the available aspects/properties: diff --git a/docs/upgrade-guide/upgrade26-30.md b/docs/upgrade-guide/upgrade26-30.md index 56d6495c2e..2a83068aea 100644 --- a/docs/upgrade-guide/upgrade26-30.md +++ b/docs/upgrade-guide/upgrade26-30.md @@ -17,6 +17,27 @@ you need to take into account as well as the usual library updates. After updati the libraries, check the other sections to see if any of the changes affect your project. +## Contents + +- [Library updates](#library-updates) + - [Automatic update using the Yeoman Generator](#automatic-update-using-the-yeoman-generator) + - [Manual update](#manual-update) +- [Breaking changes](#breaking-changes) +- [JS-API changes](#js-api-changes) +- [Permissions vs Allowable Operations](#permissions-vs-allowable-operations) +- [Deprecated items](#deprecated-items) +- [Relocated classes](#relocated-classes) +- [Renamed items](#renamed-items) + - [Classes](#classes) + - [Properties and methods](#properties-and-methods) + - [Component selectors](#component-selectors) +- [CSS classes with "adf-" prefix added](#css-classes-with-adf--prefix-added) + - [Content services CSS classes](#content-services-css-classes) + - [Core CSS classes](#core-css-classes) + - [Insights CSS classes](#insights-css-classes) + - [Process services cloud CSS classes](#process-services-cloud-css-classes) + - [Process services CSS classes](#process-services-css-classes) + ## Library updates ### Automatic update using the Yeoman Generator @@ -62,6 +83,7 @@ After starting the app, if everything is working fine, that's all and you don't ### Manual update 1. Update the `package.json` file with the latest library versions: + ```json "dependencies": { ... @@ -83,7 +105,7 @@ After starting the app, if everything is working fine, that's all and you don't ## Breaking changes The ADF project follows the [semver](https://semver.org/) conventions and so we -only make breaking changes (ie, not backward-compatible) in *major* versions. +only make breaking changes (ie, not backward-compatible) in _major_ versions. ADF 3.0 is the first major version since general availability so a number of deprecated items have been removed and also some existing items have been renamed. The sections below explain how to adapt your project to the changes @@ -92,12 +114,12 @@ in 3.0. See also our document for more information about the changes and links to the associated pull requests. -- [JS-API changes](#js-api-changes) -- [Permissions vs Allowable Operations](#permissions-vs-allowable-operations) -- [Deprecated items](#deprecated-items) -- [Relocated classes](#relocated-classes) -- [Renamed items](#renamed-items) -- [CSS classes with "adf-" prefix added](#css-classes-with-adf--prefix-added) +- [JS-API changes](#js-api-changes) +- [Permissions vs Allowable Operations](#permissions-vs-allowable-operations) +- [Deprecated items](#deprecated-items) +- [Relocated classes](#relocated-classes) +- [Renamed items](#renamed-items) +- [CSS classes with "adf-" prefix added](#css-classes-with-adf--prefix-added) ## JS-API changes @@ -169,7 +191,7 @@ Related to this issue is the `hasPermission` method of the made redundant by [`ContentService`](../core/services/content.service.md)`.hasAllowableOperations` and has now been removed. -Also, the former Node Permission Directive has now been renamed as the +Also, the former [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) Permission Directive has now been renamed as the [Check Allowable Operation directive](../core/directives/check-allowable-operation.directive.md) to better reflect its true behavior. You should therefore replace existing references to `adf-node-permission` with `adf-check-allowable-operation`. @@ -197,6 +219,7 @@ update your code to use the suggested fix for each item that affects your projec - The `sidebarTemplate` input has now been split into `sidebarLeftTemplate` and `sidebarRightTemplate`. - The `sidebarPosition` input has been removed (the other new inputs render it obsolete). + - The `createFolder` event of the [`UploadBase`](../../lib/content-services/upload/components/base-upload/upload-base.ts) class (emitted when a folder was created) has been removed. You should modify your code to use the `success` event instead. - [Login component](../core/components/login.component.md): Two inputs have been removed: `disableCsrf` and `providers`. Set the @@ -216,18 +239,18 @@ update your code to use the suggested fix for each item that affects your projec your document list as the `target`. - The `folderNode` input has been removed. Use the `currentFolderId` and `node` inputs instead. + - The `SettingsService` class has been removed. Access the equivalent properties with the [App config service](../core/services/app-config.service.md) - [Form service](../core/services/form.service.md): the `addFieldsToAForm` method has been removed. - ## Relocated classes The following classes have been moved from their original libraries to the Core library. You should modify your code to import these classes from `@alfresco/adf-core`. -- [`DownloadZipDialogComponent`](../core/dialogs/download-zip.dialog.md) (formerly Content Services) +- [`DownloadZipDialogComponent`](../../lib/core/dialogs/download-zip.dialog.ts) (formerly Content Services) - [`NodeDownloadDirective`](../core/directives/node-download.directive.md) (formerly Content Services) - [`CommentsModule`](../../lib/core/comments/comments.module.ts) (formerly Process Services) - [`CommentListComponent`](../core/components/comment-list.component.md) (formerly Process Services) @@ -247,9 +270,9 @@ you should replace them with the new ones. ### Properties and methods -- ``: The `onError` event has now been renamed as `error`. -- ``: The `fileNodeId` input that supplies the [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) Id of the file to -load has been renamed as `nodeId`. +- ``: The `onError` event has now been renamed as `error`. +- ``: The `fileNodeId` input that supplies the [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) Id of the file to + load has been renamed as `nodeId`. - ``: The `parentId` input has been renamed as `rootFolderId`. ### Component selectors @@ -274,302 +297,357 @@ they are defined. The new form of the name (ie, with the `adf-` prefix added) is listed but there are a few exceptions where the names were also altered in other ways. These changes are noted with an arrow "->". -- [Content services CSS classes](#content-services-css-classes) -- [Core CSS classes](#core-css-classes) -- [Insights CSS classes](#insights-css-classes) -- [Process services cloud CSS classes](#process-services-cloud-css-classes) -- [Process services CSS classes](#process-services-css-classes) +- [Content services CSS classes](#content-services-css-classes) +- [Core CSS classes](#core-css-classes) +- [Insights CSS classes](#insights-css-classes) +- [Process services cloud CSS classes](#process-services-cloud-css-classes) +- [Process services CSS classes](#process-services-css-classes) ### Content services CSS classes #### [../../lib/content-services/breadcrumb/breadcrumb.component.scss](../../lib/content-services/breadcrumb/breadcrumb.component.scss) -- `adf-isRoot` -- `adf-focus` -- `adf-active` + +- `adf-isRoot` +- `adf-focus` +- `adf-active` #### [../../lib/content-services/content-node-selector/content-node-selector-panel.component.scss](../../lib/content-services/content-node-selector/content-node-selector-panel.component.scss) -- `adf-search-results-label` -- `adf-dropdown-breadcrumb-item-chevron` + +- `adf-search-results-label` +- `adf-dropdown-breadcrumb-item-chevron` #### [../../lib/content-services/permission-manager/components/add-permission/add-permission-dialog.component.scss](../../lib/content-services/permission-manager/components/add-permission/add-permission-dialog.component.scss) -- `adf-choose-action` + +- `adf-choose-action` #### [../../lib/content-services/content-node-selector/content-node-selector.component.scss](../../lib/content-services/content-node-selector/content-node-selector.component.scss) -- `adf-choose-action` + +- `adf-choose-action` #### [../../lib/content-services/content-node-share/content-node-share.dialog.scss](../../lib/content-services/content-node-share/content-node-share.dialog.scss) -- `adf-input-action` -- `adf-full-width` + +- `adf-input-action` +- `adf-full-width` #### [../../lib/core/dialogs/download-zip.dialog.scss](../../lib/core/dialogs/download-zip.dialog.scss) -- `adf-spacer` + +- `adf-spacer` #### [../../lib/content-services/document-list/components/document-list.component.scss](../../lib/content-services/document-list/components/document-list.component.scss) -- `adf-document-list_empty_template` -- `adf-document-list__this-space-is-empty` -- `adf-document-list__drag-drop` -- `adf-document-list__any-files-here-to-add` -- `adf-document-list__empty_doc_lib` -- `adf-cell-container` -- `adf-cell-value` + +- `adf-document-list_empty_template` +- `adf-document-list__this-space-is-empty` +- `adf-document-list__drag-drop` +- `adf-document-list__any-files-here-to-add` +- `adf-document-list__empty_doc_lib` +- `adf-cell-container` +- `adf-cell-value` #### [../../lib/content-services/search/components/search-check-list/search-check-list.component.scss](../../lib/content-services/search/components/search-check-list/search-check-list.component.scss) -- `adf-facet-filter` -- `adf-facet-name` + +- `adf-facet-filter` +- `adf-facet-name` #### [../../lib/content-services/search/components/search-control.component.scss](../../lib/content-services/search/components/search-control.component.scss) -- `adf-highlight` + +- `adf-highlight` #### [../../lib/content-services/search/components/search-filter/search-filter.component.scss](../../lib/content-services/search/components/search-filter/search-filter.component.scss) -- `adf-checklist` -- `adf-facet-label` -- `adf-facet-result-filter` -- `adf-facet-buttons` + +- `adf-checklist` +- `adf-facet-label` +- `adf-facet-result-filter` +- `adf-facet-buttons` #### [../../lib/content-services/search/components/search-radio/search-radio.component.scss](../../lib/content-services/search/components/search-radio/search-radio.component.scss) -- `adf-facet-filter` -- `adf-filter-label` + +- `adf-facet-filter` +- `adf-filter-label` #### [../../lib/content-services/site-dropdown/sites-dropdown.component.scss](../../lib/content-services/site-dropdown/sites-dropdown.component.scss) -- `adf-full-width` + +- `adf-full-width` #### [../../lib/content-services/upload/components/file-uploading-dialog.component.scss](../../lib/content-services/upload/components/file-uploading-dialog.component.scss) -- `adf-upload-dialog` -- `adf-upload-dialog__content` + +- `adf-upload-dialog` +- `adf-upload-dialog__content` #### [../../lib/content-services/version-manager/version-manager.component.scss](../../lib/content-services/version-manager/version-manager.component.scss) -- `adf-upload-new-version` + +- `adf-upload-new-version` ### Core CSS classes #### [../../lib/core/about/about.component.scss](../../lib/core/about/about.component.scss) -- `adf-about-container` + +- `adf-about-container` #### [../../lib/core/buttons-menu/buttons-menu.component.scss](../../lib/core/buttons-menu/buttons-menu.component.scss) -- `adf-material-icons` + +- `adf-material-icons` #### [../../lib/core/card-view/components/card-view-keyvaluepairsitem/card-view-keyvaluepairsitem.component.scss](../../lib/core/card-view/components/card-view-keyvaluepairsitem/card-view-keyvaluepairsitem.component.scss) -- `adf-card-view` + +- `adf-card-view` #### [../../lib/core/comments/comment-list.component.scss](../../lib/core/comments/comment-list.component.scss) -- `adf-is-selected` + +- `adf-is-selected` #### [../../lib/core/datatable/components/datatable/datatable.component.scss](../../lib/core/datatable/components/datatable/datatable.component.scss) -- `adf-is-selected` -- `alfresco-datatable__actions-cell` -> `adf-datatable__actions-cell` -- `adf-image-table-cell` -- `adf-cell-container` -- `adf-no-select` -- `adf-sortable` -- `adf-cell-value` -- `adf-full-width` -- `adf-ellipsis-cell` -- `adf-sr-only` -- `adf-hidden` -- `adf-desktop-only` + +- `adf-is-selected` +- `alfresco-datatable__actions-cell` -> `adf-datatable__actions-cell` +- `adf-image-table-cell` +- `adf-cell-container` +- `adf-no-select` +- `adf-sortable` +- `adf-cell-value` +- `adf-full-width` +- `adf-ellipsis-cell` +- `adf-sr-only` +- `adf-hidden` +- `adf-desktop-only` #### [../../lib/core/form/components/form.component.scss](../../lib/core/form/components/form.component.scss) -- `adf-debug-toggle-text` -- `adf-invalid-color` + +- `adf-debug-toggle-text` +- `adf-invalid-color` #### [../../lib/core/form/components/widgets/container/container.widget.scss](../../lib/core/form/components/widgets/container/container.widget.scss) -- `adf-hidden` -- `adf-container-widget__header-text` -- `adf-collapsible` -- `adf-grid-list` -- `adf-grid-list-item` + +- `adf-hidden` +- `adf-container-widget__header-text` +- `adf-collapsible` +- `adf-grid-list` +- `adf-grid-list-item` #### [../../lib/core/form/components/widgets/dynamic-table/dynamic-table.widget.scss](../../lib/core/form/components/widgets/dynamic-table/dynamic-table.widget.scss) -- `adf-is-selected` -- `adf-no-select` -- `adf-sortable` -- `adf-full-width` + +- `adf-is-selected` +- `adf-no-select` +- `adf-sortable` +- `adf-full-width` #### [../../lib/core/layout/components/layout-container/layout-container.component.scss](../../lib/core/layout/components/layout-container/layout-container.component.scss) -- `adf-sidenav--hidden` + +- `adf-sidenav--hidden` #### [../../lib/core/layout/components/sidenav-layout/sidenav-layout.component.scss](../../lib/core/layout/components/sidenav-layout/sidenav-layout.component.scss) -- `adf-sidenav-layout` -- `adf-layout__content` + +- `adf-sidenav-layout` +- `adf-layout__content` #### [../../lib/core/login/components/login-dialog-panel.component.scss](../../lib/core/login/components/login-dialog-panel.component.scss) -- `adf-copyright` + +- `adf-copyright` #### [../../lib/core/login/components/login.component.scss](../../lib/core/login/components/login.component.scss) -- `adf-ie11FixerParent` -- `adf-ie11FixerChild` -- `adf-show` -- `adf-hide` -- `adf-icon-inline` -- `adf-error-icon` -- `adf-isChecking` -- `adf-isWelcome` -- `adf-welcome-icon` -- `adf-login-checking-spinner` -- `adf-is-active` -- `adf-copyright` -- `adf-login-rememberme` -> - `adf-login-remember-me` + +- `adf-ie11FixerParent` +- `adf-ie11FixerChild` +- `adf-show` +- `adf-hide` +- `adf-icon-inline` +- `adf-error-icon` +- `adf-isChecking` +- `adf-isWelcome` +- `adf-welcome-icon` +- `adf-login-checking-spinner` +- `adf-is-active` +- `adf-copyright` +- `adf-login-rememberme` -> - `adf-login-remember-me` #### [../../lib/core/settings/host-settings.component.scss](../../lib/core/settings/host-settings.component.scss) -- `adf-full-width` + +- `adf-full-width` #### [../../lib/core/viewer/components/imgViewer.component.scss](../../lib/core/viewer/components/imgViewer.component.scss) -- `adf-image-container` + +- `adf-image-container` #### [../../lib/core/viewer/components/pdfViewer-thumbnails.component.scss](../../lib/core/viewer/components/pdfViewer-thumbnails.component.scss) -- `adf-pdf-thumbnails` + +- `adf-pdf-thumbnails` #### [../../lib/core/viewer/components/pdfViewer.component.scss](../../lib/core/viewer/components/pdfViewer.component.scss) -- `adf-loader-container` -- `adf-thumbnails-template` -- `adf-loader-item` + +- `adf-loader-container` +- `adf-thumbnails-template` +- `adf-loader-item` #### [../../lib/core/viewer/components/pdfViewerHost.component.scss](../../lib/core/viewer/components/pdfViewerHost.component.scss) -- `adf-highlight` -- `adf-begin` -- `adf-end` -- `adf-middle` -- `adf-selected` -- `adf-endOfContent` -- `adf-active` -- `adf-annotationLayer` -- `adf-linkAnnotation` -- `adf-textAnnotation` -- `adf-popupWrapper` -- `adf-popup` -- `adf-highlightAnnotation` -- `adf-underlineAnnotation` -- `adf-squigglyAnnotation` -- `adf-strikeoutAnnotation` -- `adf-fileAttachmentAnnotation` -- `adf-pdfViewer` -- `adf-page` -- `adf-loadingIcon` -- `adf-removePageBorders` -- `adf-hidden` -- `adf-viewer-pdf-viewer` + +- `adf-highlight` +- `adf-begin` +- `adf-end` +- `adf-middle` +- `adf-selected` +- `adf-endOfContent` +- `adf-active` +- `adf-annotationLayer` +- `adf-linkAnnotation` +- `adf-textAnnotation` +- `adf-popupWrapper` +- `adf-popup` +- `adf-highlightAnnotation` +- `adf-underlineAnnotation` +- `adf-squigglyAnnotation` +- `adf-strikeoutAnnotation` +- `adf-fileAttachmentAnnotation` +- `adf-pdfViewer` +- `adf-page` +- `adf-loadingIcon` +- `adf-removePageBorders` +- `adf-hidden` +- `adf-viewer-pdf-viewer` #### [../../lib/core/viewer/components/viewer.component.scss](../../lib/core/viewer/components/viewer.component.scss) -- `adf-full-screen` -- `adf-info-drawer-content` + +- `adf-full-screen` +- `adf-info-drawer-content` ### Insights CSS classes #### [../../lib/insights/analytics-process/components/analytics-generator.component.scss](../../lib/insights/analytics-process/components/analytics-generator.component.scss) -- `adf-chart` -- `adf-analytics-row__entry` -- `adf-report-icons` -- `adf-full-width` -- `adf-partial-width` -- `adf-clear-both` + +- `adf-chart` +- `adf-analytics-row__entry` +- `adf-report-icons` +- `adf-full-width` +- `adf-partial-width` +- `adf-clear-both` #### [../../lib/insights/analytics-process/components/analytics-report-list.component.scss](../../lib/insights/analytics-process/components/analytics-report-list.component.scss) -- `adf-activiti-filters__entry` -- `adf-activiti-filters__entry-icon` -- `adf-activiti-filters__label` -- `adf-active` -- `adf-application-title` + +- `adf-activiti-filters__entry` +- `adf-activiti-filters__entry-icon` +- `adf-activiti-filters__label` +- `adf-active` +- `adf-application-title` #### [../../lib/insights/analytics-process/components/analytics-report-parameters.component.scss](../../lib/insights/analytics-process/components/analytics-report-parameters.component.scss) -- `adf-dropdown-widget` -- `adf-dropdown-widget__select` -- `adf-dropdown-widget__invalid` -- `adf-dropdown-widget__label` -- `adf-is-hide` -- `adf-report-container-setting` -- `adf-option_button_details` -- `adf-export-message` -- `adf-save-export-input` -- `adf-delete-parameter` -- `adf-hide` + +- `adf-dropdown-widget` +- `adf-dropdown-widget__select` +- `adf-dropdown-widget__invalid` +- `adf-dropdown-widget__label` +- `adf-is-hide` +- `adf-report-container-setting` +- `adf-option_button_details` +- `adf-export-message` +- `adf-save-export-input` +- `adf-delete-parameter` +- `adf-hide` #### [../../lib/insights/analytics-process/components/analytics.component.scss](../../lib/insights/analytics-process/components/analytics.component.scss) -- `adf-chart` + +- `adf-chart` #### [../../lib/insights/analytics-process/components/widgets/duration/duration.widget.scss](../../lib/insights/analytics-process/components/widgets/duration/duration.widget.scss) -- `adf-dropdown-container` + +- `adf-dropdown-container` #### [../../lib/insights/diagram/components/tooltip/diagram-tooltip.component.scss](../../lib/insights/diagram/components/tooltip/diagram-tooltip.component.scss) -- `adf-is-active` + +- `adf-is-active` ### Process services cloud CSS classes #### [../../lib/process-services-cloud/src/lib/app/components/app-details-cloud.component.scss](../../lib/process-services-cloud/src/lib/app/components/app-details-cloud.component.scss) -- `adf-line-clamp` + +- `adf-line-clamp` #### [../../lib/process-services-cloud/src/lib/process/process-filters/components/process-filters-cloud.component.scss](../../lib/process-services-cloud/src/lib/process/process-filters/components/process-filters-cloud.component.scss) -- `adf-active` + +- `adf-active` #### [../../lib/process-services-cloud/src/lib/process/process-list/components/process-list-cloud.component.scss](../../lib/process-services-cloud/src/lib/process/process-list/components/process-list-cloud.component.scss) -- `adf-no-content-message` + +- `adf-no-content-message` #### [../../lib/process-services-cloud/src/lib/task/task-filters/components/task-filters-cloud.component.scss](../../lib/process-services-cloud/src/lib/task/task-filters/components/task-filters-cloud.component.scss) -- `adf-active` + +- `adf-active` ### Process services CSS classes #### [../../lib/process-services/app-list/apps-list.component.scss](../../lib/process-services/app-list/apps-list.component.scss) -- `adf-line-clamp` + +- `adf-line-clamp` #### [../../lib/process-services/attachment/process-attachment-list.component.scss](../../lib/process-services/attachment/process-attachment-list.component.scss) -- `adf-data-cell` + +- `adf-data-cell` #### [../../lib/process-services/attachment/task-attachment-list.component.scss](../../lib/process-services/attachment/task-attachment-list.component.scss) -- `adf-data-cell` + +- `adf-data-cell` #### [../../lib/process-services/content-widget/attach-file-widget-dialog.component.scss](../../lib/process-services/content-widget/attach-file-widget-dialog.component.scss) -- `adf-choose-action` + +- `adf-choose-action` #### [../../lib/process-services/people/components/people-search-field/people-search-field.component.scss](../../lib/process-services/people/components/people-search-field/people-search-field.component.scss) -- `adf-search-text-container` -- `adf-search-list-container` -- `adf-people-pic` -- `adf-people-img` + +- `adf-search-text-container` +- `adf-search-list-container` +- `adf-people-pic` +- `adf-people-img` #### [../../lib/process-services/people/components/people-search/people-search.component.scss](../../lib/process-services/people/components/people-search/people-search.component.scss) -- `adf-activiti-label` -- `adf-fix-element-user-list` -- `adf-search-text-header` -- `adf-search-list-action-container` + +- `adf-activiti-label` +- `adf-fix-element-user-list` +- `adf-search-text-header` +- `adf-search-list-action-container` #### [../../lib/process-services/people/components/people/people.component.scss](../../lib/process-services/people/components/people/people.component.scss) -- `adf-assignment-header` -- `adf-assignment-count` -- `adf-add-people` -- `adf-assignment-top-container` -- `adf-assignment-top-container-content` -- `adf-assignment-container` -- `adf-assignment-list-container` -- `adf-cell-container` -- `adf-people-email` -- `adf-people-img` + +- `adf-assignment-header` +- `adf-assignment-count` +- `adf-add-people` +- `adf-assignment-top-container` +- `adf-assignment-top-container-content` +- `adf-assignment-container` +- `adf-assignment-list-container` +- `adf-cell-container` +- `adf-people-email` +- `adf-people-img` #### [../../lib/process-services/process-comments/process-comments.component.scss](../../lib/process-services/process-comments/process-comments.component.scss) -- `adf-activiti-label` -- `adf-icon` -- `adf-list-wrap` -- `adf-hide-long-names` + +- `adf-activiti-label` +- `adf-icon` +- `adf-list-wrap` +- `adf-hide-long-names` #### [../../lib/process-services/process-list/components/process-filters.component.scss](../../lib/process-services/process-list/components/process-filters.component.scss) -- `adf-active` + +- `adf-active` #### [../../lib/process-services/task-list/components/checklist.component.scss](../../lib/process-services/task-list/components/checklist.component.scss) -- `adf-activiti-label` -- `adf-checklist-menu-container` -- `adf-checklist-none-message` -- `activiti-label` -> `adfactiviti-label` + +- `adf-activiti-label` +- `adf-checklist-menu-container` +- `adf-checklist-none-message` +- `activiti-label` -> `adfactiviti-label` #### [../../lib/process-services/task-list/components/start-task.component.scss](../../lib/process-services/task-list/components/start-task.component.scss) -- `adf-people-widget-content` + +- `adf-people-widget-content` #### [../../lib/process-services/task-list/components/task-details.component.scss](../../lib/process-services/task-list/components/task-details.component.scss) -- `adf-error-dialog` -- `adf-activiti-task-details__header` -- `adf-activiti-task-details__action-button` -- `adf-assignment-container` -- `adf-task-header` -- `adf-assign-edit-view` -- `adf-property` + +- `adf-error-dialog` +- `adf-activiti-task-details__header` +- `adf-activiti-task-details__action-button` +- `adf-assignment-container` +- `adf-task-header` +- `adf-assign-edit-view` +- `adf-property` #### [../../lib/process-services/task-list/components/task-filters.component.scss](../../lib/process-services/task-list/components/task-filters.component.scss) -- `adf-active` + +- `adf-active` diff --git a/docs/user-guide/app-extensions.md b/docs/user-guide/app-extensions.md index 4d08ef0df0..540883edb8 100644 --- a/docs/user-guide/app-extensions.md +++ b/docs/user-guide/app-extensions.md @@ -203,7 +203,7 @@ The simplest type of rule is configured as shown below: ] ``` -The `type` is the ID of a `RuleEvaluator` function that has been registered using +The `type` is the ID of a [`RuleEvaluator`](../../lib/extensions/src/lib/config/rule.extensions.ts) function that has been registered using the `setEvaluators` method of the [Extension service](../extensions/services/extension.service.md). The evaluator is a boolean function that represents whether a certain condition is true or false (eg, whether an item is selected, whether the user diff --git a/docs/user-guide/internationalization.md b/docs/user-guide/internationalization.md index 00d764b4b9..f918fcc2c1 100644 --- a/docs/user-guide/internationalization.md +++ b/docs/user-guide/internationalization.md @@ -71,7 +71,7 @@ below: ``` The hierarchical structure is referred to in the UI using the familiar "dot" -notation (so `FORM.START_FORM.TITLE` would be the key for the "Start Form" +notation (so `FORM.START_FORM.TITLE` would be the key for the "Start [Form"](../../lib/process-services/task-list/models/form.model.ts) string here). This is useful for grouping related messages and providing singular and plural versions, among other things. @@ -144,7 +144,7 @@ Using [`TranslationService`](../core/services/translation.service.md)`.get` is s convenient to add translation keys directly into your page's HTML. Use the `translate` pipe to convert a key in the page directly to the corresponding text. For example, the following will display the -"Start Form" text as above but without any code or variables in the +"Start [Form"](../../lib/process-services/task-list/models/form.model.ts) text as above but without any code or variables in the component's `.ts` file: diff --git a/docs/versionIndex.md b/docs/versionIndex.md index 8cbbe2aeb5..9332f594a9 100644 --- a/docs/versionIndex.md +++ b/docs/versionIndex.md @@ -29,10 +29,13 @@ backend services have been tested with each released version of ADF. -- Support for five new languages (Danish, Finnish, Swedish, Czech, Polish). -- Easier event handling in [DataTable](core/components/datatable.component.md) (header row action). -- Configurable [multi-value metadata separator](content-services/components/content-metadata-card.component.md). -- More process components for Activiti 7. +- [Clipboard directive](core/directives/clipboard.directive.md) +- [Clipboard service](core/services/clipboard.service.md) +- [Form cloud custom outcome component](process-services-cloud/components/form-cloud-custom-outcome.component.md) +- [Form cloud component](process-services-cloud/components/form-cloud.component.md) +- [Form cloud service](process-services-cloud/services/form-cloud.service.md) +- [Json cell component](core/components/json-cell.component.md) +- [Task form cloud component](process-services-cloud/components/task-form-cloud.component.md) @@ -295,11 +298,12 @@ backend services have been tested with each released version of ADF. - [Folder actions service](content-services/services/folder-actions.service.md) - [Folder create directive](content-services/directives/folder-create.directive.md) - [Folder edit directive](content-services/directives/folder-edit.directive.md) +- [Form definition selector cloud component](process-services-cloud/components/form-definition-selector-cloud.component.md) - [Form field component](core/components/form-field.component.md) - [Form field model](core/models/form-field.model.md) - [Form list component](core/components/form-list.component.md) - [Form rendering service](core/services/form-rendering.service.md) -- [Form component](core/components/form.component.md) +- [Form component](process-services/components/form.component.md) - [Form service](core/services/form.service.md) - [Highlight transform service](core/services/highlight-transform.service.md) - [Highlight directive](core/directives/highlight.directive.md) @@ -314,6 +318,7 @@ backend services have been tested with each released version of ADF. - [Login component](core/components/login.component.md) - [Logout directive](core/directives/logout.directive.md) - [Mime type icon pipe](core/pipes/mime-type-icon.pipe.md) +- [Multi value pipe](core/pipes/multi-value.pipe.md) - [Node delete directive](core/directives/node-delete.directive.md) - [Node favorite directive](core/directives/node-favorite.directive.md) - [Node name tooltip pipe](core/pipes/node-name-tooltip.pipe.md)