diff --git a/docs/README.md b/docs/README.md index d9b12768df..fbb74f4f9b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -161,8 +161,9 @@ for more information about installing and using the source code. | [File Size pipe](core/pipes/file-size.pipe.md) | Converts a number of bytes to the equivalent in KB, MB, etc. | [Source](../lib/core/pipes/file-size.pipe.ts) | | [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) | +| [Localized Date pipe](core/pipes/localized-date.pipe.md) | Converts a date to a given format and locale. | [Source](../lib/core/pipes/localized-date.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) | -| [](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) | +| [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 the comma , 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) | @@ -255,7 +256,7 @@ for more information about installing and using the source code. | [File Uploading Dialog Component](content-services/components/file-uploading-dialog.component.md) | Shows a dialog listing all the files uploaded with the Upload Button or Drag Area components. | [Source](../lib/content-services/upload/components/file-uploading-dialog.component.ts) | | [Like component](content-services/components/like.component.md) | Allows a user to add "likes" to an item. | [Source](../lib/content-services/social/like.component.ts) | | [Permission List Component](content-services/components/permission-list.component.md) | Shows node permissions as a table. | [Source](../lib/content-services/permission-manager/components/permission-list/permission-list.component.ts) | -| [Rating component](content-services/components/rating.component.md) | Allows a user to add ratings to an item. | [Source](../lib/content-services/social/rating.component.ts) | +| [Rating component](content-services/components/rating.component.md) | Allows a user to add and remove rating to an item. | [Source](../lib/content-services/social/rating.component.ts) | | [Search check list component](content-services/components/search-check-list.component.md) | Implements a checklist widget for the Search Filter component. | [Source](../lib/content-services/search/components/search-check-list/search-check-list.component.ts) | | [Search Chip List Component](content-services/components/search-chip-list.component.md) | Displays search criteria as a set of "chips". | [Source](../lib/content-services/search/components/search-chip-list/search-chip-list.component.ts) | | [Search control component](content-services/components/search-control.component.md) | Displays a input text that shows find-as-you-type suggestions. | [Source](../lib/content-services/search/components/search-control.component.ts) | @@ -414,7 +415,7 @@ for more information about installing and using the source code. | [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/components/form-definition-selector-cloud.component.ts) | +| [Form Definition Selector Cloud](process-services-cloud/components/form-definition-selector-cloud.component.md) | Allows one form to be selected. | [Source](../lib/process-services-cloud/src/lib/form/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) | diff --git a/docs/content-services/components/rating.component.md b/docs/content-services/components/rating.component.md index c235888442..86dfa9233c 100644 --- a/docs/content-services/components/rating.component.md +++ b/docs/content-services/components/rating.component.md @@ -8,6 +8,7 @@ Last reviewed: 2019-01-14 # [Rating component](../../../lib/content-services/social/rating.component.ts "Defined in rating.component.ts") Allows a user to add and remove rating to an item. + It displays the average rating and the number of ratings. If the user has not rated the item the average rating stars color is grey. ![Rating component screenshot](../../docassets/images/social3.png) @@ -39,7 +40,7 @@ If the average is decimal number it will be rounded. | Name | Type | Description | | ---- | ---- | ----------- | -| changeVote | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Average rating is emitted when the "vote" gets changed. | +| changeVote | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "vote" gets changed. | ## See also diff --git a/docs/core/components/start-form.component.md b/docs/core/components/start-form.component.md index d31a41c4fc..7d89c07f0d 100644 --- a/docs/core/components/start-form.component.md +++ b/docs/core/components/start-form.component.md @@ -28,8 +28,9 @@ Displays the Start [`Form`](../../../lib/process-services/task-list/models/form. | ---- | ---- | ------------- | ----------- | | data | [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.ts) | | Custom form values map to be used with the rendered form. | | disableCompleteButton | `boolean` | false | If true then the `Complete` outcome button is shown but it will be disabled. | +| disableSaveButton | `boolean` | false | If true then the `Save` outcome button is shown but will be disabled. | | disableStartProcessButton | `boolean` | false | If true then the `Start Process` outcome button is shown but it will be disabled. | -| fieldValidators | [`FormFieldValidator`](../../../lib/core/form/components/widgets/core/form-field-validator.ts)`[]` | \[] | Contains a list of form field validator instances. | +| fieldValidators | [`FormFieldValidator`](../../../lib/core/form/components/widgets/core/form-field-validator.ts)`[]` | | Contains a list of form field validator instances. | | form | [`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts) | | Underlying [form model](../../../lib/core/form/components/widgets/core/form.model.ts) instance. | | formId | `number` | | The id of the form definition to load and display with custom values. | | formName | `string` | | Name of the form definition to load and display with custom values. | diff --git a/docs/core/pipes/localized-date.pipe.md b/docs/core/pipes/localized-date.pipe.md index 82cd1b1f8f..103669a998 100644 --- a/docs/core/pipes/localized-date.pipe.md +++ b/docs/core/pipes/localized-date.pipe.md @@ -1,6 +1,12 @@ +--- +Title: Localized Date pipe +Added: v3.3.0 +Status: Active +--- + # [Localized Date pipe](../../../lib/core/pipes/localized-date.pipe.ts "Defined in localized-date.pipe.ts") -Converts a date to an given format and locale. +Converts a date to a given format and locale. ## Basic Usage diff --git a/docs/core/pipes/multi-value.pipe.md b/docs/core/pipes/multi-value.pipe.md index a0f948a9b6..22eccad7e2 100644 --- a/docs/core/pipes/multi-value.pipe.md +++ b/docs/core/pipes/multi-value.pipe.md @@ -1,6 +1,12 @@ +--- +Title: Multi Value Pipe +Added: v3.2.0 +Status: Active +--- + # [Multi Value Pipe](../../../lib/core/pipes/multi-value.pipe.ts "Defined in multi-value.pipe.ts") -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. +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 the comma ```, ``` however, you can set your own separator in the params of the pipe. ## Basic Usage diff --git a/docs/core/services/shared-links-api.service.md b/docs/core/services/shared-links-api.service.md index f334f542ea..06e16feb87 100644 --- a/docs/core/services/shared-links-api.service.md +++ b/docs/core/services/shared-links-api.service.md @@ -18,21 +18,15 @@ Finds shared links to Content Services items. - _nodeId:_ `string` - ID of the node to link to - _options:_ `any` - Options supported by JS-API - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SharedLinkEntry`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/SharedLinkEntry.md)`>` - The shared link just created -- **deleteSharedLink**(sharedId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SharedLinkEntry`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/SharedLinkEntry.md)`>`
+- **deleteSharedLink**(sharedId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Deletes a shared link. - _sharedId:_ `string` - ID of the link to delete - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SharedLinkEntry`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/SharedLinkEntry.md)`>` - Null response notifying when the operation is complete + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null response notifying when the operation is complete - **getSharedLinks**(options: `any` = `{}`): [`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 shared links available to the current user. - _options:_ `any` - Options supported by JS-API - **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 shared links -### Events - -| Name | Type | Description | -| --- | --- | --- | -| error | `Subject<{ statusCode: number, message: string }>` | Gets emitted upon errors. | - ## Details Content Services allows users to generate URLs that can be shared with diff --git a/docs/process-services-cloud/components/form-cloud.component.md b/docs/process-services-cloud/components/form-cloud.component.md index baa50c30f0..ad78e9f96f 100644 --- a/docs/process-services-cloud/components/form-cloud.component.md +++ b/docs/process-services-cloud/components/form-cloud.component.md @@ -79,13 +79,14 @@ The template defined inside `empty-form` will be shown when no form definition i | appName | `string` | | App id to fetch corresponding form and values. | | data | [`TaskVariableCloud`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.ts)`[]` | | Custom form values map to be used with the rendered form. | | disableCompleteButton | `boolean` | false | If true then the `Complete` outcome button is shown but it will be disabled. | -| disableSaveButton | `boolean` | false | If true then the `Save` outcome button is shown but it will be disabled. | +| disableSaveButton | `boolean` | false | If true then the `Save` outcome button is shown but will be disabled. | | disableStartProcessButton | `boolean` | false | If true then the `Start Process` outcome button is shown but it will be disabled. | -| fieldValidators | [`FormFieldValidator`](../../../lib/core/form/components/widgets/core/form-field-validator.ts)`[]` | \[] | Contains a list of form field validator instances. | +| fieldValidators | [`FormFieldValidator`](../../../lib/core/form/components/widgets/core/form-field-validator.ts)`[]` | | Contains a list of form field validator instances. | | form | [`FormCloud`](../../../lib/process-services-cloud/src/lib/form/models/form-cloud.model.ts) | | Underlying [form model](../../../lib/core/form/components/widgets/core/form.model.ts) instance. | | formId | `string` | | Task id to fetch corresponding form and values. | | nameNode | `string` | | Name to assign to the new node where the metadata are stored. | | path | `string` | | Path of the folder where the metadata will be stored. | +| processInstanceId | `string` | | ProcessInstanceId id to fetch corresponding form and values. | | readOnly | `boolean` | false | Toggle readonly state of the form. Forces all form widgets to render as readonly if enabled. | | showCompleteButton | `boolean` | true | Toggle rendering of the `Complete` outcome button. | | showRefreshButton | `boolean` | true | Toggle rendering of the `Refresh` button. | @@ -93,7 +94,6 @@ The template defined inside `empty-form` will be shown when no form definition i | showTitle | `boolean` | true | Toggle rendering of the form title. | | showValidationIcon | `boolean` | true | Toggle rendering of the validation icon next to the form title. | | taskId | `string` | | Task id to fetch corresponding form and values. | -| processInstanceId | `string `| | Process instance id to fetch corresponding form and values.| ### Events 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 2da112cdc3..ddd4c1fb33 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,3 +1,9 @@ +--- +Title: Form Definition Selector Cloud +Added: v3.3.0 +Status: Active +--- + # [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. diff --git a/docs/process-services-cloud/components/start-process-cloud.component.md b/docs/process-services-cloud/components/start-process-cloud.component.md index 6d2c8e0086..9aff58c144 100644 --- a/docs/process-services-cloud/components/start-process-cloud.component.md +++ b/docs/process-services-cloud/components/start-process-cloud.component.md @@ -11,6 +11,17 @@ Starts a process. ![adf-start-process](../../docassets/images/startProcess.png) +## Contents + +- [Basic Usage](#basic-usage) +- [Class members](#class-members) + - [Properties](#properties) + - [Events](#events) +- [Details](#details) + - [Starting a process with a default name and a pre-selected process definition name](#starting-a-process-with-a-default-name-and-a-pre-selected-process-definition-name) + - [Starting a process with variables](#starting-a-process-with-variables) + - [Starting a process with values passed to the form](#starting-a-process-with-values-passed-to-the-form) + ## Basic Usage ```html @@ -30,8 +41,8 @@ Starts a process. | name | `string` | "" | Name of the process. | | processDefinitionName | `string` | | Name of the process definition. | | showSelectProcessDropdown | `boolean` | true | Show/hide the process dropdown list. | -| variables | `Object` | | Variables to attach to the payload. | -| values | `TaskVariableCloud` | | Values to attach to a form. | +| values | [`TaskVariableCloud`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.ts)`[]` | | Parameter to pass form field values in the start form if one is associated. | +| variables | `__type` | | Variables to attach to the payload. | ### Events @@ -57,7 +68,6 @@ You can use the `processDefinitionName` property to select which process will be If the app contains only one process definition, this process definition will be selected by default - ### Starting a process with variables ```html diff --git a/docs/process-services-cloud/services/form-cloud.service.md b/docs/process-services-cloud/services/form-cloud.service.md index 459b6461ec..95df4c0f10 100644 --- a/docs/process-services-cloud/services/form-cloud.service.md +++ b/docs/process-services-cloud/services/form-cloud.service.md @@ -26,18 +26,20 @@ class MyComponent { ### Methods -- **completeTaskForm**(appName: `string`, taskId: `string`, formId: `string`, formValues: [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.ts), outcome: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
+- **completeTaskForm**(appName: `string`, taskId: `string`, processInstanceId: `string`, formId: `string`, formValues: [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.ts), outcome: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
Completes a task form. - _appName:_ `string` - Name of the app - _taskId:_ `string` - ID of the target task + - _processInstanceId:_ `string` - - _formId:_ `string` - ID of the form to complete - _formValues:_ [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.ts) - [Form](../../../lib/process-services/task-list/models/form.model.ts) values object - - _outcome:_ `string` - (Optional) [Form](../../../lib/process-services/task-list/models/form.model.ts) outcome + - _outcome:_ `string` - [Form](../../../lib/process-services/task-list/models/form.model.ts) outcome - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Updated task details -- **createTemporaryRawRelatedContent**(file: `any`, nodeId: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **createTemporaryRawRelatedContent**(file: `any`, nodeId: `string`, contentHost: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
- _file:_ `any` - - - _nodeId:_ `any` - + - _nodeId:_ `string` - + - _contentHost:_ `string` - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - - **getBasePath**(appName: `string`): `string`
@@ -49,16 +51,17 @@ class MyComponent { Parses JSON data to create a corresponding form. - _url:_ `string` - String data to make the request - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FormFieldOption`](../../../lib/core/form/components/widgets/core/form-field-option.ts)`[]>` - Array of FormFieldOption object -- **getForm**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **getForm**(appName: `string`, formKey: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets a form definition. - _appName:_ `string` - Name of the app - - _taskId:_ `string` - ID of the target task + - _formKey:_ `string` - key of the target task - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Form definition -- **getProcessStorageFolderTask**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **getProcessStorageFolderTask**(appName: `string`, taskId: `string`, processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessStorageCloudModel`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.ts)`>`
- _appName:_ `string` - - _taskId:_ `string` - - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - + - _processInstanceId:_ `string` - + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessStorageCloudModel`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.ts)`>` - - **getTask**(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 @@ -81,10 +84,11 @@ class MyComponent { - _data:_ [`TaskVariableCloud`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.ts)`[]` - (Optional) Values for the form's fields - _readOnly:_ `boolean` - Toggles whether or not the form should be read-only - **Returns** [`FormCloud`](../../../lib/process-services-cloud/src/lib/form/models/form-cloud.model.ts) - [Form](../../../lib/process-services/task-list/models/form.model.ts) created from the JSON specification -- **saveTaskForm**(appName: `string`, taskId: `string`, formId: `string`, formValues: [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
+- **saveTaskForm**(appName: `string`, taskId: `string`, processInstanceId: `string`, formId: `string`, formValues: [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
Saves a task form. - _appName:_ `string` - Name of the app - _taskId:_ `string` - ID of the target task + - _processInstanceId:_ `string` - - _formId:_ `string` - ID of the form to save - _formValues:_ [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.ts) - [Form](../../../lib/process-services/task-list/models/form.model.ts) values object - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Updated task details diff --git a/docs/process-services/components/form.component.md b/docs/process-services/components/form.component.md index 1df904b9a6..8b71a62b42 100644 --- a/docs/process-services/components/form.component.md +++ b/docs/process-services/components/form.component.md @@ -56,9 +56,9 @@ Any content in the body of `` will be shown when no form definition is | ---- | ---- | ------------- | ----------- | | data | [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.ts) | | Custom form values map to be used with the rendered form. | | disableCompleteButton | `boolean` | false | If true then the `Complete` outcome button is shown but it will be disabled. | -| disableSaveButton | `boolean` | false | If true then the `Save` outcome button is shown but it will be disabled. | +| disableSaveButton | `boolean` | false | If true then the `Save` outcome button is shown but will be disabled. | | disableStartProcessButton | `boolean` | false | If true then the `Start Process` outcome button is shown but it will be disabled. | -| fieldValidators | [`FormFieldValidator`](../../../lib/core/form/components/widgets/core/form-field-validator.ts)`[]` | \[] | Contains a list of form field validator instances. | +| fieldValidators | [`FormFieldValidator`](../../../lib/core/form/components/widgets/core/form-field-validator.ts)`[]` | | Contains a list of form field validator instances. | | form | [`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts) | | Underlying [form model](../../../lib/core/form/components/widgets/core/form.model.ts) instance. | | formId | `number` | | The id of the form definition to load and display with custom values. | | formName | `string` | | Name of the form definition to load and display with custom values. | diff --git a/docs/tutorials/README.md b/docs/tutorials/README.md index f26ccff6c7..897ef96c8b 100644 --- a/docs/tutorials/README.md +++ b/docs/tutorials/README.md @@ -6,7 +6,7 @@ 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. | diff --git a/docs/user-guide/internationalization.md b/docs/user-guide/internationalization.md index 17c786adb1..b7fb498e47 100644 --- a/docs/user-guide/internationalization.md +++ b/docs/user-guide/internationalization.md @@ -170,6 +170,7 @@ If you want to use a different locale simply add the locale file for your region Usage of the [localized date pipe](../core/pipes/localized-date.pipe.md). + {{ date | adfLocalizedDate: format : locale }} diff --git a/docs/user-guide/rtl-support.md b/docs/user-guide/rtl-support.md index c23fbf2255..cda6e2a7b5 100644 --- a/docs/user-guide/rtl-support.md +++ b/docs/user-guide/rtl-support.md @@ -10,9 +10,11 @@ ADF currently has partial support for languages that are written from right to l This is handled automatically by the framework and can be configured through `app.config.json`. ## Configuration + Since directionality cannot be inferred from information about the locale, there is a one-to-one relation between locale and language configuration in `app.config.json`. The minimum configuration is to declare the `"direction": "rtl"` alt the level of the language entry associated with your browser locale. Omitting `direction` or failing to map it with a language key will default to `ltr`. + ```json // browser locale 'ar' @@ -33,7 +35,6 @@ The minimum configuration is to declare the `"direction": "rtl"` alt the level o If it is desired to start the application with a certain language locale and not default to browser locale, we can specify the `locale` at the configuration level and associate it with a language entry. ```json - { ... "locale": "ar", @@ -48,9 +49,10 @@ If it is desired to start the application with a certain language locale and not ... } ``` + ## UserPreferencesService -For cases where a component logic depends on direction values over time, `UserPreferencesService` can be used to get information about the current direction value. +For cases where a component logic depends on direction values over time, [`UserPreferencesService`](../core/services/user-preferences.service.md) can be used to get information about the current direction value. ```typescript import { Component, OnInit } from '@angular/core'; diff --git a/docs/versionIndex.md b/docs/versionIndex.md index 2db1a7a896..351bd369e5 100644 --- a/docs/versionIndex.md +++ b/docs/versionIndex.md @@ -46,6 +46,7 @@ backend services have been tested with each released version of ADF. - [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) +- [Multi value pipe](core/pipes/multi-value.pipe.md) - [Task form cloud component](process-services-cloud/components/task-form-cloud.component.md) @@ -309,7 +310,6 @@ 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) @@ -329,7 +329,6 @@ 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) diff --git a/lib/core/form/components/form-base.component.ts b/lib/core/form/components/form-base.component.ts index 31bd072352..c42fc7c50b 100644 --- a/lib/core/form/components/form-base.component.ts +++ b/lib/core/form/components/form-base.component.ts @@ -48,7 +48,7 @@ export abstract class FormBaseComponent { @Input() disableCompleteButton: boolean = false; - /** If true then the `Save` outcome button is shown but it will be disabled. */ + /** If true then the `Save` outcome button is shown but will be disabled. */ @Input() disableSaveButton: boolean = false; diff --git a/lib/core/services/notification.service.ts b/lib/core/services/notification.service.ts index 53690fa08d..64b01f21f1 100644 --- a/lib/core/services/notification.service.ts +++ b/lib/core/services/notification.service.ts @@ -108,7 +108,7 @@ export class NotificationService { /** * Rase error message * @param message Text message or translation key for the message. - * @param action (optional) Action name + * @param action Action name */ showError(message: string, action?: string): MatSnackBarRef { return this.showMessage(message, 'adf-error-snackbar', action); @@ -117,7 +117,7 @@ export class NotificationService { /** * Rase info message * @param message Text message or translation key for the message. - * @param action (optional) Action name + * @param action Action name */ showInfo(message: string, action?: string): MatSnackBarRef { return this.showMessage(message, 'adf-info-snackbar', action); @@ -126,7 +126,7 @@ export class NotificationService { /** * Rase warning message * @param message Text message or translation key for the message. - * @param action (optional) Action name + * @param action Action name */ showWarning(message: string, action?: string): MatSnackBarRef { return this.showMessage(message, 'adf-warning-snackbar', action); diff --git a/lib/extensions/src/lib/services/extension.service.ts b/lib/extensions/src/lib/services/extension.service.ts index c24b6ec20b..38abe6108e 100644 --- a/lib/extensions/src/lib/services/extension.service.ts +++ b/lib/extensions/src/lib/services/extension.service.ts @@ -167,7 +167,7 @@ export class ExtensionService { /** * Evaluates a rule. * @param ruleId ID of the rule to evaluate - * @param context (optional) Custom rule execution context. + * @param context Custom rule execution context. * @returns True if the rule passed, false otherwise */ evaluateRule(ruleId: string, context?: RuleContext): boolean { diff --git a/lib/extensions/src/lib/services/rule.service.ts b/lib/extensions/src/lib/services/rule.service.ts index 91904142b0..7b348b0641 100644 --- a/lib/extensions/src/lib/services/rule.service.ts +++ b/lib/extensions/src/lib/services/rule.service.ts @@ -71,7 +71,7 @@ export class RuleService { /** * Evaluates a rule. * @param ruleId ID of the rule to evaluate - * @param context (optional) Custom rule execution context. + * @param context Custom rule execution context. * @returns True if the rule passed, false otherwise */ evaluateRule(ruleId: string, context?: RuleContext): boolean { diff --git a/lib/process-services-cloud/src/lib/form/services/form-cloud.service.ts b/lib/process-services-cloud/src/lib/form/services/form-cloud.service.ts index db153cc893..10f2e555fc 100644 --- a/lib/process-services-cloud/src/lib/form/services/form-cloud.service.ts +++ b/lib/process-services-cloud/src/lib/form/services/form-cloud.service.ts @@ -120,7 +120,7 @@ export class FormCloudService extends BaseCloudService { * @param taskId ID of the target task * @param formId ID of the form to complete * @param formValues Form values object - * @param outcome (Optional) Form outcome + * @param outcome Form outcome * @returns Updated task details */ completeTaskForm(appName: string, taskId: string, processInstanceId: string, formId: string, formValues: FormValues, outcome: string): Observable { @@ -254,7 +254,7 @@ export class FormCloudService extends BaseCloudService { /** * Parses JSON data to create a corresponding form. * @param json JSON data to create the form - * @param data (Optional) Values for the form's fields + * @param data Values for the form's fields * @param readOnly Toggles whether or not the form should be read-only * @returns Form created from the JSON specification */