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

[ADF-2152] Added See Also sections and updated doc tools (#2835)

Browse Source 
* [ADF-2152] Added See Also sections to docs

* [ADF-2152] Added doc script to package.json
This commit is contained in:
Andy Stark
2018-01-16 17:43:10 +00:00
committed by Eugenio Romano
parent f4684f68be
commit 7a523961e2
16 changed files with 275 additions and 302 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/FormFieldValidator.md
View File

@@ -56,7 +56,7 @@ during the validation phase.
Several validator classes are predefined for you to use: Several validator classes are predefined for you to use:
| Validator name | Checks that: | | Validator name | Checks that: |
| --- | --- | | -------------- | ------------ |
| `RequiredFieldValidator` | Field is not left blank | | `RequiredFieldValidator` | Field is not left blank |
| `NumberFieldValidator` | Field contains numeric data | | `NumberFieldValidator` | Field contains numeric data |
| `MinLengthFieldValidator` | Field text has at least a minimum number of characters | | `MinLengthFieldValidator` | Field text has at least a minimum number of characters |
@@ -144,10 +144,7 @@ If you now run the application and try to enter "admin" in one of the text field
![](docassets/images/demo-validator.png) ![](docassets/images/demo-validator.png)
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
## See also ## See also
- [Form field model](form-field.model.md) - [Form field model](form-field.model.md)
- [Form component](form.component.md) - [Form component](form.component.md)
<!-- seealso end -->

60
docs/README.md
View File

@@ -40,15 +40,15 @@ for more information about installing and using the source code.
## Components ## Components
| Name | Description | Source link | | Name | Description | Source link |
| ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | | ---- | ----------- | ----------- |
| [Card view component](card-view.component.md) | Displays a configurable property list renderer. | [Source](../lib/core/card-view/card-view.component.ts) | | [Card view component](card-view.component.md) | Displays a configurable property list renderer. | [Source](../lib/core/card-view/components/card-view/card-view.component.ts) |
| [Accordion group component](accordion-group.component.md) | Adds a collapsible panel to an [accordion menu](accordion.component.md). | [Source](../lib/core/collapsable/accordion-group.component.ts) | | [Accordion group component](accordion-group.component.md) | Adds a collapsible panel to an [accordion menu](accordion.component.md). | [Source](../lib/core/collapsable/accordion-group.component.ts) |
| [Accordion component](accordion.component.md) | Creates a collapsible accordion menu. | [Source](../lib/core/collapsable/accordion.component.ts) | | [Accordion component](accordion.component.md) | Creates a collapsible accordion menu. | [Source](../lib/core/collapsable/accordion.component.ts) |
| [Data column component](data-column.component.md) | Defines column properties for DataTable, Tasklist, Document List and other components. | [Source](../lib/core/data-column/data-column.component.ts) | | [Data column component](data-column.component.md) | Defines column properties for DataTable, Tasklist, Document List and other components. | [Source](../lib/core/data-column/data-column.component.ts) |
| [Datatable component](datatable.component.md) | Displays data as a table with customizable columns and presentation. | [Source](../lib/core/datatable/components/datatable/datatable.component.ts) | | [Datatable component](datatable.component.md) | Displays data as a table with customizable columns and presentation. | [Source](../lib/core/datatable/components/datatable/datatable.component.ts) |
| [Form field component](form-field.component.md) | A form field in an APS form. | [Source](../lib/core/form/components/form-field/form-field.component.ts) | | [Form field component](form-field.component.md) | A form field in an APS form. | [Source](../lib/core/form/components/form-field/form-field.component.ts) |
| [Form list component](form-list.component.md) | The component shows the activiti forms as a list. | [Source](../lib/core/form/components/form-list.component.ts) | | [Form list component](form-list.component.md) | Shows APS forms as a list. | [Source](../lib/core/form/components/form-list.component.ts) |
| [Form component](form.component.md) | The component shows a Form from Activiti (see it live: [Form Quickstart](https://embed.plnkr.co/YSLXTqb3DtMhVJSqXKkE/)) | [Source](../lib/core/form/components/form.component.ts) | | [Form component](form.component.md) | Shows a Form from APS (see it live: [Form Quickstart](https://embed.plnkr.co/YSLXTqb3DtMhVJSqXKkE/)) | [Source](../lib/core/form/components/form.component.ts) |
| [Start form component](start-form.component.md) | Displays the Start Form for a process. | [Source](../lib/core/form/components/start-form.component.ts) | | [Start form component](start-form.component.md) | Displays the Start Form for a process. | [Source](../lib/core/form/components/start-form.component.ts) |
| [Text mask component](text-mask.component.md) | Implements text field input masks. | [Source](../lib/core/form/components/widgets/text/text-mask.component.ts) | | [Text mask component](text-mask.component.md) | Implements text field input masks. | [Source](../lib/core/form/components/widgets/text/text-mask.component.ts) |
| [Info drawer layout component](info-drawer-layout.component.md) | Displays a sidebar-style information panel. | [Source](../lib/core/info-drawer/info-drawer-layout.component.ts) | | [Info drawer layout component](info-drawer-layout.component.md) | Displays a sidebar-style information panel. | [Source](../lib/core/info-drawer/info-drawer-layout.component.ts) |
@@ -58,6 +58,7 @@ for more information about installing and using the source code.
| [Infinite pagination component](infinite-pagination.component.md) | Adds "infinite" pagination to the component it is used with. | [Source](../lib/core/pagination/infinite-pagination.component.ts) | | [Infinite pagination component](infinite-pagination.component.md) | Adds "infinite" pagination to the component it is used with. | [Source](../lib/core/pagination/infinite-pagination.component.ts) |
| [Pagination component](pagination.component.md) | Adds pagination to the component it is used with. | [Source](../lib/core/pagination/pagination.component.ts) | | [Pagination component](pagination.component.md) | Adds pagination to the component it is used with. | [Source](../lib/core/pagination/pagination.component.ts) |
| [Host settings component](host-settings.component.md) | Validates the URLs for ACS and APS and saves them in the user's local storage | [Source](../lib/core/settings/host-settings.component.ts) | | [Host settings component](host-settings.component.md) | Validates the URLs for ACS and APS and saves them in the user's local storage | [Source](../lib/core/settings/host-settings.component.ts) |
| [Sidebar action menu component](sidebar-action-menu.component.md) | Displays a sidebar-action menu information panel. | [Source](../lib/core/sidebar/sidebar-action-menu.component.ts) |
| [Toolbar divider component](toolbar-divider.component.md) | Divides groups of elements in a Toolbar with a visual separator. | [Source](../lib/core/toolbar/toolbar-divider.component.ts) | | [Toolbar divider component](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](toolbar-title.component.md) | Supplies custom HTML to be included in a Toolbar component title. | [Source](../lib/core/toolbar/toolbar-title.component.ts) | | [Toolbar title component](toolbar-title.component.md) | Supplies custom HTML to be included in a Toolbar component title. | [Source](../lib/core/toolbar/toolbar-title.component.ts) |
| [Toolbar component](toolbar.component.md) | Simple container for headers, titles, actions and breadcrumbs. | [Source](../lib/core/toolbar/toolbar.component.ts) | | [Toolbar component](toolbar.component.md) | Simple container for headers, titles, actions and breadcrumbs. | [Source](../lib/core/toolbar/toolbar.component.ts) |
@@ -67,7 +68,7 @@ for more information about installing and using the source code.
## Directives ## Directives
| Name | Description | Source link | | Name | Description | Source link |
| --------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- | | ---- | ----------- | ----------- |
| [Context menu directive](context-menu.directive.md) | Adds a context menu to a component. | [Source](../lib/core/context-menu/context-menu.directive.ts) | | [Context menu directive](context-menu.directive.md) | Adds a context menu to a component. | [Source](../lib/core/context-menu/context-menu.directive.ts) |
| [Highlight directive](highlight.directive.md) | Adds highlighting to selected sections of an HTML element's content. | [Source](../lib/core/directives/highlight.directive.ts) | | [Highlight directive](highlight.directive.md) | Adds highlighting to selected sections of an HTML element's content. | [Source](../lib/core/directives/highlight.directive.ts) |
| [Logout directive](logout.directive.md) | Logs the user out when the decorated element is clicked. | [Source](../lib/core/directives/logout.directive.ts) | | [Logout directive](logout.directive.md) | Logs the user out when the decorated element is clicked. | [Source](../lib/core/directives/logout.directive.ts) |
@@ -80,7 +81,7 @@ for more information about installing and using the source code.
## Models ## Models
| Name | Description | Source link | | Name | Description | Source link |
| ------------------------------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | | ---- | ----------- | ----------- |
| [Form field model](form-field.model.md) | Contains the value and metadata for a field of an [ADF Form](form.component.md). | [Source](../lib/core/form/components/widgets/core/form-field.model.ts) | | [Form field model](form-field.model.md) | Contains the value and metadata for a field of an [ADF Form](form.component.md). | [Source](../lib/core/form/components/widgets/core/form-field.model.ts) |
| [Comment process model](comment-process.model.md) | Represents a comment added to a Process Services task or process instance. | [Source](../lib/core/models/comment-process.model.ts) | | [Comment process model](comment-process.model.md) | Represents a comment added to a Process Services task or process instance. | [Source](../lib/core/models/comment-process.model.ts) |
| [Product version model](product-version.model.md) | Contains version and license information classes for Alfresco products. | [Source](../lib/core/models/product-version.model.ts) | | [Product version model](product-version.model.md) | Contains version and license information classes for Alfresco products. | [Source](../lib/core/models/product-version.model.ts) |
@@ -91,7 +92,7 @@ for more information about installing and using the source code.
## Pipes ## Pipes
| Name | Description | Source link | | Name | Description | Source link |
| --------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------- | | ---- | ----------- | ----------- |
| [File size pipe](file-size.pipe.md) | Converts a number of bytes to the equivalent in KB, MB, etc. | [Source](../lib/core/pipes/file-size.pipe.ts) | | [File size pipe](file-size.pipe.md) | Converts a number of bytes to the equivalent in KB, MB, etc. | [Source](../lib/core/pipes/file-size.pipe.ts) |
| [Mime type icon pipe](mime-type-icon.pipe.md) | Retrieves an icon to represent a MIME type. | [Source](../lib/core/pipes/mime-type-icon.pipe.ts) | | [Mime type icon pipe](mime-type-icon.pipe.md) | Retrieves an icon to represent a MIME type. | [Source](../lib/core/pipes/mime-type-icon.pipe.ts) |
| [Node name tooltip pipe](node-name-tooltip.pipe.md) | Formats the tooltip for a Node. | [Source](../lib/core/pipes/node-name-tooltip.pipe.ts) | | [Node name tooltip pipe](node-name-tooltip.pipe.md) | Formats the tooltip for a Node. | [Source](../lib/core/pipes/node-name-tooltip.pipe.ts) |
@@ -102,7 +103,8 @@ for more information about installing and using the source code.
## Services ## Services
| Name | Description | Source link | | Name | Description | Source link |
| ------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | | ---- | ----------- | ----------- |
| [Card view update service](card-view-update.service.md) | Reports edits and clicks within fields of a [Card View component](card-view.component.md). | [Source](../lib/core/card-view/services/card-view-update.service.ts) |
| [Activiti alfresco service](activiti-alfresco.service.md) | Gets Alfresco Repository folder content based on a Repository account configured in Alfresco Process Services (APS). | [Source](../lib/core/form/services/activiti-alfresco.service.ts) | | [Activiti alfresco service](activiti-alfresco.service.md) | Gets Alfresco Repository folder content based on a Repository account configured in Alfresco Process Services (APS). | [Source](../lib/core/form/services/activiti-alfresco.service.ts) |
| [Form rendering service](form-rendering.service.md) | Maps an APS form field type string onto the corresponding form widget component type. | [Source](../lib/core/form/services/form-rendering.service.ts) | | [Form rendering service](form-rendering.service.md) | Maps an APS form field type string onto the corresponding form widget component type. | [Source](../lib/core/form/services/form-rendering.service.ts) |
| [Form service](form.service.md) | Implements Process Services form methods | [Source](../lib/core/form/services/form.service.ts) | | [Form service](form.service.md) | Implements Process Services form methods | [Source](../lib/core/form/services/form.service.ts) |
@@ -114,7 +116,6 @@ for more information about installing and using the source code.
| [Auth guard ecm service](auth-guard-ecm.service.md) | Adds authentication with Content Services to a route within the app. | [Source](../lib/core/services/auth-guard-ecm.service.ts) | | [Auth guard ecm service](auth-guard-ecm.service.md) | Adds authentication with Content Services to a route within the app. | [Source](../lib/core/services/auth-guard-ecm.service.ts) |
| [Auth guard service](auth-guard.service.md) | Adds authentication to a route within the app. | [Source](../lib/core/services/auth-guard.service.ts) | | [Auth guard service](auth-guard.service.md) | Adds authentication to a route within the app. | [Source](../lib/core/services/auth-guard.service.ts) |
| [Authentication service](authentication.service.md) | Provides authentication for use with the Login component. | [Source](../lib/core/services/authentication.service.ts) | | [Authentication service](authentication.service.md) | Provides authentication for use with the Login component. | [Source](../lib/core/services/authentication.service.ts) |
| [Card view update service](card-view-update.service.md) | Reports edits and clicks within fields of a [Card View component](card-view.component.md). | [Source](../lib/core/services/card-view-update.service.ts) |
| [Comment process service](comment-process.service.md) | Adds and retrieves comments for task and process instances in Process Services. | [Source](../lib/core/services/comment-process.service.ts) | | [Comment process service](comment-process.service.md) | Adds and retrieves comments for task and process instances in Process Services. | [Source](../lib/core/services/comment-process.service.ts) |
| [Content service](content.service.md) | Accesses app-generated data objects via URLs and file downloads. | [Source](../lib/core/services/content.service.ts) | | [Content service](content.service.md) | Accesses app-generated data objects via URLs and file downloads. | [Source](../lib/core/services/content.service.ts) |
| [Cookie service](cookie.service.md) | Stores key-value data items as browser cookies. | [Source](../lib/core/services/cookie.service.ts) | | [Cookie service](cookie.service.md) | Stores key-value data items as browser cookies. | [Source](../lib/core/services/cookie.service.ts) |
@@ -142,15 +143,15 @@ for more information about installing and using the source code.
## Widgets ## Widgets
| Name | Description | Source link | | Name | Description | Source link |
| ----------------------------------- | ---------------------------------------- | ----------------------------------------------------------------------- | | ---- | ----------- | ----------- |
| [Content widget](content.widget.md) | The component shows the content preview. | [Source](../lib/core/form/components/widgets/content/content.widget.ts) | | [Content widget](content.widget.md) | Shows the content preview. | [Source](../lib/core/form/components/widgets/content/content.widget.ts) |
<!--core end--> <!--core end-->
### Other classes and interfaces ## Other classes and interfaces
| Name | Description | Source link | | Name | Description | Source link |
| ------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | | ---- | ----------- | ----------- |
| [Data Table Adapter interface](DataTableAdapter.md) | Defines how table data is supplied to [DataTable](datatable.component.md) and [Tasklist](task-list.component.md) components. | [Source](../core/datatable/data/datatable-adapter.ts) | | [Data Table Adapter interface](DataTableAdapter.md) | Defines how table data is supplied to [DataTable](datatable.component.md) and [Tasklist](task-list.component.md) components. | [Source](../core/datatable/data/datatable-adapter.ts) |
| [Form Field Validator interface](FormFieldValidator.md) | Defines how the input fields of [ADF Form](form.component.md) and [ADF Task Details](task-details.component.md) components are validated. | [Source](../core/form/components/widgets/core/form-field-validator.ts) | | [Form Field Validator interface](FormFieldValidator.md) | Defines how the input fields of [ADF Form](form.component.md) and [ADF Task Details](task-details.component.md) components are validated. | [Source](../core/form/components/widgets/core/form-field-validator.ts) |
@@ -168,9 +169,10 @@ for more information about installing and using the source code.
## Components ## Components
| Name | Description | Source link | | Name | Description | Source link |
| --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | | ---- | ----------- | ----------- |
| [Breadcrumb component](breadcrumb.component.md) | Indicates the current position within a navigation hierarchy. | [Source](../lib/content-services/breadcrumb/breadcrumb.component.ts) | | [Breadcrumb component](breadcrumb.component.md) | Indicates the current position within a navigation hierarchy. | [Source](../lib/content-services/breadcrumb/breadcrumb.component.ts) |
| [Dropdown breadcrumb component](dropdown-breadcrumb.component.md) | Indicates the current position within a navigation hierarchy using a dropdown menu. | [Source](../lib/content-services/breadcrumb/dropdown-breadcrumb.component.ts) | | [Dropdown breadcrumb component](dropdown-breadcrumb.component.md) | Indicates the current position within a navigation hierarchy using a dropdown menu. | [Source](../lib/content-services/breadcrumb/dropdown-breadcrumb.component.ts) |
| [Content metadata component](content-metadata.component.md) | Allows a user to display and edit metadata related to a node. | [Source](../lib/content-services/content-metadata/components/content-metadata/content-metadata.component.ts) |
| [Content node selector component](content-node-selector.component.md) | Allows a user to select items from a Content Services repository. | [Source](../lib/content-services/content-node-selector/content-node-selector.component.ts) | | [Content node selector component](content-node-selector.component.md) | Allows a user to select items from a Content Services repository. | [Source](../lib/content-services/content-node-selector/content-node-selector.component.ts) |
| [Content action component](content-action.component.md) | Adds options to a Document List actions menu for a particular content type. | [Source](../lib/content-services/document-list/components/content-action/content-action.component.ts) | | [Content action component](content-action.component.md) | Adds options to a Document List actions menu for a particular content type. | [Source](../lib/content-services/document-list/components/content-action/content-action.component.ts) |
| [Document list component](document-list.component.md) | Displays the documents from a repository. | [Source](../lib/content-services/document-list/components/document-list.component.ts) | | [Document list component](document-list.component.md) | Displays the documents from a repository. | [Source](../lib/content-services/document-list/components/document-list.component.ts) |
@@ -188,14 +190,13 @@ for more information about installing and using the source code.
| [Version list component](version-list.component.md) | Displays the version history of a node in a [Version Manager component](version-manager.component.md) | [Source](../lib/content-services/version-manager/version-list.component.ts) | | [Version list component](version-list.component.md) | Displays the version history of a node in a [Version Manager component](version-manager.component.md) | [Source](../lib/content-services/version-manager/version-list.component.ts) |
| [Version manager component](version-manager.component.md) | Displays the version history of a node with the ability to upload a new version. | [Source](../lib/content-services/version-manager/version-manager.component.ts) | | [Version manager component](version-manager.component.md) | Displays the version history of a node with the ability to upload a new version. | [Source](../lib/content-services/version-manager/version-manager.component.ts) |
| [Webscript component](webscript.component.md) | Provides access to Webscript features. | [Source](../lib/content-services/webscript/webscript.component.ts) | | [Webscript component](webscript.component.md) | Provides access to Webscript features. | [Source](../lib/content-services/webscript/webscript.component.ts) |
| _Content metadata card component_ | _Not currently documented_ | [Source](../lib/content-services/content-metadata/content-metadata-card.component.ts) | | _Content metadata card component_ | _Not currently documented_ | [Source](../lib/content-services/content-metadata/components/content-metadata-card/content-metadata-card.component.ts) |
| _Content metadata component_ | _Not currently documented_ | [Source](../lib/content-services/content-metadata/content-metadata.component.ts) |
| _Content node selector panel component_ | _Not currently documented_ | [Source](../lib/content-services/content-node-selector/content-node-selector-panel.component.ts) | | _Content node selector panel component_ | _Not currently documented_ | [Source](../lib/content-services/content-node-selector/content-node-selector-panel.component.ts) |
## Directives ## Directives
| Name | Description | Source link | | Name | Description | Source link |
| ------------------------------------------------------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------- | | ---- | ----------- | ----------- |
| [Folder create directive](folder-create.directive.md) | Allows folders to be created. | [Source](../lib/content-services/folder-directive/folder-create.directive.ts) | | [Folder create directive](folder-create.directive.md) | Allows folders to be created. | [Source](../lib/content-services/folder-directive/folder-create.directive.ts) |
| [Folder edit directive](folder-edit.directive.md) | Allows folders to be edited. | [Source](../lib/content-services/folder-directive/folder-edit.directive.ts) | | [Folder edit directive](folder-edit.directive.md) | Allows folders to be edited. | [Source](../lib/content-services/folder-directive/folder-edit.directive.ts) |
| [File draggable directive](file-draggable.directive.md) | Provide drag-and-drop features for an element such as a `div`. | [Source](../lib/content-services/upload/directives/file-draggable.directive.ts) | | [File draggable directive](file-draggable.directive.md) | Provide drag-and-drop features for an element such as a `div`. | [Source](../lib/content-services/upload/directives/file-draggable.directive.ts) |
@@ -203,20 +204,24 @@ for more information about installing and using the source code.
## Models ## Models
| Name | Description | Source link | | Name | Description | Source link |
| ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | | ---- | ----------- | ----------- |
| [Document library model](document-library.model.md) | Defines classes for use with the Content Services node API. | [Source](../lib/content-services/document-list/models/document-library.model.ts) | | [Document library model](document-library.model.md) | Defines classes for use with the Content Services node API. | [Source](../lib/content-services/document-list/models/document-library.model.ts) |
| [Permissions style model](permissions-style.model.md) | Sets custom CSS styles for rows of a [Document List](document-list.component.md) according to the item's permissions. | [Source](../lib/content-services/document-list/models/permissions-style.model.ts) | | [Permissions style model](permissions-style.model.md) | Sets custom CSS styles for rows of a [Document List](document-list.component.md) according to the item's permissions. | [Source](../lib/content-services/document-list/models/permissions-style.model.ts) |
## Services ## Services
| Name | Description | Source link | | Name | Description | Source link |
| ------------------------------------------------------- | --------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | ---- | ----------- | ----------- |
| [Document actions service](document-actions.service.md) | Implements the document menu actions for the Document List component. | [Source](../lib/content-services/document-list/services/document-actions.service.ts) | | [Document actions service](document-actions.service.md) | Implements the document menu actions for the Document List component. | [Source](../lib/content-services/document-list/services/document-actions.service.ts) |
| [Document list service](document-list.service.md) | Implements node operations used by the Document List component. | [Source](../lib/content-services/document-list/services/document-list.service.ts) | | [Document list service](document-list.service.md) | Implements node operations used by the Document List component. | [Source](../lib/content-services/document-list/services/document-list.service.ts) |
| [Folder actions service](folder-actions.service.md) | Implements the folder menu actions for the Document List component. | [Source](../lib/content-services/document-list/services/folder-actions.service.ts) | | [Folder actions service](folder-actions.service.md) | Implements the folder menu actions for the Document List component. | [Source](../lib/content-services/document-list/services/folder-actions.service.ts) |
| [Rating service](rating.service.md) | Manages ratings for items in Content Services. | [Source](../lib/content-services/social/services/rating.service.ts) | | [Rating service](rating.service.md) | Manages ratings for items in Content Services. | [Source](../lib/content-services/social/services/rating.service.ts) |
| [Tag service](tag.service.md) | Manages tags in Content Services. | [Source](../lib/content-services/tag/services/tag.service.ts) | | [Tag service](tag.service.md) | Manages tags in Content Services. | [Source](../lib/content-services/tag/services/tag.service.ts) |
| _Content metadata service_ | _Not currently documented_ | [Source](../lib/content-services/content-metadata/content-metadata.service.ts) | | _Aspect whitelist service_ | _Not currently documented_ | [Source](../lib/content-services/content-metadata/services/aspect-whitelist.service.ts) |
| _Basic properties service_ | _Not currently documented_ | [Source](../lib/content-services/content-metadata/services/basic-properties.service.ts) |
| _Content metadata service_ | _Not currently documented_ | [Source](../lib/content-services/content-metadata/services/content-metadata.service.ts) |
| _Properties loader service_ | _Not currently documented_ | [Source](../lib/content-services/content-metadata/services/properties-loader.service.ts) |
| _Property descriptors service_ | _Not currently documented_ | [Source](../lib/content-services/content-metadata/services/property-descriptors.service.ts) |
| _Content node dialog service_ | _Not currently documented_ | [Source](../lib/content-services/content-node-selector/content-node-dialog.service.ts) | | _Content node dialog service_ | _Not currently documented_ | [Source](../lib/content-services/content-node-selector/content-node-dialog.service.ts) |
<!--content-services end--> <!--content-services end-->
@@ -235,7 +240,7 @@ for more information about installing and using the source code.
## Components ## Components
| Name | Description | Source link | | Name | Description | Source link |
| ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | | ---- | ----------- | ----------- |
| [Apps list component](apps-list.component.md) | Shows all available apps. | [Source](../lib/process-services/app-list/apps-list.component.ts) | | [Apps list component](apps-list.component.md) | Shows all available apps. | [Source](../lib/process-services/app-list/apps-list.component.ts) |
| [Create process attachment component](create-process-attachment.component.md) | Displays Upload Component (Drag and Click) to upload the attachment to a specified process instance | [Source](../lib/process-services/attachment/create-process-attachment.component.ts) | | [Create process attachment component](create-process-attachment.component.md) | Displays Upload Component (Drag and Click) to upload the attachment to a specified process instance | [Source](../lib/process-services/attachment/create-process-attachment.component.ts) |
| [Create task attachment component](create-task-attachment.component.md) | Displays Upload Component (Drag and Click) to upload the attachment to a specified task | [Source](../lib/process-services/attachment/create-task-attachment.component.ts) | | [Create task attachment component](create-task-attachment.component.md) | Displays Upload Component (Drag and Click) to upload the attachment to a specified task | [Source](../lib/process-services/attachment/create-task-attachment.component.ts) |
@@ -246,12 +251,12 @@ for more information about installing and using the source code.
| [Process comments component](process-comments.component.md) | Displays comments associated with a particular process instance and allows the user to add new comments | [Source](../lib/process-services/comments/process-comments.component.ts) | | [Process comments component](process-comments.component.md) | Displays comments associated with a particular process instance and allows the user to add new comments | [Source](../lib/process-services/comments/process-comments.component.ts) |
| [People list component](people-list.component.md) | Shows a list of users (people). | [Source](../lib/process-services/people/people-list.component.ts) | | [People list component](people-list.component.md) | Shows a list of users (people). | [Source](../lib/process-services/people/people-list.component.ts) |
| [People search component](people-search.component.md) | Searches users/people. | [Source](../lib/process-services/people/people-search.component.ts) | | [People search component](people-search.component.md) | Searches users/people. | [Source](../lib/process-services/people/people-search.component.ts) |
| [People component](people.component.md) | Displays involved users to a specified task | [Source](../lib/process-services/people/people.component.ts) | | [People component](people.component.md) | Displays users involved with a specified task | [Source](../lib/process-services/people/people.component.ts) |
| [Process filters component](process-filters.component.md) | Collection of criteria used to filter process instances, which may be customized by users. | [Source](../lib/process-services/process-list/components/process-filters.component.ts) | | [Process filters component](process-filters.component.md) | Collection of criteria used to filter process instances, which may be customized by users. | [Source](../lib/process-services/process-list/components/process-filters.component.ts) |
| [Process instance details component](process-instance-details.component.md) | Displays detailed information on a specified process instance | [Source](../lib/process-services/process-list/components/process-instance-details.component.ts) | | [Process instance details component](process-instance-details.component.md) | Displays detailed information on a specified process instance | [Source](../lib/process-services/process-list/components/process-instance-details.component.ts) |
| [Process instance header component](process-instance-header.component.md) | Sub-component of the process details component, which renders some general information about the selected process. | [Source](../lib/process-services/process-list/components/process-instance-header.component.ts) | | [Process instance header component](process-instance-header.component.md) | Sub-component of the process details component, which renders some general information about the selected process. | [Source](../lib/process-services/process-list/components/process-instance-header.component.ts) |
| [Process instance tasks component](process-instance-tasks.component.md) | Lists both the active and completed tasks associated with a particular process instance | [Source](../lib/process-services/process-list/components/process-instance-tasks.component.ts) | | [Process instance tasks component](process-instance-tasks.component.md) | Lists both the active and completed tasks associated with a particular process instance | [Source](../lib/process-services/process-list/components/process-instance-tasks.component.ts) |
| [Process list component](process-list.component.md) | This component renders a list containing all the process instances matched by the parameters specified. | [Source](../lib/process-services/process-list/components/process-list.component.ts) | | [Process list component](process-list.component.md) | Renders a list containing all the process instances matched by the parameters specified. | [Source](../lib/process-services/process-list/components/process-list.component.ts) |
| [Start process component](start-process.component.md) | Starts a process. | [Source](../lib/process-services/process-list/components/start-process.component.ts) | | [Start process component](start-process.component.md) | Starts a process. | [Source](../lib/process-services/process-list/components/start-process.component.ts) |
| [Checklist component](checklist.component.md) | Shows the checklist task functionality. | [Source](../lib/process-services/task-list/components/checklist.component.ts) | | [Checklist component](checklist.component.md) | Shows the checklist task functionality. | [Source](../lib/process-services/task-list/components/checklist.component.ts) |
| [Start task component](start-task.component.md) | Creates/Starts new task for the specified app | [Source](../lib/process-services/task-list/components/start-task.component.ts) | | [Start task component](start-task.component.md) | Creates/Starts new task for the specified app | [Source](../lib/process-services/task-list/components/start-task.component.ts) |
@@ -259,24 +264,25 @@ for more information about installing and using the source code.
| [Task filters component](task-filters.component.md) | Shows all available filters. | [Source](../lib/process-services/task-list/components/task-filters.component.ts) | | [Task filters component](task-filters.component.md) | Shows all available filters. | [Source](../lib/process-services/task-list/components/task-filters.component.ts) |
| [Task header component](task-header.component.md) | Shows all the information related to a task. | [Source](../lib/process-services/task-list/components/task-header.component.ts) | | [Task header component](task-header.component.md) | Shows all the information related to a task. | [Source](../lib/process-services/task-list/components/task-header.component.ts) |
| [Task list component](task-list.component.md) | Renders a list containing all the tasks matched by the parameters specified. | [Source](../lib/process-services/task-list/components/task-list.component.ts) | | [Task list component](task-list.component.md) | Renders a list containing all the tasks matched by the parameters specified. | [Source](../lib/process-services/task-list/components/task-list.component.ts) |
| _Attach file widget component_ | _Not currently documented_ | [Source](../lib/process-services/content-widget/attach-file-widget.component.ts) |
## Directives ## Directives
| Name | Description | Source link | | Name | Description | Source link |
| ----------------------------------------------------- | ---------------------------------------------------------------- | ------------------------------------------------------------------------------------ | | ---- | ----------- | ----------- |
| [Process audit directive](process-audit.directive.md) | Fetches the Process Audit information in the pdf or json format. | [Source](../lib/process-services/process-list/components/process-audit.directive.ts) | | [Process audit directive](process-audit.directive.md) | Fetches the Process Audit information in the pdf or json format. | [Source](../lib/process-services/process-list/components/process-audit.directive.ts) |
| [Task audit directive](task-audit.directive.md) | Fetches the Task Audit information in the pdf or json format. | [Source](../lib/process-services/task-list/components/task-audit.directive.ts) | | [Task audit directive](task-audit.directive.md) | Fetches the Task Audit information in the pdf or json format. | [Source](../lib/process-services/task-list/components/task-audit.directive.ts) |
## Models ## Models
| Name | Description | Source link | | Name | Description | Source link |
| ------------------------------- | -------------------------------------------------------- | ------------------------------------------------------------------ | | ---- | ----------- | ----------- |
| [Filter model](filter.model.md) | Contains classes related to filters in Process Services. | [Source](../lib/process-services/task-list/models/filter.model.ts) | | [Filter model](filter.model.md) | Contains classes related to filters in Process Services. | [Source](../lib/process-services/task-list/models/filter.model.ts) |
## Services ## Services
| Name | Description | Source link | | Name | Description | Source link |
| --------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | | ---- | ----------- | ----------- |
| [Process filter service](process-filter.service.md) | Manage Process Filters, which are pre-configured Process Instance queries. | [Source](../lib/process-services/process-list/services/process-filter.service.ts) | | [Process filter service](process-filter.service.md) | Manage Process Filters, which are pre-configured Process Instance queries. | [Source](../lib/process-services/process-list/services/process-filter.service.ts) |
| [Process service](process.service.md) | Manage Process Instances, Process Variables, and Process Audit Log. | [Source](../lib/process-services/process-list/services/process.service.ts) | | [Process service](process.service.md) | Manage Process Instances, Process Variables, and Process Audit Log. | [Source](../lib/process-services/process-list/services/process.service.ts) |
| [Task filter service](task-filter.service.md) | Manage Task Filters, which are pre-configured Task Instance queries. | [Source](../lib/process-services/task-list/services/task-filter.service.ts) | | [Task filter service](task-filter.service.md) | Manage Task Filters, which are pre-configured Task Instance queries. | [Source](../lib/process-services/task-list/services/task-filter.service.ts) |
@@ -299,7 +305,7 @@ for more information about installing and using the source code.
## Components ## Components
| Name | Description | Source link | | Name | Description | Source link |
| --------------------------------------------------------------------- | -------------------------------------------------------- | ----------------------------------------------------------------------------------------- | | ---- | ----------- | ----------- |
| [Widget component](widget.component.md) | Base class for standard and custom widget classes. | [Source](../lib/insights/analytics-process/components/widgets/widget.component.ts) | | [Widget component](widget.component.md) | Base class for standard and custom widget classes. | [Source](../lib/insights/analytics-process/components/widgets/widget.component.ts) |
| [Analytics generator component](analytics-generator.component.md) | Generates and shows charts | [Source](../lib/insights/analytics-process/components/analytics-generator.component.ts) | | [Analytics generator component](analytics-generator.component.md) | Generates and shows charts | [Source](../lib/insights/analytics-process/components/analytics-generator.component.ts) |
| [Analytics report list component](analytics-report-list.component.md) | Shows a list of all available reports | [Source](../lib/insights/analytics-process/components/analytics-report-list.component.ts) | | [Analytics report list component](analytics-report-list.component.md) | Shows a list of all available reports | [Source](../lib/insights/analytics-process/components/analytics-report-list.component.ts) |

5
docs/favorites-api.service.md
View File

@@ -20,8 +20,3 @@ person is the currently logged-in user.
You can specify a number of `options` to modify the search further. See the You can specify a number of `options` to modify the search further. See the
[Alfresco JS API page](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/FavoritesApi.md#getfavorites) [Alfresco JS API page](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/FavoritesApi.md#getfavorites)
for `getFavorites` for more information. for `getFavorites` for more information.
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
<!-- seealso end -->

42
docs/file-draggable.directive.md
View File

@@ -1,4 +1,5 @@
# File Draggable directive # File Draggable directive
Provide drag-and-drop features for an element such as a `div`. Provide drag-and-drop features for an element such as a `div`.
## Basic Usage ## Basic Usage
@@ -27,7 +28,25 @@ Some sample CSS to show the drag and drop area:
} }
``` ```
Event handler implementations: ### Properties
| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| file-draggable | boolean | true | Toggles between enable/disable of the drag-and-drop functionality. |
### Events
| Name | Description |
| ---- | ----------- |
| filesEntityDropped | Emitted when one or more files are dragged and dropped onto the draggable element, such as a `div` |
| folderEntityDropped | Emitted when a directory is dragged and dropped onto the draggable element, such as a `div` |
| filesDropped | Emitted when one or more files are dragged and dropped onto the draggable element, such as a `div` |
## Details
Typically you would use the Upload Drag Area component instead of this directive.
### Event handler implementations
```ts ```ts
export class SomeComponent implements OnInit { export class SomeComponent implements OnInit {
@@ -52,23 +71,6 @@ export class SomeComponent implements OnInit {
} }
``` ```
### Properties ## See also
| Name | Type | Default | Description | - [Upload Drag Area component](upload-drag-area.component.md)
| --- | --- | --- | --- |
| file-draggable | boolean | true | Toggles between enable/disable of the drag-and-drop functionality. |
### Events
| Name | Description |
| --- | --- |
| filesEntityDropped | Emitted when one or more files are dragged and dropped onto the draggable element, such as a `div` |
| folderEntityDropped | Emitted when a directory is dragged and dropped onto the draggable element, such as a `div`|
| filesDropped | Emitted when one or more files are dragged and dropped onto the draggable element, such as a `div`|
## Details
Typically you would use the Upload Drag Area component instead of this directive.
<!-- seealso start -->
<!-- seealso end -->

5
docs/file-size.pipe.md
View File

@@ -16,8 +16,3 @@ The pipe chooses the largest unit that is less than the total number of bytes an
divides the total by this number. This ensures that the number of units is greater divides the total by this number. This ensures that the number of units is greater
than 1 (eg, you will see "512 Bytes" rather than "0.5KB"). The pipe parameter indicates than 1 (eg, you will see "512 Bytes" rather than "0.5KB"). The pipe parameter indicates
the number of decimal places to use for the value, defaulting to 2 decimal places. the number of decimal places to use for the value, defaulting to 2 decimal places.
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
<!-- seealso end -->

5
docs/file-uploading-dialog.component.md
View File

@@ -11,7 +11,7 @@ Shows a dialog listing all the files uploaded with the Upload Button or Drag Are
### Properties ### Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | | ---- | ---- | ------- | ----------- |
| position | string | 'right' | Dialog position. Accepted values are 'left' or 'right' | | position | string | 'right' | Dialog position. Accepted values are 'left' or 'right' |
## Details ## Details
@@ -20,10 +20,7 @@ This component should be used in combination with the
[Upload Button component](upload-button.component.md) or the [Upload Button component](upload-button.component.md) or the
[Drag Area component](drag-area.component.md). [Drag Area component](drag-area.component.md).
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
## See also ## See also
- [Upload button component](upload-button.component.md) - [Upload button component](upload-button.component.md)
- [Upload drag area component](upload-drag-area.component.md) - [Upload drag area component](upload-drag-area.component.md)
<!-- seealso end -->

3
docs/filter.model.md
View File

@@ -62,11 +62,8 @@ class TaskQueryRequestRepresentationModel implements TaskQueryRequestRepresentat
} }
``` ```
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
## See also ## See also
- [Process filters component](process-filters.component.md) - [Process filters component](process-filters.component.md)
- [Task filters component](task-filters.component.md) - [Task filters component](task-filters.component.md)
- [Apps process service](apps-process.service.md) - [Apps process service](apps-process.service.md)
<!-- seealso end -->

3
docs/folder-actions.service.md
View File

@@ -72,10 +72,7 @@ export class MyView {
You will probably want to set up all your custom actions at the application root level or You will probably want to set up all your custom actions at the application root level or
with a custom application service. with a custom application service.
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
## See also ## See also
- [Document actions service](document-actions.service.md) - [Document actions service](document-actions.service.md)
- [Content action component](content-action.component.md) - [Content action component](content-action.component.md)
<!-- seealso end -->

2
docs/folder-create.directive.md
View File

@@ -20,7 +20,7 @@ Allows folders to be created.
### Properties ### Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ----------------- | ------------------- | --------- | ----------------------------------------------------------------- | | ---- | ---- | ------- | ----------- |
| adf-create-folder | string | '-my-' | Parent folder where the new folder will be located after creation | | adf-create-folder | string | '-my-' | Parent folder where the new folder will be located after creation |
## Details ## Details

13
docs/form-field.component.md
View File

@@ -1,7 +1,9 @@
# Form field component # Form field component
A form field in an APS form. A form field in an APS form.
## Basic Usage ## Basic Usage
All form field editors (aka widgets) on a Form are rendered by means of a `FormFieldComponent` All form field editors (aka widgets) on a Form are rendered by means of a `FormFieldComponent`
that takes an instance of a `FormFieldModel`: that takes an instance of a `FormFieldModel`:
@@ -13,20 +15,23 @@ This component depends on the `FormRenderingService` to map the `FormFieldModel`
based on the field type or the metadata information. based on the field type or the metadata information.
### Properties ### Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | | ---- | ---- | ------- | ----------- |
| field | FormFieldModel | | Contains all the necessary data needed to determine what UI Widget to use when rendering the field in the form. You would typically not create this data manually but instead create the form in APS and export it to get to all the `FormFieldModel` definitions. | | field | FormFieldModel | | Contains all the necessary data needed to determine what UI Widget to use when rendering the field in the form. You would typically not create this data manually but instead create the form in APS and export it to get to all the `FormFieldModel` definitions. |
## Details ## Details
You would typically not use this component directly but instead use the `<adf-form>` component, which under the hood You would typically not use this component directly but instead use the `<adf-form>` component, which under the hood
uses `<adf-form-field>` components to render the form fields. See next section for how each field in a form definition uses `<adf-form-field>` components to render the form fields. See next section for how each field in a form definition
is mapped to a form field component (i.e. UI widget) implementation. is mapped to a form field component (i.e. UI widget) implementation.
### Field Type -> Form Field Component mappings ### Field Type -> Form Field Component mappings
Forms defined in APS have the following default mappings for the form fields: Forms defined in APS have the following default mappings for the form fields:
| APS Form Designer Widget | Field Type | Component Type | | APS Form Designer Widget | Field Type | Component Type |
| --- | --- | --- | | ------------------------ | ---------- | -------------- |
| Text | text | TextWidgetComponent | | Text | text | TextWidgetComponent |
| Multi-line text | multi-line-text | MultilineTextWidgetComponentComponent | | Multi-line text | multi-line-text | MultilineTextWidgetComponentComponent |
| Number | integer | NumberWidgetComponent | | Number | integer | NumberWidgetComponent |
@@ -46,7 +51,3 @@ Forms defined in APS have the following default mappings for the form fields:
| Display text | readonly-text | DisplayTextWidgetComponentComponent | | Display text | readonly-text | DisplayTextWidgetComponentComponent |
| N/A | container | ContainerWidgetComponent (layout component) | | N/A | container | ContainerWidgetComponent (layout component) |
| N/A | N/A | UnknownWidgetComponent | | N/A | N/A | UnknownWidgetComponent |
<!-- seealso start -->
<!-- seealso end -->

23
docs/form-field.model.md
View File

@@ -5,7 +5,7 @@ Contains the value and metadata for a field of an [ADF Form](form.component.md).
## Properties ## Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
|--|--|--|--| | ---- | ---- | ------- | ----------- |
| id | string | | Field ID | | id | string | | Field ID |
| name | string | | Field name | | name | string | | Field name |
| type | string | | Field type (see [Form Rendering service](form-rendering.service.md) for a list of available type strings) | | type | string | | Field type (see [Form Rendering service](form-rendering.service.md) for a list of available type strings) |
@@ -23,7 +23,7 @@ Contains the value and metadata for a field of an [ADF Form](form.component.md).
| minValue | string | | Minimum allowed value (eg, for number or date) | | minValue | string | | Minimum allowed value (eg, for number or date) |
| maxValue | string | | Minimum allowed value (eg, for number or date) | | maxValue | string | | Minimum allowed value (eg, for number or date) |
| regexPattern | string | | Regular expression that text data should match | | regexPattern | string | | Regular expression that text data should match |
| options | FormFieldOption[] | [] | Option items for a dropdown menu | | options | FormFieldOption\[] | \[] | Option items for a dropdown menu |
| restUrl | string | | URL for a REST call to populate a dropdown menu | | restUrl | string | | URL for a REST call to populate a dropdown menu |
| restResponsePath | string | | Path within REST response JSON to the array of dropdown data | | restResponsePath | string | | Path within REST response JSON to the array of dropdown data |
| restIdProperty | string | | JSON property name to use for the `id` property of a dropdown item | | restIdProperty | string | | JSON property name to use for the `id` property of a dropdown item |
@@ -40,8 +40,8 @@ Contains the value and metadata for a field of an [ADF Form](form.component.md).
| currency | string | null | Currency symbol for Amount widgets | | currency | string | null | Currency symbol for Amount widgets |
| dateDisplayFormat | string | | Date/time display format template | | dateDisplayFormat | string | | Date/time display format template |
| numberOfColumns | number | 1 | Number of columns defined by a container field | | numberOfColumns | number | 1 | Number of columns defined by a container field |
| fields | FormFieldModel[] | [] | Fields contained within a container field | | fields | FormFieldModel\[] | \[] | Fields contained within a container field |
| columns | ContainerColumnModel[] | [] | Column definitions for a container field | | columns | ContainerColumnModel\[] | \[] | Column definitions for a container field |
| emptyOption | FormFieldOption | | Dropdown menu item to use when no option is chosen | | emptyOption | FormFieldOption | | Dropdown menu item to use when no option is chosen |
| validationSummary | string | | Error/information message added during field validation (see [FormFieldValidator](FormFieldValidator) interface) | | validationSummary | string | | Error/information message added during field validation (see [FormFieldValidator](FormFieldValidator) interface) |
@@ -75,24 +75,21 @@ properties used by the call are:
- `restUrl`: The URL for the REST service - `restUrl`: The URL for the REST service
- `restResponsePath`: Optional path to an array within the JSON object returned by - `restResponsePath`: Optional path to an array within the JSON object returned by
the REST call. Each element in the array corresponds to an item on the dropdown. the REST call. Each element in the array corresponds to an item on the dropdown.
- `restIdProperty`: The name of a JSON property present in each element of the array - `restIdProperty`: The name of a JSON property present in each element of the array
selected by `restResponsePath`. Its value will be used for the `id` property of the selected by `restResponsePath`. Its value will be used for the `id` property of the
dropdown item. dropdown item.
`restLabelProperty`: The name of a JSON property present in each element of the array `restLabelProperty`: The name of a JSON property present in each element of the array
selected by `restResponsePath`. Its value will be used for the `label` property of the selected by `restResponsePath`. Its value will be used for the `label` property of the
dropdown item (ie, the text visible to the user). dropdown item (ie, the text visible to the user).
The [REST Call Task 101](https://community.alfresco.com/community/bpm/blog/2016/08/31/rest-integration-101) The [REST Call Task 101](https://community.alfresco.com/community/bpm/blog/2016/08/31/rest-integration-101)
tutorial on the [APS community site](https://community.alfresco.com/community/bpm) tutorial on the [APS community site](https://community.alfresco.com/community/bpm)
contains full details about how the REST calls work, along with a worked example. contains full details about how the REST calls work, along with a worked example.
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
## See also ## See also
- [Extensibility](extensibility.md) - [Extensibility](extensibility.md)
- [FormFieldValidator](FormFieldValidator.md) - [FormFieldValidator](FormFieldValidator.md)
- [Form rendering service](form-rendering.service.md) - [Form rendering service](form-rendering.service.md)
- [Form component](form.component.md) - [Form component](form.component.md)
<!-- seealso end -->

8
docs/form-rendering.service.md
View File

@@ -47,7 +47,7 @@ formRenderingService.setComponentTypeResolver('text', customResolver, true);
The Form Rendering service is initialized with the mapping shown in the table below: The Form Rendering service is initialized with the mapping shown in the table below:
| Stencil name | Field type string | Component type | | Stencil name | Field type string | Component type |
|---|---|---| | ------------ | ----------------- | -------------- |
| Amount | "amount" | AmountWidgetComponent | | Amount | "amount" | AmountWidgetComponent |
| Attach | "upload" | AttachWidgetComponent or UploadWidgetComponent (based on metadata) | | Attach | "upload" | AttachWidgetComponent or UploadWidgetComponent (based on metadata) |
| Checkbox | "boolean" | CheckboxWidgetComponent | | Checkbox | "boolean" | CheckboxWidgetComponent |
@@ -84,14 +84,8 @@ implements a modified layout or responds differently when the data is entered. S
[Form Extensibility and Customisation](extensibility.md) guide for further details and examples [Form Extensibility and Customisation](extensibility.md) guide for further details and examples
of this technique. of this technique.
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
## See also ## See also
- [Extensibility](extensibility.md) - [Extensibility](extensibility.md)
- [Form field model](form-field.model.md) - [Form field model](form-field.model.md)
- [Form component](form.component.md) - [Form component](form.component.md)
<!-- seealso end -->

5
docs/form.component.md
View File

@@ -275,10 +275,6 @@ formService.formEvents.subscribe((event: Event) => {
}); });
``` ```
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
## See also ## See also
- [Stencils](stencils.md) - [Stencils](stencils.md)
@@ -286,4 +282,3 @@ formService.formEvents.subscribe((event: Event) => {
- [Extensibility](extensibility.md) - [Extensibility](extensibility.md)
- [Form rendering service](form-rendering.service.md) - [Form rendering service](form-rendering.service.md)
- [Form field model](form-field.model.md) - [Form field model](form-field.model.md)
<!-- seealso end -->

48
docs/form.service.md
View File

@@ -32,7 +32,7 @@ class MyComponent {
### Events ### Events
| Name | Args Type | Description | | Name | Args Type | Description |
| --- | --- | --- | | ---- | --------- | ----------- |
| formLoaded | FormEvent | Raised when form has been loaded or reloaded | | formLoaded | FormEvent | Raised when form has been loaded or reloaded |
| formFieldValueChanged | FormFieldEvent | Raised when input values change | | formFieldValueChanged | FormFieldEvent | Raised when input values change |
| taskCompleted | FormEvent | Raised when a task is completed successfully | | taskCompleted | FormEvent | Raised when a task is completed successfully |
@@ -42,30 +42,30 @@ class MyComponent {
| executeOutcome | FormOutcomeEvent | Raised when a form outcome is executed | | executeOutcome | FormOutcomeEvent | Raised when a form outcome is executed |
| formEvents | Event | You can subscribe to this event to listen : ( click, blur, change, focus, focusin, focusout, input, invalid, select) of any elements in the form , see doc below | | formEvents | Event | You can subscribe to this event to listen : ( click, blur, change, focus, focusin, focusout, input, invalid, select) of any elements in the form , see doc below |
| validateForm | ValidateFormEvent | Raised each time a form is validated. You can use it to provide custom validation or prevent default behaviour. | | validateForm | ValidateFormEvent | Raised each time a form is validated. You can use it to provide custom validation or prevent default behaviour. |
| validateFormField | ValidateFormFieldEvent | Raised each time a form field is validated. You can use it to provide custom validation or prevent default behaviour.| | validateFormField | ValidateFormFieldEvent | Raised each time a form field is validated. You can use it to provide custom validation or prevent default behaviour. |
### Methods ### Methods
| Name | Params | Returns | Description | | Name | Params | Returns | Description |
| --- | --- | --- | --- | | ---- | ------ | ------- | ----------- |
| createFormFromANode | (formName: string) | Observable\<any\> | Create a Form with a fields for each metadata properties | | createFormFromANode | (formName: string) | Observable\\&lt;any> | Create a Form with a fields for each metadata properties |
| createForm | (formName: string) | Observable\<any\> | Create a Form | | createForm | (formName: string) | Observable\\&lt;any> | Create a Form |
| addFieldsToAForm | (formId: string, formModel: FormDefinitionModel) | Observable\<any\> | Add Fileds to A form | | addFieldsToAForm | (formId: string, formModel: FormDefinitionModel) | Observable\\&lt;any> | Add Fileds to A form |
| searchFrom | (name: string) | Observable\<any\> | Search For A Form by name | | searchFrom | (name: string) | Observable\\&lt;any> | Search For A Form by name |
| getForms | n/a | Observable\<any\> | Get All the forms | | getForms | n/a | Observable\\&lt;any> | Get All the forms |
| getProcessDefinitions | n/a | Observable\<any\> | Get Process Definitions | | getProcessDefinitions | n/a | Observable\\&lt;any> | Get Process Definitions |
| getTasks | n/a | Observable\<any\> | Get All the Tasks | | getTasks | n/a | Observable\\&lt;any> | Get All the Tasks |
| getTask | (taskId: string) | Observable\<any\> | Get Task | | getTask | (taskId: string) | Observable\\&lt;any> | Get Task |
| saveTaskForm | (taskId: string, formValues: FormValues) | Observable\<any\> | Save Task Form | | saveTaskForm | (taskId: string, formValues: FormValues) | Observable\\&lt;any> | Save Task Form |
| completeTaskForm | (taskId: string, formValues: FormValues, outcome?: string) | Observable\<any\> | Complete Task Form | | completeTaskForm | (taskId: string, formValues: FormValues, outcome?: string) | Observable\\&lt;any> | Complete Task Form |
| getTaskForm | (taskId: string) | Observable\<any\> | Get Form related to a taskId | | getTaskForm | (taskId: string) | Observable\\&lt;any> | Get Form related to a taskId |
| getFormDefinitionById | (formId: string) | Observable\<any\> | Get Form Definition | | getFormDefinitionById | (formId: string) | Observable\\&lt;any> | Get Form Definition |
| getFormDefinitionByName | (name: string) | Observable\<any\> | Returns form definition by a given name. | | getFormDefinitionByName | (name: string) | Observable\\&lt;any> | Returns form definition by a given name. |
| getStartFormInstance | (processId: string) | Observable\<any\> | Get start form instance for a given processId | | getStartFormInstance | (processId: string) | Observable\\&lt;any> | Get start form instance for a given processId |
| getStartFormDefinition | (processId: string) | Observable\<any\> | Get start form definition for a given process | | getStartFormDefinition | (processId: string) | Observable\\&lt;any> | Get start form definition for a given process |
| getRestFieldValues | (taskId: string, field: string) | Observable\<any\> | | | getRestFieldValues | (taskId: string, field: string) | Observable\\&lt;any> | |
| getRestFieldValuesByProcessId | (processDefinitionId: string, field: string) | Observable\<any\> | | | getRestFieldValuesByProcessId | (processDefinitionId: string, field: string) | Observable\\&lt;any> | |
| getRestFieldValuesColumnByProcessId | (processDefinitionId: string, field: string, column?: string) | Observable\<any\> | | | getRestFieldValuesColumnByProcessId | (processDefinitionId: string, field: string, column?: string) | Observable\\&lt;any> | |
| getRestFieldValuesColumn | (taskId: string, field: string, column?: string) | Observable\<any\> | | | getRestFieldValuesColumn | (taskId: string, field: string, column?: string) | Observable\\&lt;any> | |
| getWorkflowGroups\ | (filter: string, groupId?: string) | Observable\<GroupModel[]\> | | | getWorkflowGroups\\ | (filter: string, groupId?: string) | Observable\\&lt;GroupModel\[]> | |
| getWorkflowUsers\ | (filter: string, groupId?: string) | Observable\<GroupUserModel[]\> | | | getWorkflowUsers\\ | (filter: string, groupId?: string) | Observable\\&lt;GroupUserModel\[]> | |

2
lib/config/DocProcessor/doctool.config.json
View File

@@ -1,5 +1,5 @@
{ {
"enabledTools": [ "enabledTools": [
"toc" "index"
] ]
} }

2
lib/package.json
View File

@@ -20,7 +20,7 @@
"bundlesize-check": "bundlesize", "bundlesize-check": "bundlesize",
"markdownlint": "markdownlint ../docs", "markdownlint": "markdownlint ../docs",
"doc": "npm run toc && npm run markdownlint && npm run webpack -- --config config/webpack.doc.js --progress --profile --bail", "doc": "npm run toc && npm run markdownlint && npm run webpack -- --config config/webpack.doc.js --progress --profile --bail",
"docindex": "node config/buildFullDocIndex.js", "docindex": "node config/DocProcessor/docProcessor.js ../docs",
"copy-i18n": "mkdir -p core/dist/bundles/assets/adf-core/i18n && cp -R core/i18n/* core/dist/bundles/assets/adf-core/i18n && mkdir -p content-services/dist/bundles/assets/adf-content-services/i18n && cp -R content-services/i18n/* content-services/dist/bundles/assets/adf-content-services/i18n && mkdir -p process-services/dist/bundles/assets/adf-process-services/i18n && cp -R process-services/i18n/* process-services/dist/bundles/assets/adf-process-services/i18n && mkdir -p insights/dist/bundles/assets/adf-insights/i18n && cp -R insights/i18n/* insights/dist/bundles/assets/adf-insights/i18n", "copy-i18n": "mkdir -p core/dist/bundles/assets/adf-core/i18n && cp -R core/i18n/* core/dist/bundles/assets/adf-core/i18n && mkdir -p content-services/dist/bundles/assets/adf-content-services/i18n && cp -R content-services/i18n/* content-services/dist/bundles/assets/adf-content-services/i18n && mkdir -p process-services/dist/bundles/assets/adf-process-services/i18n && cp -R process-services/i18n/* process-services/dist/bundles/assets/adf-process-services/i18n && mkdir -p insights/dist/bundles/assets/adf-insights/i18n && cp -R insights/i18n/* insights/dist/bundles/assets/adf-insights/i18n",
"copy-assets": "cp -R core/assets/* core/dist/bundles/assets && cp -R content-services/assets/* content-services/dist/bundles/assets && cp -R process-services/assets/* process-services/dist/bundles/assets", "copy-assets": "cp -R core/assets/* core/dist/bundles/assets && cp -R content-services/assets/* content-services/dist/bundles/assets && cp -R process-services/assets/* process-services/dist/bundles/assets",
"new-build": "npm run build-bundles && npm run build-style-new && npm run copy-i18n && npm run copy-assets", "new-build": "npm run build-bundles && npm run build-style-new && npm run copy-i18n && npm run copy-assets",