diff --git a/docs/README.md b/docs/README.md index b85ee39818..fe7bacbcc7 100644 --- a/docs/README.md +++ b/docs/README.md @@ -80,164 +80,164 @@ for more information about installing and using the source code. ### Components -| Name | Description | Source link | -| ---- | ----------- | ----------- | -| [About Application Modules Component](core/components/about-application.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows which ADF libraries and plugins an application is using. | [Source](../lib/core/about/about-application-modules/about-application-modules.component.ts) | -| [About GitHub Link Component](core/components/about-github-link.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows which version of the application is running based on the latest GitHub commit, as well as the server settings for the application. | [Source](../lib/core/about/about-github-link/about-github-link.component.ts) | -| [About Product Version Component](core/components/about-product-version.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows which version of Process Services (BPM) and Content Services (ECM) an application is running. It also shows the relevant license information, application status and Alfresco modules running in an application. | [Source](../lib/core/about/about-product-version/about-product-version.component.ts) | -| [Buttons Menu Component](core/components/buttons-menu.component.md) | Displays buttons on a responsive menu. | [Source](../lib/core/buttons-menu/buttons-menu.component.ts) | -| [Card View component](core/components/card-view.component.md) | Displays a configurable property list renderer. | [Source](../lib/core/card-view/components/card-view/card-view.component.ts) | -| [Comment list component](core/components/comment-list.component.md) | Shows a list of comments. | [Source](../lib/core/comments/comment-list.component.ts) | -| [Comments Component](core/components/comments.component.md) | Displays comments from users involved in a specified task or content and allows an involved user to add a comment to a task or a content. | [Source](../lib/core/comments/comments.component.ts) | -| [Data Column Component](core/components/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](core/components/datatable.component.md) | Displays data as a table with customizable columns and presentation. | [Source](../lib/core/datatable/components/datatable/datatable.component.ts) | -| [Empty Content Component](core/components/empty-content.component.md) | Provides a generic "Empty Content" placeholder for components. | [Source](../lib/core/templates/empty-content/empty-content.component.ts) | -| [Empty list component](core/components/empty-list.component.md) | Displays a message indicating that a list is empty. | [Source](../lib/core/datatable/components/empty-list/empty-list.component.ts) | -| [Error Content Component](core/components/error-content.component.md) | Displays info about a specific error. | [Source](../lib/core/templates/error-content/error-content.component.ts) | -| [Form field component](core/components/form-field.component.md) | Represents a UI field in a form. | [Source](../lib/core/form/components/form-field/form-field.component.ts) | -| [Form List Component](core/components/form-list.component.md) | Shows forms as a list. | [Source](../lib/core/form/components/form-list.component.ts) | -| [Header component](core/components/header.component.md) | Reusable header for Alfresco applications. | [Source](../lib/core/layout/components/header/header.component.ts) | -| [Host settings component](core/components/host-settings.component.md) ![Internal](docassets/images/InternalIcon.png) | Validates the URLs for ACS and APS and saves them in the user's local storage | [Source](../lib/core/settings/host-settings.component.ts) | -| [Icon Component](core/components/icon.component.md) | Provides a universal way of rendering registered and named icons. | [Source](../lib/core/icon/icon.component.ts) | -| [Infinite Pagination component](core/components/infinite-pagination.component.md) | Adds "infinite" pagination to the component it is used with. | [Source](../lib/core/pagination/infinite-pagination.component.ts) | -| [Info drawer layout component](core/components/info-drawer-layout.component.md) | Displays a sidebar-style information panel. | [Source](../lib/core/info-drawer/info-drawer-layout.component.ts) | -| [Info Drawer Tab component](core/components/info-drawer-tab.component.md) | Renders tabs in a Info drawer component. | [Source](../lib/core/info-drawer/info-drawer.component.ts) | -| [Info Drawer component](core/components/info-drawer.component.md) | Displays a sidebar-style information panel with tabs. | [Source](../lib/core/info-drawer/info-drawer.component.ts) | -| [Json Cell component](core/components/json-cell.component.md) | Shows a JSON-formatted value inside a datatable component. | [Source](../lib/core/datatable/components/json-cell/json-cell.component.ts) | -| [Language Menu component](core/components/language-menu.component.md) | Displays all the languages that are present in "app.config.json" and the default (EN). | [Source](../lib/core/language-menu/language-menu.component.ts) | -| [Login Dialog Panel component](core/components/login-dialog-panel.component.md) | Shows and manages a login dialog. | [Source](../lib/core/login/components/login-dialog-panel.component.ts) | -| [Login Dialog component](core/components/login-dialog.component.md) | Allows a user to perform a login via a dialog. | [Source](../lib/core/login/components/login-dialog.component.ts) | -| [Login component](core/components/login.component.md) | Authenticates to Alfresco Content Services and Alfresco Process Services. | [Source](../lib/core/login/components/login.component.ts) | -| [Notification History component](core/components/notification-history.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | This component is in the current status just an experimental component. | | -| The main purpose of the Notification history component is list all the notification received in the current session. They will disappear from the list after the refresh. | [Source](../lib/core/notifications/components/notification-history.component.ts) | | -| [Pagination Component](core/components/pagination.component.md) | Adds pagination to the component it is used with. | [Source](../lib/core/pagination/pagination.component.ts) | -| [Search Text Input Component](core/components/search-text-input.component.md) | Displays a input text that supports autocompletion | [Source](../lib/core/search-text/search-text-input.component.ts) | -| [Sidebar action menu component](core/components/sidebar-action-menu.component.md) | Displays a sidebar-action menu information panel. | [Source](../lib/core/layout/components/sidebar-action/sidebar-action-menu.component.ts) | -| [Sidenav Layout component](core/components/sidenav-layout.component.md) | Displays the standard three-region ADF application layout. | [Source](../lib/core/layout/components/sidenav-layout/sidenav-layout.component.ts) | -| [Sorting Picker Component](core/components/sorting-picker.component.md) | Selects from a set of predefined sorting definitions and directions. | [Source](../lib/core/sorting-picker/sorting-picker.component.ts) | -| [Start Form component](core/components/start-form.component.md) | Displays the Start Form for a process. | [Source](../lib/process-services/src/lib/form/start-form.component.ts) | -| [Text Mask directive](core/components/text-mask.component.md) | Implements text field input masks. | [Source](../lib/core/form/components/widgets/text/text-mask.component.ts) | -| [Toolbar Divider Component](core/components/toolbar-divider.component.md) | Divides groups of elements in a Toolbar with a visual separator. | [Source](../lib/core/toolbar/toolbar-divider.component.ts) | -| [Toolbar Title Component](core/components/toolbar-title.component.md) | Supplies custom HTML to be included in a Toolbar component title. | [Source](../lib/core/toolbar/toolbar-title.component.ts) | -| [Toolbar Component](core/components/toolbar.component.md) | Simple container for headers, titles, actions and breadcrumbs. | [Source](../lib/core/toolbar/toolbar.component.ts) | -| [User Info component](core/components/user-info.component.md) | Shows user information. | [Source](../lib/core/userinfo/components/user-info.component.ts) | -| [Viewer component](core/components/viewer.component.md) | Displays content from an ACS repository. | [Source](../lib/core/viewer/components/viewer.component.ts) | +| Name | Description | Source link | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| [About Application Modules Component](core/components/about-application.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows which ADF libraries and plugins an application is using. | [Source](../lib/core/about/about-application-modules/about-application-modules.component.ts) | +| [About GitHub Link Component](core/components/about-github-link.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows which version of the application is running based on the latest GitHub commit, as well as the server settings for the application. | [Source](../lib/core/about/about-github-link/about-github-link.component.ts) | +| [About Product Version Component](core/components/about-product-version.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows which version of Process Services (BPM) and Content Services (ECM) an application is running. It also shows the relevant license information, application status and Alfresco modules running in an application. | [Source](../lib/core/about/about-product-version/about-product-version.component.ts) | +| [Buttons Menu Component](core/components/buttons-menu.component.md) | Displays buttons on a responsive menu. | [Source](../lib/core/buttons-menu/buttons-menu.component.ts) | +| [Card View component](core/components/card-view.component.md) | Displays a configurable property list renderer. | [Source](../lib/core/card-view/components/card-view/card-view.component.ts) | +| [Comment list component](core/components/comment-list.component.md) | Shows a list of comments. | [Source](../lib/core/comments/comment-list.component.ts) | +| [Comments Component](core/components/comments.component.md) | Displays comments from users involved in a specified task or content and allows an involved user to add a comment to a task or a content. | [Source](../lib/core/comments/comments.component.ts) | +| [Data Column Component](core/components/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](core/components/datatable.component.md) | Displays data as a table with customizable columns and presentation. | [Source](../lib/core/datatable/components/datatable/datatable.component.ts) | +| [Empty Content Component](core/components/empty-content.component.md) | Provides a generic "Empty Content" placeholder for components. | [Source](../lib/core/templates/empty-content/empty-content.component.ts) | +| [Empty list component](core/components/empty-list.component.md) | Displays a message indicating that a list is empty. | [Source](../lib/core/datatable/components/empty-list/empty-list.component.ts) | +| [Error Content Component](core/components/error-content.component.md) | Displays info about a specific error. | [Source](../lib/core/templates/error-content/error-content.component.ts) | +| [Form field component](core/components/form-field.component.md) | Represents a UI field in a form. | [Source](../lib/core/form/components/form-field/form-field.component.ts) | +| [Form List Component](core/components/form-list.component.md) | Shows forms as a list. | [Source](../lib/core/form/components/form-list.component.ts) | +| [Header component](core/components/header.component.md) | Reusable header for Alfresco applications. | [Source](../lib/core/layout/components/header/header.component.ts) | +| [Host settings component](core/components/host-settings.component.md) ![Internal](docassets/images/InternalIcon.png) | Validates the URLs for ACS and APS and saves them in the user's local storage | [Source](../lib/core/settings/host-settings.component.ts) | +| [Icon Component](core/components/icon.component.md) | Provides a universal way of rendering registered and named icons. | [Source](../lib/core/icon/icon.component.ts) | +| [Infinite Pagination component](core/components/infinite-pagination.component.md) | Adds "infinite" pagination to the component it is used with. | [Source](../lib/core/pagination/infinite-pagination.component.ts) | +| [Info drawer layout component](core/components/info-drawer-layout.component.md) | Displays a sidebar-style information panel. | [Source](../lib/core/info-drawer/info-drawer-layout.component.ts) | +| [Info Drawer Tab component](core/components/info-drawer-tab.component.md) | Renders tabs in a Info drawer component. | [Source](../lib/core/info-drawer/info-drawer.component.ts) | +| [Info Drawer component](core/components/info-drawer.component.md) | Displays a sidebar-style information panel with tabs. | [Source](../lib/core/info-drawer/info-drawer.component.ts) | +| [Json Cell component](core/components/json-cell.component.md) | Shows a JSON-formatted value inside a datatable component. | [Source](../lib/core/datatable/components/json-cell/json-cell.component.ts) | +| [Language Menu component](core/components/language-menu.component.md) | Displays all the languages that are present in "app.config.json" and the default (EN). | [Source](../lib/core/language-menu/language-menu.component.ts) | +| [Login Dialog Panel component](core/components/login-dialog-panel.component.md) | Shows and manages a login dialog. | [Source](../lib/core/login/components/login-dialog-panel.component.ts) | +| [Login Dialog component](core/components/login-dialog.component.md) | Allows a user to perform a login via a dialog. | [Source](../lib/core/login/components/login-dialog.component.ts) | +| [Login component](core/components/login.component.md) | Authenticates to Alfresco Content Services and Alfresco Process Services. | [Source](../lib/core/login/components/login.component.ts) | +| [Notification History component](core/components/notification-history.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | This component is in the current status just an experimental component. | | +| The main purpose of the Notification history component is list all the notification received in the current session. They will disappear from the list after the refresh. | [Source](../lib/core/notifications/components/notification-history.component.ts) | | +| [Pagination Component](core/components/pagination.component.md) | Adds pagination to the component it is used with. | [Source](../lib/core/pagination/pagination.component.ts) | +| [Search Text Input Component](core/components/search-text-input.component.md) | Displays a input text that supports autocompletion | [Source](../lib/core/search-text/search-text-input.component.ts) | +| [Sidebar action menu component](core/components/sidebar-action-menu.component.md) | Displays a sidebar-action menu information panel. | [Source](../lib/core/layout/components/sidebar-action/sidebar-action-menu.component.ts) | +| [Sidenav Layout component](core/components/sidenav-layout.component.md) | Displays the standard three-region ADF application layout. | [Source](../lib/core/layout/components/sidenav-layout/sidenav-layout.component.ts) | +| [Sorting Picker Component](core/components/sorting-picker.component.md) | Selects from a set of predefined sorting definitions and directions. | [Source](../lib/core/sorting-picker/sorting-picker.component.ts) | +| [Start Form component](core/components/start-form.component.md) | Displays the Start Form for a process. | [Source](../lib/process-services/src/lib/form/start-form.component.ts) | +| [Text Mask directive](core/components/text-mask.component.md) | Implements text field input masks. | [Source](../lib/core/form/components/widgets/text/text-mask.component.ts) | +| [Toolbar Divider Component](core/components/toolbar-divider.component.md) | Divides groups of elements in a Toolbar with a visual separator. | [Source](../lib/core/toolbar/toolbar-divider.component.ts) | +| [Toolbar Title Component](core/components/toolbar-title.component.md) | Supplies custom HTML to be included in a Toolbar component title. | [Source](../lib/core/toolbar/toolbar-title.component.ts) | +| [Toolbar Component](core/components/toolbar.component.md) | Simple container for headers, titles, actions and breadcrumbs. | [Source](../lib/core/toolbar/toolbar.component.ts) | +| [User Info component](core/components/user-info.component.md) | Shows user information. | [Source](../lib/core/userinfo/components/user-info.component.ts) | +| [Viewer component](core/components/viewer.component.md) | Displays content from an ACS repository. | [Source](../lib/core/viewer/components/viewer.component.ts) | ### Directives -| Name | Description | Source link | -| ---- | ----------- | ----------- | -| [Check Allowable Operation directive](core/directives/check-allowable-operation.directive.md) | Selectively disables an HTML element or Angular component. | [Source](../lib/core/directives/check-allowable-operation.directive.ts) | -| [Clipboard directive](core/directives/clipboard.directive.md) | Copies text to the clipboard. | [Source](../lib/core/clipboard/clipboard.directive.ts) | -| [Context Menu directive](core/directives/context-menu.directive.md) | Adds a context menu to a component. | [Source](../lib/core/context-menu/context-menu.directive.ts) | -| [Highlight directive](core/directives/highlight.directive.md) | Adds highlighting to selected sections of an HTML element's content. | [Source](../lib/core/directives/highlight.directive.ts) | -| [Logout directive](core/directives/logout.directive.md) | Logs the user out when the decorated element is clicked. | [Source](../lib/core/directives/logout.directive.ts) | -| [Node Delete directive](core/directives/node-delete.directive.md) | Deletes multiple files and folders. | [Source](../lib/core/directives/node-delete.directive.ts) | -| [Node Download directive](core/directives/node-download.directive.md) | Allows folders and/or files to be downloaded, with multiple nodes packed as a '.ZIP' archive. | [Source](../lib/core/directives/node-download.directive.ts) | -| [Node Favorite directive](core/directives/node-favorite.directive.md) | Selectively toggles nodes as favorites. | [Source](../lib/core/directives/node-favorite.directive.ts) | -| [Node Restore directive](core/directives/node-restore.directive.md) | Restores deleted nodes to their original location. | [Source](../lib/core/directives/node-restore.directive.ts) | -| [Upload Directive](core/directives/upload.directive.md) | Uploads content in response to file drag and drop. | [Source](../lib/core/directives/upload.directive.ts) | -| [Version Compatibility Directive](core/directives/version-compatibility.directive.md) | Enables/disables components based on ACS version in use. | [Source](../lib/core/directives/version-compatibility.directive.ts) | +| Name | Description | Source link | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| [Check Allowable Operation directive](core/directives/check-allowable-operation.directive.md) | Selectively disables an HTML element or Angular component. | [Source](../lib/core/directives/check-allowable-operation.directive.ts) | +| [Clipboard directive](core/directives/clipboard.directive.md) | Copies text to the clipboard. | [Source](../lib/core/clipboard/clipboard.directive.ts) | +| [Context Menu directive](core/directives/context-menu.directive.md) | Adds a context menu to a component. | [Source](../lib/core/context-menu/context-menu.directive.ts) | +| [Highlight directive](core/directives/highlight.directive.md) | Adds highlighting to selected sections of an HTML element's content. | [Source](../lib/core/directives/highlight.directive.ts) | +| [Logout directive](core/directives/logout.directive.md) | Logs the user out when the decorated element is clicked. | [Source](../lib/core/directives/logout.directive.ts) | +| [Node Delete directive](core/directives/node-delete.directive.md) | Deletes multiple files and folders. | [Source](../lib/core/directives/node-delete.directive.ts) | +| [Node Download directive](core/directives/node-download.directive.md) | Allows folders and/or files to be downloaded, with multiple nodes packed as a '.ZIP' archive. | [Source](../lib/core/directives/node-download.directive.ts) | +| [Node Favorite directive](core/directives/node-favorite.directive.md) | Selectively toggles nodes as favorites. | [Source](../lib/core/directives/node-favorite.directive.ts) | +| [Node Restore directive](core/directives/node-restore.directive.md) | Restores deleted nodes to their original location. | [Source](../lib/core/directives/node-restore.directive.ts) | +| [Upload Directive](core/directives/upload.directive.md) | Uploads content in response to file drag and drop. | [Source](../lib/core/directives/upload.directive.ts) | +| [Version Compatibility Directive](core/directives/version-compatibility.directive.md) | Enables/disables components based on ACS version in use. | [Source](../lib/core/directives/version-compatibility.directive.ts) | ### Dialogs -| Name | Description | Source link | -| ---- | ----------- | ----------- | +| Name | Description | Source link | +| ---------------------------------------------------- | ------------------------------------------------------------ | ---------------------------------------------------------------- | | [Edit JSON Dialog](core/dialogs/edit-json.dialog.md) | Allows a user to preview or edit a JSON content in a dialog. | [Source](../lib/testing/src/lib/core/dialog/edit-json-dialog.ts) | ### Interfaces -| Name | Description | Source link | -| ---- | ----------- | ----------- | -| [Card View Item interface](core/interfaces/card-view-item.interface.md) | Defines the implementation of an item in a Card View component. | [Source](../lib/core/card-view/interfaces/card-view-item.interface.ts) | -| [DataTableAdapter interface](core/interfaces/datatable-adapter.interface.md) | Defines how table data is supplied to DataTable and Tasklist components. | [Source](../lib/core/datatable/data/datatable-adapter.ts) | -| [FormFieldValidator interface](core/interfaces/form-field-validator.interface.md) | Defines how the input fields of Form and Task Details components are validated. | [Source](../lib/core/form/components/widgets/core/form-field-validator.ts) | -| [Search Configuration interface](core/interfaces/search-configuration.interface.md) | Provides fine control of parameters to a search. | [Source](../lib/core/interface/search-configuration.interface.ts) | +| Name | Description | Source link | +| ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| [Card View Item interface](core/interfaces/card-view-item.interface.md) | Defines the implementation of an item in a Card View component. | [Source](../lib/core/card-view/interfaces/card-view-item.interface.ts) | +| [DataTableAdapter interface](core/interfaces/datatable-adapter.interface.md) | Defines how table data is supplied to DataTable and Tasklist components. | [Source](../lib/core/datatable/data/datatable-adapter.ts) | +| [FormFieldValidator interface](core/interfaces/form-field-validator.interface.md) | Defines how the input fields of Form and Task Details components are validated. | [Source](../lib/core/form/components/widgets/core/form-field-validator.ts) | +| [Search Configuration interface](core/interfaces/search-configuration.interface.md) | Provides fine control of parameters to a search. | [Source](../lib/core/interface/search-configuration.interface.ts) | ### Models -| Name | Description | Source link | -| ---- | ----------- | ----------- | -| [Bpm User model](core/models/bpm-user.model.md) | Contains information about a Process Services user. | [Source](../lib/core/models/bpm-user.model.ts) | -| [Ecm User model](core/models/ecm-user.model.md) | Contains information about a Content Services user. | [Source](../lib/core/models/ecm-user.model.ts) | -| [Form Field model](core/models/form-field.model.md) | Contains the value and metadata for a field of a Form component. | [Source](../lib/core/form/components/widgets/core/form-field.model.ts) | -| [Product Version model](core/models/product-version.model.md) | Contains version and license information classes for Alfresco products. | [Source](../lib/core/models/product-version.model.ts) | -| [User Process model](core/models/user-process.model.md) | Represents a Process Services user. | [Source](../lib/core/models/user-process.model.ts) | +| Name | Description | Source link | +| ------------------------------------------------------------- | ----------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| [Bpm User model](core/models/bpm-user.model.md) | Contains information about a Process Services user. | [Source](../lib/core/models/bpm-user.model.ts) | +| [Ecm User model](core/models/ecm-user.model.md) | Contains information about a Content Services user. | [Source](../lib/core/models/ecm-user.model.ts) | +| [Form Field model](core/models/form-field.model.md) | Contains the value and metadata for a field of a Form component. | [Source](../lib/core/form/components/widgets/core/form-field.model.ts) | +| [Product Version model](core/models/product-version.model.md) | Contains version and license information classes for Alfresco products. | [Source](../lib/core/models/product-version.model.ts) | +| [User Process model](core/models/user-process.model.md) | Represents a Process Services user. | [Source](../lib/core/models/user-process.model.ts) | ### Pipes -| Name | Description | Source link | -| ---- | ----------- | ----------- | -| [App Config Pipe](core/pipes/app-config.pipe.md) | Retrieves values from the application configuration file directly. | [Source](../lib/core/app-config/app-config.pipe.ts) | -| [Decimal Number Pipe](core/pipes/decimal-number.pipe.md) | Transforms a number to have a certain amount of digits in its integer part and also in its decimal part. | [Source](../lib/core/pipes/decimal-number.pipe.ts) | -| [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) | -| [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) | -| [User Initial pipe](core/pipes/user-initial.pipe.md) | Takes the name fields of a UserProcessModel object and extracts and formats the initials. | [Source](../lib/core/pipes/user-initial.pipe.ts) | +| Name | Description | Source link | +| -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------- | +| [App Config Pipe](core/pipes/app-config.pipe.md) | Retrieves values from the application configuration file directly. | [Source](../lib/core/app-config/app-config.pipe.ts) | +| [Decimal Number Pipe](core/pipes/decimal-number.pipe.md) | Transforms a number to have a certain amount of digits in its integer part and also in its decimal part. | [Source](../lib/core/pipes/decimal-number.pipe.ts) | +| [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) | +| [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) | +| [User Initial pipe](core/pipes/user-initial.pipe.md) | Takes the name fields of a UserProcessModel object and extracts and formats the initials. | [Source](../lib/core/pipes/user-initial.pipe.ts) | ### Services -| Name | Description | Source link | -| ---- | ----------- | ----------- | -| [APS Alfresco Content Service](core/services/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) | -| [Alfresco Api Service](core/services/alfresco-api.service.md) | Provides access to an initialized AlfrescoJSApi instance. | [Source](../lib/core/services/alfresco-api.service.ts) | -| [App Config service](core/services/app-config.service.md) | Supports app configuration settings, stored server side. | [Source](../lib/core/app-config/app-config.service.ts) | -| [Apps Process service](core/services/apps-process.service.md) | Gets details of the Process Services apps that are deployed for the user. | [Source](../lib/core/services/apps-process.service.ts) | -| [Auth Guard Bpm service](core/services/auth-guard-bpm.service.md) | Adds authentication with Process Services to a route within the app. | [Source](../lib/core/services/auth-guard-bpm.service.ts) | -| [Auth Guard Ecm service](core/services/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 SSO Role service](core/services/auth-guard-sso-role.service.md) | Checks the user roles of a user. | [Source](../lib/core/services/auth-guard-sso-role.service.ts) | -| [Auth Guard service](core/services/auth-guard.service.md) | Adds authentication to a route within the app. | [Source](../lib/core/services/auth-guard.service.ts) | -| [Authentication Service](core/services/authentication.service.md) | Provides authentication to ACS and APS. | [Source](../lib/core/services/authentication.service.ts) | -| [Bpm User service](core/services/bpm-user.service.md) | Gets information about the current Process Services user. | [Source](../lib/core/services/bpm-user.service.ts) | -| [Card Item Type service](core/services/card-item-types.service.md) | Maps type names to field component types for the Card View component. | [Source](../lib/core/card-view/services/card-item-types.service.ts) | -| [Card View Update service](core/services/card-view-update.service.md) | Reports edits and clicks within fields of a Card View component. | [Source](../lib/core/card-view/services/card-view-update.service.ts) | -| [Clipboard service](core/services/clipboard.service.md) | Copies text to the clipboard. | [Source](../lib/core/clipboard/clipboard.service.ts) | -| [Comment Content service](core/services/comment-content.service.md) | Adds and retrieves comments for nodes in Content Services. | [Source](../lib/core/services/comment-content.service.ts) | -| [Comment Process service](core/services/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](core/services/content.service.md) | Accesses app-generated data objects via URLs and file downloads. | [Source](../lib/core/services/content.service.ts) | -| [Cookie service](core/services/cookie.service.md) | Stores key-value data items as browser cookies. | [Source](../lib/core/services/cookie.service.ts) | -| [Deleted Nodes Api service](core/services/deleted-nodes-api.service.md) | Gets a list of Content Services nodes currently in the trash. | [Source](../lib/core/services/deleted-nodes-api.service.ts) | -| [Discovery Api service](core/services/discovery-api.service.md) | Gets version and license information for Process Services and Content Services. | [Source](../lib/core/services/discovery-api.service.ts) | -| [Download zip service](core/services/download-zip.service.md) | Creates and manages downloads. | [Source](../lib/core/services/download-zip.service.ts) | -| [Ecm User service](core/services/ecm-user.service.md) | Gets information about a Content Services user. | [Source](../lib/core/services/ecm-user.service.ts) | -| [Favorites Api service](core/services/favorites-api.service.md) | Gets a list of items a user has marked as their favorites. | [Source](../lib/core/services/favorites-api.service.ts) | -| [Form Rendering service](core/services/form-rendering.service.md) | Maps a form field type string onto the corresponding form widget component type. | [Source](../lib/core/form/services/form-rendering.service.ts) | -| [Form service](core/services/form.service.md) | Implements Process Services form methods | [Source](../lib/core/form/services/form.service.ts) | -| [Highlight Transform service](core/services/highlight-transform.service.md) | Adds HTML to a string to highlight chosen sections. | [Source](../lib/core/services/highlight-transform.service.ts) | -| [Identity Group service](core/services/identity-group.service.md) | Performs CRUD operations on identity groups. | [Source](../lib/core/services/identity-group.service.ts) | -| [Identity role service](core/services/identity-role.service.md) | Provides APIs for working with the Roles in Identity Services. | [Source](../lib/core/services/identity-role.service.ts) | -| [Identity user service](core/services/identity-user.service.md) | Gets OAuth2 personal details and roles for users and performs CRUD operations on identity users. | [Source](../lib/core/services/identity-user.service.ts) | -| [JWT helper service](core/services/jwt-helper.service.md) | Decodes a JSON Web Token (JWT) to a JavaScript object. | [Source](../lib/core/services/jwt-helper.service.ts) | -| [Log Service](core/services/log.service.md) | Provides log functionality. | [Source](../lib/core/services/log.service.ts) | -| [Login Dialog service](core/services/login-dialog.service.md) | Manages login dialogs. | [Source](../lib/core/services/login-dialog.service.ts) | -| [Node Service](core/services/node.service.md) | use Nodes Api service instead of this. | [Source](../lib/core/form/services/node.service.ts) | -| [Nodes Api service](core/services/nodes-api.service.md) | Accesses and manipulates ACS document nodes using their node IDs. | [Source](../lib/core/services/nodes-api.service.ts) | -| [Notification Service](core/services/notification.service.md) | Shows a notification message with optional feedback. | [Source](../lib/core/notifications/services/notification.service.ts) | -| [Page Title service](core/services/page-title.service.md) | Sets the page title. | [Source](../lib/core/services/page-title.service.ts) | -| [People Content service](core/services/people-content.service.md) | Gets information about a Content Services user. | [Source](../lib/core/services/people-content.service.ts) | -| [People Process service](core/services/people-process.service.md) | Gets information about Process Services users. | [Source](../lib/core/services/people-process.service.ts) | -| [Process Content Service](core/services/process-content.service.md) | Manipulates content related to a Process Instance or Task Instance in APS. | [Source](../lib/core/form/services/process-content.service.ts) | -| [Renditions service](core/services/renditions.service.md) | Manages prearranged conversions of content to different formats. | [Source](../lib/core/services/renditions.service.ts) | -| [Search Configuration service](core/services/search-configuration.service.md) | Provides fine control of parameters to a search. | [Source](../lib/core/services/search-configuration.service.ts) | -| [Search service](core/services/search.service.md) | Accesses the Content Services Search API. | [Source](../lib/core/services/search.service.ts) | -| [Shared Links Api service](core/services/shared-links-api.service.md) | Finds shared links to Content Services items. | [Source](../lib/core/services/shared-links-api.service.ts) | -| [Sites service](core/services/sites.service.md) | Accesses and manipulates sites from a Content Services repository. | [Source](../lib/core/services/sites.service.ts) | -| [Storage service](core/services/storage.service.md) | Stores items in the form of key-value pairs. | [Source](../lib/core/services/storage.service.ts) | -| [Thumbnail service](core/services/thumbnail.service.md) | Retrieves an SVG thumbnail image to represent a document type. | [Source](../lib/core/services/thumbnail.service.ts) | -| [Translation service](core/services/translation.service.md) | Supports localisation. | [Source](../lib/core/services/translation.service.ts) | -| [Upload Service](core/services/upload.service.md) | Provides access to various APIs related to file upload features. | [Source](../lib/core/services/upload.service.ts) | -| [User Preferences Service](core/services/user-preferences.service.md) | Stores preferences for the app and for individual components. | [Source](../lib/core/services/user-preferences.service.ts) | +| Name | Description | Source link | +| ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | +| [APS Alfresco Content Service](core/services/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) | +| [Alfresco Api Service](core/services/alfresco-api.service.md) | Provides access to an initialized AlfrescoJSApi instance. | [Source](../lib/core/services/alfresco-api.service.ts) | +| [App Config service](core/services/app-config.service.md) | Supports app configuration settings, stored server side. | [Source](../lib/core/app-config/app-config.service.ts) | +| [Apps Process service](core/services/apps-process.service.md) | Gets details of the Process Services apps that are deployed for the user. | [Source](../lib/core/services/apps-process.service.ts) | +| [Auth Guard Bpm service](core/services/auth-guard-bpm.service.md) | Adds authentication with Process Services to a route within the app. | [Source](../lib/core/services/auth-guard-bpm.service.ts) | +| [Auth Guard Ecm service](core/services/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 SSO Role service](core/services/auth-guard-sso-role.service.md) | Checks the user roles of a user. | [Source](../lib/core/services/auth-guard-sso-role.service.ts) | +| [Auth Guard service](core/services/auth-guard.service.md) | Adds authentication to a route within the app. | [Source](../lib/core/services/auth-guard.service.ts) | +| [Authentication Service](core/services/authentication.service.md) | Provides authentication to ACS and APS. | [Source](../lib/core/services/authentication.service.ts) | +| [Bpm User service](core/services/bpm-user.service.md) | Gets information about the current Process Services user. | [Source](../lib/core/services/bpm-user.service.ts) | +| [Card Item Type service](core/services/card-item-types.service.md) | Maps type names to field component types for the Card View component. | [Source](../lib/core/card-view/services/card-item-types.service.ts) | +| [Card View Update service](core/services/card-view-update.service.md) | Reports edits and clicks within fields of a Card View component. | [Source](../lib/core/card-view/services/card-view-update.service.ts) | +| [Clipboard service](core/services/clipboard.service.md) | Copies text to the clipboard. | [Source](../lib/core/clipboard/clipboard.service.ts) | +| [Comment Content service](core/services/comment-content.service.md) | Adds and retrieves comments for nodes in Content Services. | [Source](../lib/core/services/comment-content.service.ts) | +| [Comment Process service](core/services/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](core/services/content.service.md) | Accesses app-generated data objects via URLs and file downloads. | [Source](../lib/core/services/content.service.ts) | +| [Cookie service](core/services/cookie.service.md) | Stores key-value data items as browser cookies. | [Source](../lib/core/services/cookie.service.ts) | +| [Deleted Nodes Api service](core/services/deleted-nodes-api.service.md) | Gets a list of Content Services nodes currently in the trash. | [Source](../lib/core/services/deleted-nodes-api.service.ts) | +| [Discovery Api service](core/services/discovery-api.service.md) | Gets version and license information for Process Services and Content Services. | [Source](../lib/core/services/discovery-api.service.ts) | +| [Download zip service](core/services/download-zip.service.md) | Creates and manages downloads. | [Source](../lib/core/services/download-zip.service.ts) | +| [Ecm User service](core/services/ecm-user.service.md) | Gets information about a Content Services user. | [Source](../lib/core/services/ecm-user.service.ts) | +| [Favorites Api service](core/services/favorites-api.service.md) | Gets a list of items a user has marked as their favorites. | [Source](../lib/core/services/favorites-api.service.ts) | +| [Form Rendering service](core/services/form-rendering.service.md) | Maps a form field type string onto the corresponding form widget component type. | [Source](../lib/core/form/services/form-rendering.service.ts) | +| [Form service](core/services/form.service.md) | Implements Process Services form methods | [Source](../lib/core/form/services/form.service.ts) | +| [Highlight Transform service](core/services/highlight-transform.service.md) | Adds HTML to a string to highlight chosen sections. | [Source](../lib/core/services/highlight-transform.service.ts) | +| [Identity Group service](core/services/identity-group.service.md) | Performs CRUD operations on identity groups. | [Source](../lib/core/services/identity-group.service.ts) | +| [Identity role service](core/services/identity-role.service.md) | Provides APIs for working with the Roles in Identity Services. | [Source](../lib/core/services/identity-role.service.ts) | +| [Identity user service](core/services/identity-user.service.md) | Gets OAuth2 personal details and roles for users and performs CRUD operations on identity users. | [Source](../lib/core/services/identity-user.service.ts) | +| [JWT helper service](core/services/jwt-helper.service.md) | Decodes a JSON Web Token (JWT) to a JavaScript object. | [Source](../lib/core/services/jwt-helper.service.ts) | +| [Log Service](core/services/log.service.md) | Provides log functionality. | [Source](../lib/core/services/log.service.ts) | +| [Login Dialog service](core/services/login-dialog.service.md) | Manages login dialogs. | [Source](../lib/core/services/login-dialog.service.ts) | +| [Node Service](core/services/node.service.md) | use Nodes Api service instead of this. | [Source](../lib/core/form/services/node.service.ts) | +| [Nodes Api service](core/services/nodes-api.service.md) | Accesses and manipulates ACS document nodes using their node IDs. | [Source](../lib/core/services/nodes-api.service.ts) | +| [Notification Service](core/services/notification.service.md) | Shows a notification message with optional feedback. | [Source](../lib/core/notifications/services/notification.service.ts) | +| [Page Title service](core/services/page-title.service.md) | Sets the page title. | [Source](../lib/core/services/page-title.service.ts) | +| [People Content service](core/services/people-content.service.md) | Gets information about a Content Services user. | [Source](../lib/core/services/people-content.service.ts) | +| [People Process service](core/services/people-process.service.md) | Gets information about Process Services users. | [Source](../lib/core/services/people-process.service.ts) | +| [Process Content Service](core/services/process-content.service.md) | Manipulates content related to a Process Instance or Task Instance in APS. | [Source](../lib/core/form/services/process-content.service.ts) | +| [Renditions service](core/services/renditions.service.md) | Manages prearranged conversions of content to different formats. | [Source](../lib/core/services/renditions.service.ts) | +| [Search Configuration service](core/services/search-configuration.service.md) | Provides fine control of parameters to a search. | [Source](../lib/core/services/search-configuration.service.ts) | +| [Search service](core/services/search.service.md) | Accesses the Content Services Search API. | [Source](../lib/core/services/search.service.ts) | +| [Shared Links Api service](core/services/shared-links-api.service.md) | Finds shared links to Content Services items. | [Source](../lib/core/services/shared-links-api.service.ts) | +| [Sites service](core/services/sites.service.md) | Accesses and manipulates sites from a Content Services repository. | [Source](../lib/core/services/sites.service.ts) | +| [Storage service](core/services/storage.service.md) | Stores items in the form of key-value pairs. | [Source](../lib/core/services/storage.service.ts) | +| [Thumbnail service](core/services/thumbnail.service.md) | Retrieves an SVG thumbnail image to represent a document type. | [Source](../lib/core/services/thumbnail.service.ts) | +| [Translation service](core/services/translation.service.md) | Supports localisation. | [Source](../lib/core/services/translation.service.ts) | +| [Upload Service](core/services/upload.service.md) | Provides access to various APIs related to file upload features. | [Source](../lib/core/services/upload.service.ts) | +| [User Preferences Service](core/services/user-preferences.service.md) | Stores preferences for the app and for individual components. | [Source](../lib/core/services/user-preferences.service.ts) | ### Widgets -| Name | Description | Source link | -| ---- | ----------- | ----------- | +| Name | Description | Source link | +| ------------------------------------------------------- | -------------------------- | ----------------------------------------------------------------------- | | [APS Content Component](core/widgets/content.widget.md) | Shows the content preview. | [Source](../lib/core/form/components/widgets/content/content.widget.ts) | @@ -255,101 +255,101 @@ for more information about installing and using the source code. ### Components -| Name | Description | Source link | -| ---- | ----------- | ----------- | -| [Add Permission Dialog Component](content-services/components/add-permission-dialog.component.md) | Displays a dialog to search for people or groups to add to the current node permissions. | [Source](../lib/content-services/src/lib/permission-manager/components/add-permission/add-permission-dialog.component.ts) | -| [Add Permission Panel Component](content-services/components/add-permission-panel.component.md) | Searches for people or groups to add to the current node permissions. | [Source](../lib/content-services/src/lib/permission-manager/components/add-permission/add-permission-panel.component.ts) | -| [Add Permission Component](content-services/components/add-permission.component.md) | Searches for people or groups to add to the current node permissions. | [Source](../lib/content-services/src/lib/permission-manager/components/add-permission/add-permission.component.ts) | -| [Breadcrumb Component](content-services/components/breadcrumb.component.md) | Indicates the current position within a navigation hierarchy. | [Source](../lib/content-services/src/lib/breadcrumb/breadcrumb.component.ts) | -| [Content Action component](content-services/components/content-action.component.md) | Adds options to a Document List actions menu for a particular content type. | [Source](../lib/content-services/src/lib/document-list/components/content-action/content-action.component.ts) | -| [Content Metadata Card component](content-services/components/content-metadata-card.component.md) | Displays and edits metadata related to a node. | [Source](../lib/content-services/src/lib/content-metadata/components/content-metadata-card/content-metadata-card.component.ts) | -| [Content Node Selector Panel component](content-services/components/content-node-selector-panel.component.md) | Opens a Content Node Selector in its own dialog window. | [Source](../lib/content-services/src/lib/content-node-selector/content-node-selector-panel.component.ts) | -| [Content Node Selector component](content-services/components/content-node-selector.component.md) | Allows a user to select items from a Content Services repository. | [Source](../lib/content-services/src/lib/content-node-selector/content-node-selector.component.ts) | -| [Document List component](content-services/components/document-list.component.md) | Displays the documents from a repository. | [Source](../lib/content-services/src/lib/document-list/components/document-list.component.ts) | -| [Dropdown Breadcrumb Component](content-services/components/dropdown-breadcrumb.component.md) | Indicates the current position within a navigation hierarchy using a dropdown menu. | [Source](../lib/content-services/src/lib/breadcrumb/dropdown-breadcrumb.component.ts) | -| [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/src/lib/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/src/lib/social/like.component.ts) | -| [Permission List Component](content-services/components/permission-list.component.md) | Shows node permissions as a table. | [Source](../lib/content-services/src/lib/permission-manager/components/permission-list/permission-list.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/src/lib/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/src/lib/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/src/lib/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/src/lib/search/components/search-control.component.ts) | -| [Search date range component](content-services/components/search-date-range.component.md) | Implements a date range widget for the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-date-range/search-date-range.component.ts) | -| [Search Filter component](content-services/components/search-filter.component.md) | Represents a main container component for custom search and faceted search settings. | [Source](../lib/content-services/src/lib/search/components/search-filter/search-filter.component.ts) | -| [SearchHeader component](content-services/components/search-header.component.md) | Displays a button opening a menu designed to filter a document list. | [Source](../lib/content-services/src/lib/search/components/search-header/search-header.component.ts) | -| [Search number range component](content-services/components/search-number-range.component.md) | Implements a number range widget for the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-number-range/search-number-range.component.ts) | -| [Search radio component](content-services/components/search-radio.component.md) | Implements a radio button list widget for the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-radio/search-radio.component.ts) | -| [Search slider component](content-services/components/search-slider.component.md) | Implements a numeric slider widget for the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-slider/search-slider.component.ts) | -| [Search Sorting Picker Component](content-services/components/search-sorting-picker.component.md) | Provides an ability to select one of the predefined sorting definitions for search results: | [Source](../lib/content-services/src/lib/search/components/search-sorting-picker/search-sorting-picker.component.ts) | -| [Search text component](content-services/components/search-text.component.md) | Implements a text input widget for the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-text/search-text.component.ts) | -| [Search component](content-services/components/search.component.md) | Searches items for supplied search terms. | [Source](../lib/content-services/src/lib/search/components/search.component.ts) | -| [Sites Dropdown component](content-services/components/sites-dropdown.component.md) | Displays a dropdown menu to show and interact with the sites of the current user. | [Source](../lib/content-services/src/lib/site-dropdown/sites-dropdown.component.ts) | -| [Tag Node Actions List component](content-services/components/tag-actions.component.md) | Shows available actions for tags. | [Source](../lib/content-services/src/lib/tag/tag-actions.component.ts) | -| [Tag List component](content-services/components/tag-list.component.md) | Shows tags for an item. | [Source](../lib/content-services/src/lib/tag/tag-list.component.ts) | -| [Tag Node List component](content-services/components/tag-node-list.component.md) | Shows tags for a node. | [Source](../lib/content-services/src/lib/tag/tag-node-list.component.ts) | -| [Tree View component](content-services/components/tree-view.component.md) | Shows the folder and subfolders of a node as a tree view. | [Source](../lib/content-services/src/lib/tree-view/components/tree-view.component.ts) | -| [Upload Button Component](content-services/components/upload-button.component.md) | Activates a file upload. | [Source](../lib/content-services/src/lib/upload/components/upload-button.component.ts) | -| [Upload Drag Area Component](content-services/components/upload-drag-area.component.md) | Adds a drag and drop area to upload files to ACS. | [Source](../lib/content-services/src/lib/upload/components/upload-drag-area.component.ts) | -| [Upload Version Button Component (Workaround)](content-services/components/upload-version-button.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Activates a file version upload. | [Source](../lib/content-services/src/lib/upload/components/upload-version-button.component.ts) | -| [Version Comparison Component](content-services/components/version-comparison.component.md) | Displays the side by side comparison between the current target node (type, name, icon) and the new file that should update it's version. | [Source](../lib/content-services/src/lib/version-manager/version-comparison.component.ts) | -| [Version List component](content-services/components/version-list.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays the version history of a node in a Version Manager component. | [Source](../lib/content-services/src/lib/version-manager/version-list.component.ts) | -| [Version Manager Component](content-services/components/version-manager.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays the version history of a node with the ability to upload a new version. | [Source](../lib/content-services/src/lib/version-manager/version-manager.component.ts) | -| [Webscript component](content-services/components/webscript.component.md) | Provides access to Webscript features. | [Source](../lib/content-services/src/lib/webscript/webscript.component.ts) | +| Name | Description | Source link | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | +| [Add Permission Dialog Component](content-services/components/add-permission-dialog.component.md) | Displays a dialog to search for people or groups to add to the current node permissions. | [Source](../lib/content-services/src/lib/permission-manager/components/add-permission/add-permission-dialog.component.ts) | +| [Add Permission Panel Component](content-services/components/add-permission-panel.component.md) | Searches for people or groups to add to the current node permissions. | [Source](../lib/content-services/src/lib/permission-manager/components/add-permission/add-permission-panel.component.ts) | +| [Add Permission Component](content-services/components/add-permission.component.md) | Searches for people or groups to add to the current node permissions. | [Source](../lib/content-services/src/lib/permission-manager/components/add-permission/add-permission.component.ts) | +| [Breadcrumb Component](content-services/components/breadcrumb.component.md) | Indicates the current position within a navigation hierarchy. | [Source](../lib/content-services/src/lib/breadcrumb/breadcrumb.component.ts) | +| [Content Action component](content-services/components/content-action.component.md) | Adds options to a Document List actions menu for a particular content type. | [Source](../lib/content-services/src/lib/document-list/components/content-action/content-action.component.ts) | +| [Content Metadata Card component](content-services/components/content-metadata-card.component.md) | Displays and edits metadata related to a node. | [Source](../lib/content-services/src/lib/content-metadata/components/content-metadata-card/content-metadata-card.component.ts) | +| [Content Node Selector Panel component](content-services/components/content-node-selector-panel.component.md) | Opens a Content Node Selector in its own dialog window. | [Source](../lib/content-services/src/lib/content-node-selector/content-node-selector-panel.component.ts) | +| [Content Node Selector component](content-services/components/content-node-selector.component.md) | Allows a user to select items from a Content Services repository. | [Source](../lib/content-services/src/lib/content-node-selector/content-node-selector.component.ts) | +| [Document List component](content-services/components/document-list.component.md) | Displays the documents from a repository. | [Source](../lib/content-services/src/lib/document-list/components/document-list.component.ts) | +| [Dropdown Breadcrumb Component](content-services/components/dropdown-breadcrumb.component.md) | Indicates the current position within a navigation hierarchy using a dropdown menu. | [Source](../lib/content-services/src/lib/breadcrumb/dropdown-breadcrumb.component.ts) | +| [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/src/lib/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/src/lib/social/like.component.ts) | +| [Permission List Component](content-services/components/permission-list.component.md) | Shows node permissions as a table. | [Source](../lib/content-services/src/lib/permission-manager/components/permission-list/permission-list.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/src/lib/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/src/lib/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/src/lib/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/src/lib/search/components/search-control.component.ts) | +| [Search date range component](content-services/components/search-date-range.component.md) | Implements a date range widget for the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-date-range/search-date-range.component.ts) | +| [Search Filter component](content-services/components/search-filter.component.md) | Represents a main container component for custom search and faceted search settings. | [Source](../lib/content-services/src/lib/search/components/search-filter/search-filter.component.ts) | +| [Search number range component](content-services/components/search-number-range.component.md) | Implements a number range widget for the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-number-range/search-number-range.component.ts) | +| [Search radio component](content-services/components/search-radio.component.md) | Implements a radio button list widget for the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-radio/search-radio.component.ts) | +| [Search slider component](content-services/components/search-slider.component.md) | Implements a numeric slider widget for the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-slider/search-slider.component.ts) | +| [Search Sorting Picker Component](content-services/components/search-sorting-picker.component.md) | Provides an ability to select one of the predefined sorting definitions for search results: | [Source](../lib/content-services/src/lib/search/components/search-sorting-picker/search-sorting-picker.component.ts) | +| [Search text component](content-services/components/search-text.component.md) | Implements a text input widget for the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-text/search-text.component.ts) | +| [Search component](content-services/components/search.component.md) | Searches items for supplied search terms. | [Source](../lib/content-services/src/lib/search/components/search.component.ts) | +| [Sites Dropdown component](content-services/components/sites-dropdown.component.md) | Displays a dropdown menu to show and interact with the sites of the current user. | [Source](../lib/content-services/src/lib/site-dropdown/sites-dropdown.component.ts) | +| [Tag Node Actions List component](content-services/components/tag-actions.component.md) | Shows available actions for tags. | [Source](../lib/content-services/src/lib/tag/tag-actions.component.ts) | +| [Tag List component](content-services/components/tag-list.component.md) | Shows tags for an item. | [Source](../lib/content-services/src/lib/tag/tag-list.component.ts) | +| [Tag Node List component](content-services/components/tag-node-list.component.md) | Shows tags for a node. | [Source](../lib/content-services/src/lib/tag/tag-node-list.component.ts) | +| [Tree View component](content-services/components/tree-view.component.md) | Shows the folder and subfolders of a node as a tree view. | [Source](../lib/content-services/src/lib/tree-view/components/tree-view.component.ts) | +| [Upload Button Component](content-services/components/upload-button.component.md) | Activates a file upload. | [Source](../lib/content-services/src/lib/upload/components/upload-button.component.ts) | +| [Upload Drag Area Component](content-services/components/upload-drag-area.component.md) | Adds a drag and drop area to upload files to ACS. | [Source](../lib/content-services/src/lib/upload/components/upload-drag-area.component.ts) | +| [Upload Version Button Component (Workaround)](content-services/components/upload-version-button.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Activates a file version upload. | [Source](../lib/content-services/src/lib/upload/components/upload-version-button.component.ts) | +| [Version Comparison Component](content-services/components/version-comparison.component.md) | Displays the side by side comparison between the current target node (type, name, icon) and the new file that should update it's version. | [Source](../lib/content-services/src/lib/version-manager/version-comparison.component.ts) | +| [Version List component](content-services/components/version-list.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays the version history of a node in a Version Manager component. | [Source](../lib/content-services/src/lib/version-manager/version-list.component.ts) | +| [Version Manager Component](content-services/components/version-manager.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays the version history of a node with the ability to upload a new version. | [Source](../lib/content-services/src/lib/version-manager/version-manager.component.ts) | +| [Webscript component](content-services/components/webscript.component.md) | Provides access to Webscript features. | [Source](../lib/content-services/src/lib/webscript/webscript.component.ts) | ### Directives -| Name | Description | Source link | -| ---- | ----------- | ----------- | -| [Node Public File Share Directive](content-services/directives/content-node-share.directive.md) | Creates and manages public shared links for files. | [Source](../lib/content-services/src/lib/content-node-share/content-node-share.directive.ts) | -| [File Draggable directive](content-services/directives/file-draggable.directive.md) | Provides drag-and-drop features for an element such as a div. | [Source](../lib/content-services/src/lib/upload/directives/file-draggable.directive.ts) | -| [Folder Create directive](content-services/directives/folder-create.directive.md) | Creates folders. | [Source](../lib/content-services/src/lib/folder-directive/folder-create.directive.ts) | -| [Folder Edit directive](content-services/directives/folder-edit.directive.md) | Allows folders to be edited. | [Source](../lib/content-services/src/lib/folder-directive/folder-edit.directive.ts) | -| [Inherit Permission directive](content-services/directives/inherited-button.directive.md) | Update the current node by adding/removing the inherited permissions. | [Source](../lib/content-services/src/lib/permission-manager/components/inherited-button.directive.ts) | -| [Node Lock directive](content-services/directives/node-lock.directive.md) | Locks or unlocks a node. | [Source](../lib/content-services/src/lib/directives/node-lock.directive.ts) | -| [Toggle Icon directive](content-services/directives/toggle-icon.directive.md) | Toggle icon on mouse or keyboard event for a selectable element. | [Source](../lib/content-services/src/lib/upload/directives/toggle-icon.directive.ts) | +| Name | Description | Source link | +| ----------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | +| [Node Public File Share Directive](content-services/directives/content-node-share.directive.md) | Creates and manages public shared links for files. | [Source](../lib/content-services/src/lib/content-node-share/content-node-share.directive.ts) | +| [File Draggable directive](content-services/directives/file-draggable.directive.md) | Provides drag-and-drop features for an element such as a div. | [Source](../lib/content-services/src/lib/upload/directives/file-draggable.directive.ts) | +| [Folder Create directive](content-services/directives/folder-create.directive.md) | Creates folders. | [Source](../lib/content-services/src/lib/folder-directive/folder-create.directive.ts) | +| [Folder Edit directive](content-services/directives/folder-edit.directive.md) | Allows folders to be edited. | [Source](../lib/content-services/src/lib/folder-directive/folder-edit.directive.ts) | +| [Inherit Permission directive](content-services/directives/inherited-button.directive.md) | Update the current node by adding/removing the inherited permissions. | [Source](../lib/content-services/src/lib/permission-manager/components/inherited-button.directive.ts) | +| [Node Lock directive](content-services/directives/node-lock.directive.md) | Locks or unlocks a node. | [Source](../lib/content-services/src/lib/directives/node-lock.directive.ts) | +| [Toggle Icon directive](content-services/directives/toggle-icon.directive.md) | Toggle icon on mouse or keyboard event for a selectable element. | [Source](../lib/content-services/src/lib/upload/directives/toggle-icon.directive.ts) | ### Dialogs -| Name | Description | Source link | -| ---- | ----------- | ----------- | -| [Confirm dialog component](content-services/dialogs/confirm.dialog.md) | Requests a yes/no choice from the user. | [Source](../lib/content-services/src/lib/dialogs/confirm.dialog.ts) | +| Name | Description | Source link | +| ---------------------------------------------------------------------- | ----------------------------------------------------- | --------------------------------------------------------------------------- | +| [Confirm dialog component](content-services/dialogs/confirm.dialog.md) | Requests a yes/no choice from the user. | [Source](../lib/content-services/src/lib/dialogs/confirm.dialog.ts) | | [Library dialog component](content-services/dialogs/library.dialog.md) | Creates a new Content Services document library/site. | [Source](../lib/content-services/src/lib/dialogs/library/library.dialog.ts) | ### Interfaces -| Name | Description | Source link | -| ---- | ----------- | ----------- | +| Name | Description | Source link | +| --------------------------------------------------------------------------------- | ------------------------------------------------------------------ | --------------------------------------------------------------------------- | | [Search widget interface](content-services/interfaces/search-widget.interface.md) | Specifies required properties for Search filter component widgets. | [Source](../lib/content-services/src/lib/search/search-widget.interface.ts) | ### Models -| Name | Description | Source link | -| ---- | ----------- | ----------- | -| [Image Resolver Model](content-services/models/image-resolver.model.md) | Defines the Image Resolver function used by the Document List Component. | [Source](../lib/content-services/document-list/data/image-resolver.model.ts) | +| Name | Description | Source link | +| ---------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | +| [Image Resolver Model](content-services/models/image-resolver.model.md) | Defines the Image Resolver function used by the Document List Component. | [Source](../lib/content-services/document-list/data/image-resolver.model.ts) | | [Permission Style model](content-services/models/permissions-style.model.md) | Sets custom CSS styles for rows of a Document List according to the item's permissions. | [Source](../lib/content-services/src/lib/document-list/models/permissions-style.model.ts) | -| [Row Filter Model](content-services/models/row-filter.model.md) | Defines the Row Filter function used by the Document List Component. | [Source](../lib/content-services/document-list/data/row-filter.model.ts) | +| [Row Filter Model](content-services/models/row-filter.model.md) | Defines the Row Filter function used by the Document List Component. | [Source](../lib/content-services/document-list/data/row-filter.model.ts) | ### Pipes -| Name | Description | Source link | -| ---- | ----------- | ----------- | +| Name | Description | Source link | +| -------------------------------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------------------------------------- | | [File upload error pipe](content-services/pipes/file-upload-error.pipe.md) | Converts an upload error code to an error message. | [Source](../lib/content-services/src/lib/upload/pipes/file-upload-error.pipe.ts) | ### Services -| Name | Description | Source link | -| ---- | ----------- | ----------- | -| [Content Node Dialog service](content-services/services/content-node-dialog.service.md) | Displays and manages dialogs for selecting content to open, copy or upload. | [Source](../lib/content-services/src/lib/content-node-selector/content-node-dialog.service.ts) | -| [Custom Resources service](content-services/services/custom-resources.service.md) | Manages Document List information that is specific to a user. | [Source](../lib/content-services/src/lib/document-list/services/custom-resources.service.ts) | -| [Document Actions service](content-services/services/document-actions.service.md) | Implements the document menu actions for the Document List component. | [Source](../lib/content-services/src/lib/document-list/services/document-actions.service.ts) | -| [Document List service](content-services/services/document-list.service.md) | Implements node operations used by the Document List component. | [Source](../lib/content-services/src/lib/document-list/services/document-list.service.ts) | -| [Folder Actions service](content-services/services/folder-actions.service.md) | Implements the folder menu actions for the Document List component. | [Source](../lib/content-services/src/lib/document-list/services/folder-actions.service.ts) | -| [Node permission dialog service](content-services/services/node-permission-dialog.service.md) | Displays dialogs to let the user set node permissions. | [Source](../lib/content-services/src/lib/permission-manager/services/node-permission-dialog.service.ts) | -| [Node Permission service](content-services/services/node-permission.service.md) | Manages role permissions for content nodes. | [Source](../lib/content-services/src/lib/permission-manager/services/node-permission.service.ts) | -| [Rating service](content-services/services/rating.service.md) | Manages ratings for items in Content Services. | [Source](../lib/content-services/src/lib/social/services/rating.service.ts) | -| [Search filter service](content-services/services/search-filter.service.md) | Registers widgets for use with the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-filter/search-filter.service.ts) | -| [Search Query Builder service](content-services/services/search-query-builder.service.md) | Stores information from all the custom search and faceted search widgets, compiles and runs the final search query. | [Source](../lib/content-services/src/lib/search/search-query-builder.service.ts) | -| [Tag service](content-services/services/tag.service.md) | Manages tags in Content Services. | [Source](../lib/content-services/src/lib/tag/services/tag.service.ts) | +| Name | Description | Source link | +| --------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | +| [Audit Service](content-services/services/audit.service.md) | Manages Audit apps and entries. | [Source](../lib/content-services/src/lib/audit/audit.service.ts) | +| [Content Node Dialog service](content-services/services/content-node-dialog.service.md) | Displays and manages dialogs for selecting content to open, copy or upload. | [Source](../lib/content-services/src/lib/content-node-selector/content-node-dialog.service.ts) | +| [Custom Resources service](content-services/services/custom-resources.service.md) | Manages Document List information that is specific to a user. | [Source](../lib/content-services/src/lib/document-list/services/custom-resources.service.ts) | +| [Document Actions service](content-services/services/document-actions.service.md) | Implements the document menu actions for the Document List component. | [Source](../lib/content-services/src/lib/document-list/services/document-actions.service.ts) | +| [Document List service](content-services/services/document-list.service.md) | Implements node operations used by the Document List component. | [Source](../lib/content-services/src/lib/document-list/services/document-list.service.ts) | +| [Folder Actions service](content-services/services/folder-actions.service.md) | Implements the folder menu actions for the Document List component. | [Source](../lib/content-services/src/lib/document-list/services/folder-actions.service.ts) | +| [Node permission dialog service](content-services/services/node-permission-dialog.service.md) | Displays dialogs to let the user set node permissions. | [Source](../lib/content-services/src/lib/permission-manager/services/node-permission-dialog.service.ts) | +| [Node Permission service](content-services/services/node-permission.service.md) | Manages role permissions for content nodes. | [Source](../lib/content-services/src/lib/permission-manager/services/node-permission.service.ts) | +| [Rating service](content-services/services/rating.service.md) | Manages ratings for items in Content Services. | [Source](../lib/content-services/src/lib/social/services/rating.service.ts) | +| [Search filter service](content-services/services/search-filter.service.md) | Registers widgets for use with the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-filter/search-filter.service.ts) | +| [Search Query Builder service](content-services/services/search-query-builder.service.md) | Stores information from all the custom search and faceted search widgets, compiles and runs the final search query. | [Source](../lib/content-services/src/lib/search/search-query-builder.service.ts) | +| [Tag service](content-services/services/tag.service.md) | Manages tags in Content Services. | [Source](../lib/content-services/src/lib/tag/services/tag.service.ts) | @@ -366,59 +366,59 @@ for more information about installing and using the source code. ### Components -| Name | Description | Source link | -| ---- | ----------- | ----------- | -| [Apps List Component](process-services/components/apps-list.component.md) | Shows all available apps. | [Source](../lib/process-services/src/lib/app-list/apps-list.component.ts) | -| [Attach Form component](process-services/components/attach-form.component.md) | This component can be used when there is no form attached to a task and you want to add one. | [Source](../lib/process-services/src/lib/task-list/components/attach-form.component.ts) | -| [Checklist Component](process-services/components/checklist.component.md) | Shows the checklist task functionality. | [Source](../lib/process-services/src/lib/task-list/components/checklist.component.ts) | -| [Create Process Attachment component](process-services/components/create-process-attachment.component.md) | Displays an Upload Component (Drag and Click) to upload the attachment to a specified process instance. | [Source](../lib/process-services/src/lib/attachment/create-process-attachment.component.ts) | -| [Create Task Attachment Component](process-services/components/create-task-attachment.component.md) | Displays an Upload Component (Drag and Click) to upload the attachment to a specified task. | [Source](../lib/process-services/src/lib/attachment/create-task-attachment.component.ts) | -| [Form custom outcomes component](process-services/components/form-custom-outcome.component.md) | Supplies custom outcome buttons to be included in Form component. | [Source](../lib/process-services/src/lib/form/form-custom-outcomes.component.ts) | -| [Form component](process-services/components/form.component.md) | Shows a Form from APS | [Source](../lib/process-services/src/lib/form/form.component.ts) | -| [People list component](process-services/components/people-list.component.md) | Shows a list of users (people). | [Source](../lib/process-services/src/lib/people/components/people-list/people-list.component.ts) | -| [People Search component](process-services/components/people-search.component.md) | Searches users/people. | [Source](../lib/process-services/src/lib/people/components/people-search/people-search.component.ts) | -| [People Component](process-services/components/people.component.md) | Displays users involved with a specified task | [Source](../lib/process-services/src/lib/people/components/people/people.component.ts) | -| [Process Attachment List component](process-services/components/process-attachment-list.component.md) | Displays documents attached to a specified process instance. | [Source](../lib/process-services/src/lib/attachment/process-attachment-list.component.ts) | -| [Process Instance Comments component](process-services/components/process-comments.component.md) | Displays comments associated with a particular process instance and allows the user to add new comments. | [Source](../lib/process-services/src/lib/process-comments/process-comments.component.ts) | -| [Process Filters Component](process-services/components/process-filters.component.md) | Collection of criteria used to filter process instances, which may be customized by users. | [Source](../lib/process-services/src/lib/process-list/components/process-filters.component.ts) | -| [Process Details component](process-services/components/process-instance-details.component.md) | Displays detailed information about a specified process instance | [Source](../lib/process-services/src/lib/process-list/components/process-instance-details.component.ts) | -| [Process Instance Details Header component](process-services/components/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/src/lib/process-list/components/process-instance-header.component.ts) | -| [Process Instance Tasks component](process-services/components/process-instance-tasks.component.md) | Lists both the active and completed tasks associated with a particular process instance | [Source](../lib/process-services/src/lib/process-list/components/process-instance-tasks.component.ts) | -| [Process Instance List](process-services/components/process-list.component.md) | Renders a list containing all the process instances matched by the parameters specified. | [Source](../lib/process-services/src/lib/process-list/components/process-list.component.ts) | -| [Select App Component](process-services/components/select-apps-dialog.component.md) | Shows all available apps and returns the selected app. | [Source](../lib/process-services/src/lib/app-list/select-apps-dialog.component.ts) | -| [Start Process component](process-services/components/start-process.component.md) | Starts a process. | [Source](../lib/process-services/src/lib/process-list/components/start-process.component.ts) | -| [Start Task Component](process-services/components/start-task.component.md) | Creates/Starts a new task for the specified app. | [Source](../lib/process-services/src/lib/task-list/components/start-task.component.ts) | -| [Task Attachment List Component](process-services/components/task-attachment-list.component.md) | Displays documents attached to a specified task. | [Source](../lib/process-services/src/lib/attachment/task-attachment-list.component.ts) | -| [Task Details component](process-services/components/task-details.component.md) | Shows the details of the task ID passed in as input. | [Source](../lib/process-services/src/lib/task-list/components/task-details.component.ts) | -| [Task Filters component](process-services/components/task-filters.component.md) | Shows all available filters. | [Source](../lib/process-services/src/lib/task-list/components/task-filters.component.ts) | -| [Task Form component](process-services/components/task-form.component.md) | Shows a form for a task. | [Source](../lib/process-services/src/lib/task-list/components/task-form/task-form.component.ts) | -| [Task Header component](process-services/components/task-header.component.md) | Shows all the information related to a task. | [Source](../lib/process-services/src/lib/task-list/components/task-header.component.ts) | -| [Task List component](process-services/components/task-list.component.md) | Renders a list containing all the tasks matched by the parameters specified. | [Source](../lib/process-services/src/lib/task-list/components/task-list.component.ts) | -| [Task Standalone component](process-services/components/task-standalone.component.md) | This component can be used when the task doesn't belong to any processes. | [Source](../lib/process-services/src/lib/task-list/components/task-standalone.component.ts) | +| Name | Description | Source link | +| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------- | +| [Apps List Component](process-services/components/apps-list.component.md) | Shows all available apps. | [Source](../lib/process-services/src/lib/app-list/apps-list.component.ts) | +| [Attach Form component](process-services/components/attach-form.component.md) | This component can be used when there is no form attached to a task and you want to add one. | [Source](../lib/process-services/src/lib/task-list/components/attach-form.component.ts) | +| [Checklist Component](process-services/components/checklist.component.md) | Shows the checklist task functionality. | [Source](../lib/process-services/src/lib/task-list/components/checklist.component.ts) | +| [Create Process Attachment component](process-services/components/create-process-attachment.component.md) | Displays an Upload Component (Drag and Click) to upload the attachment to a specified process instance. | [Source](../lib/process-services/src/lib/attachment/create-process-attachment.component.ts) | +| [Create Task Attachment Component](process-services/components/create-task-attachment.component.md) | Displays an Upload Component (Drag and Click) to upload the attachment to a specified task. | [Source](../lib/process-services/src/lib/attachment/create-task-attachment.component.ts) | +| [Form custom outcomes component](process-services/components/form-custom-outcome.component.md) | Supplies custom outcome buttons to be included in Form component. | [Source](../lib/process-services/src/lib/form/form-custom-outcomes.component.ts) | +| [Form component](process-services/components/form.component.md) | Shows a Form from APS | [Source](../lib/process-services/src/lib/form/form.component.ts) | +| [People list component](process-services/components/people-list.component.md) | Shows a list of users (people). | [Source](../lib/process-services/src/lib/people/components/people-list/people-list.component.ts) | +| [People Search component](process-services/components/people-search.component.md) | Searches users/people. | [Source](../lib/process-services/src/lib/people/components/people-search/people-search.component.ts) | +| [People Component](process-services/components/people.component.md) | Displays users involved with a specified task | [Source](../lib/process-services/src/lib/people/components/people/people.component.ts) | +| [Process Attachment List component](process-services/components/process-attachment-list.component.md) | Displays documents attached to a specified process instance. | [Source](../lib/process-services/src/lib/attachment/process-attachment-list.component.ts) | +| [Process Instance Comments component](process-services/components/process-comments.component.md) | Displays comments associated with a particular process instance and allows the user to add new comments. | [Source](../lib/process-services/src/lib/process-comments/process-comments.component.ts) | +| [Process Filters Component](process-services/components/process-filters.component.md) | Collection of criteria used to filter process instances, which may be customized by users. | [Source](../lib/process-services/src/lib/process-list/components/process-filters.component.ts) | +| [Process Details component](process-services/components/process-instance-details.component.md) | Displays detailed information about a specified process instance | [Source](../lib/process-services/src/lib/process-list/components/process-instance-details.component.ts) | +| [Process Instance Details Header component](process-services/components/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/src/lib/process-list/components/process-instance-header.component.ts) | +| [Process Instance Tasks component](process-services/components/process-instance-tasks.component.md) | Lists both the active and completed tasks associated with a particular process instance | [Source](../lib/process-services/src/lib/process-list/components/process-instance-tasks.component.ts) | +| [Process Instance List](process-services/components/process-list.component.md) | Renders a list containing all the process instances matched by the parameters specified. | [Source](../lib/process-services/src/lib/process-list/components/process-list.component.ts) | +| [Select App Component](process-services/components/select-apps-dialog.component.md) | Shows all available apps and returns the selected app. | [Source](../lib/process-services/src/lib/app-list/select-apps-dialog.component.ts) | +| [Start Process component](process-services/components/start-process.component.md) | Starts a process. | [Source](../lib/process-services/src/lib/process-list/components/start-process.component.ts) | +| [Start Task Component](process-services/components/start-task.component.md) | Creates/Starts a new task for the specified app. | [Source](../lib/process-services/src/lib/task-list/components/start-task.component.ts) | +| [Task Attachment List Component](process-services/components/task-attachment-list.component.md) | Displays documents attached to a specified task. | [Source](../lib/process-services/src/lib/attachment/task-attachment-list.component.ts) | +| [Task Details component](process-services/components/task-details.component.md) | Shows the details of the task ID passed in as input. | [Source](../lib/process-services/src/lib/task-list/components/task-details.component.ts) | +| [Task Filters component](process-services/components/task-filters.component.md) | Shows all available filters. | [Source](../lib/process-services/src/lib/task-list/components/task-filters.component.ts) | +| [Task Form component](process-services/components/task-form.component.md) | Shows a form for a task. | [Source](../lib/process-services/src/lib/task-list/components/task-form/task-form.component.ts) | +| [Task Header component](process-services/components/task-header.component.md) | Shows all the information related to a task. | [Source](../lib/process-services/src/lib/task-list/components/task-header.component.ts) | +| [Task List component](process-services/components/task-list.component.md) | Renders a list containing all the tasks matched by the parameters specified. | [Source](../lib/process-services/src/lib/task-list/components/task-list.component.ts) | +| [Task Standalone component](process-services/components/task-standalone.component.md) | This component can be used when the task doesn't belong to any processes. | [Source](../lib/process-services/src/lib/task-list/components/task-standalone.component.ts) | ### Directives -| Name | Description | Source link | -| ---- | ----------- | ----------- | -| [Claim Task Directive](process-services/directives/claim-task.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Claims a task | [Source](../lib/process-services/src/lib/task-list/components/task-form/claim-task.directive.ts) | -| [Process Audit Directive](process-services/directives/process-audit.directive.md) | Fetches the Process Audit information in PDF or JSON format. | [Source](../lib/process-services/src/lib/process-list/components/process-audit.directive.ts) | -| [Task Audit Directive](process-services/directives/task-audit.directive.md) | Fetches the Task Audit information in PDF or JSON format. | [Source](../lib/process-services/src/lib/task-list/components/task-audit.directive.ts) | -| [Unclaim Task Directive](process-services/directives/unclaim-task.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Unclaims a task | [Source](../lib/process-services/src/lib/task-list/components/task-form/unclaim-task.directive.ts) | +| Name | Description | Source link | +| -------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | -------------------------------------------------------------------------------------------------- | +| [Claim Task Directive](process-services/directives/claim-task.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Claims a task | [Source](../lib/process-services/src/lib/task-list/components/task-form/claim-task.directive.ts) | +| [Process Audit Directive](process-services/directives/process-audit.directive.md) | Fetches the Process Audit information in PDF or JSON format. | [Source](../lib/process-services/src/lib/process-list/components/process-audit.directive.ts) | +| [Task Audit Directive](process-services/directives/task-audit.directive.md) | Fetches the Task Audit information in PDF or JSON format. | [Source](../lib/process-services/src/lib/task-list/components/task-audit.directive.ts) | +| [Unclaim Task Directive](process-services/directives/unclaim-task.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Unclaims a task | [Source](../lib/process-services/src/lib/task-list/components/task-form/unclaim-task.directive.ts) | ### Pipes -| Name | Description | Source link | -| ---- | ----------- | ----------- | +| Name | Description | Source link | +| ---------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | | [Process name pipe](process-services/pipes/process-name.pipe.md) | When an identifier is specified, the input will be transformed replacing the identifiers with the values of the selected process definition provided. | [Source](../lib/process-services/src/lib/pipes/process-name.pipe.ts) | ### Services -| Name | Description | Source link | -| ---- | ----------- | ----------- | +| Name | Description | Source link | +| ----------------------------------------------------------------------------- | -------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | | [Process Filter Service](process-services/services/process-filter.service.md) | Manage Process Filters, which are pre-configured Process Instance queries. | [Source](../lib/process-services/src/lib/process-list/services/process-filter.service.ts) | -| [Process Service](process-services/services/process.service.md) | Manages process instances, process variables, and process audit Log. | [Source](../lib/process-services/src/lib/process-list/services/process.service.ts) | -| [Task Filter Service](process-services/services/task-filter.service.md) | Manage Task Filters, which are pre-configured Task Instance queries. | [Source](../lib/process-services/src/lib/task-list/services/task-filter.service.ts) | -| [Tasklist Service](process-services/services/tasklist.service.md) | Manages Task Instances. | [Source](../lib/process-services/src/lib/task-list/services/tasklist.service.ts) | +| [Process Service](process-services/services/process.service.md) | Manages process instances, process variables, and process audit Log. | [Source](../lib/process-services/src/lib/process-list/services/process.service.ts) | +| [Task Filter Service](process-services/services/task-filter.service.md) | Manage Task Filters, which are pre-configured Task Instance queries. | [Source](../lib/process-services/src/lib/task-list/services/task-filter.service.ts) | +| [Tasklist Service](process-services/services/tasklist.service.md) | Manages Task Instances. | [Source](../lib/process-services/src/lib/task-list/services/tasklist.service.ts) | @@ -435,59 +435,59 @@ for more information about installing and using the source code. ### Components -| Name | Description | Source link | -| ---- | ----------- | ----------- | -| [App List Cloud Component](process-services-cloud/components/app-list-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows all deployed cloud application instances. | [Source](../lib/process-services-cloud/src/lib/app/components/app-list-cloud.component.ts) | -| [Edit Process Filter Cloud component](process-services-cloud/components/edit-process-filter-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows/edits process filter details. | [Source](../lib/process-services-cloud/src/lib/process/process-filters/components/edit-process-filter-cloud.component.ts) | -| [Edit Task Filter Cloud component](process-services-cloud/components/edit-task-filter-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Edits task filter details. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/components/edit-task-filter-cloud.component.ts) | -| [Form cloud custom outcomes component](process-services-cloud/components/form-cloud-custom-outcome.component.md) | Supplies custom outcome buttons to be included in Form cloud component. | [Source](../lib/process-services-cloud/src/lib/form/components/form-cloud-custom-outcomes.component.ts) | -| [Form cloud component](process-services-cloud/components/form-cloud.component.md) | Shows a form from Process Services. | [Source](../lib/process-services-cloud/src/lib/form/components/form-cloud.component.ts) | -| [Form Definition Selector Cloud](process-services-cloud/components/form-definition-selector-cloud.component.md) | Allows one form to be selected from a dropdown list. For forms to be displayed in this component they will need to be compatible with standAlone tasks. | [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/people/components/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) | -| [Process Header Cloud Component](process-services-cloud/components/process-header-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows all the information related to a process instance. | [Source](../lib/process-services-cloud/src/lib/process/process-header/components/process-header-cloud.component.ts) | -| [Process Instance List Cloud component](process-services-cloud/components/process-list-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Renders a list containing all the process instances matched by the parameters specified. | [Source](../lib/process-services-cloud/src/lib/process/process-list/components/process-list-cloud.component.ts) | -| [Start Process Cloud Component](process-services-cloud/components/start-process-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Starts a process. | [Source](../lib/process-services-cloud/src/lib/process/start-process/components/start-process-cloud.component.ts) | -| [Start Task Cloud Component](process-services-cloud/components/start-task-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Creates/starts a new task for the specified app. | [Source](../lib/process-services-cloud/src/lib/task/start-task/components/start-task-cloud.component.ts) | -| [Task Filters Cloud component](process-services-cloud/components/task-filters-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows all available filters. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/components/task-filters-cloud.component.ts) | -| [Form cloud component](process-services-cloud/components/task-form-cloud.component.md) | Shows a form for a task. | [Source](../lib/process-services-cloud/src/lib/task/task-form/components/task-form-cloud.component.ts) | -| [Task Header Cloud Component](process-services-cloud/components/task-header-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows all the information related to a task. | [Source](../lib/process-services-cloud/src/lib/task/task-header/components/task-header-cloud.component.ts) | -| [Task List Cloud component](process-services-cloud/components/task-list-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Renders a list containing all the tasks matched by the parameters specified. | [Source](../lib/process-services-cloud/src/lib/task/task-list/components/task-list-cloud.component.ts) | +| Name | Description | Source link | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| [App List Cloud Component](process-services-cloud/components/app-list-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows all deployed cloud application instances. | [Source](../lib/process-services-cloud/src/lib/app/components/app-list-cloud.component.ts) | +| [Edit Process Filter Cloud component](process-services-cloud/components/edit-process-filter-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows/edits process filter details. | [Source](../lib/process-services-cloud/src/lib/process/process-filters/components/edit-process-filter-cloud.component.ts) | +| [Edit Task Filter Cloud component](process-services-cloud/components/edit-task-filter-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Edits task filter details. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/components/edit-task-filters/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](process-services-cloud/components/form-definition-selector-cloud.component.md) | Allows one form to be selected from a dropdown list. For forms to be displayed in this component they will need to be compatible with standAlone tasks. | [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/people/components/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) | +| [Process Header Cloud Component](process-services-cloud/components/process-header-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows all the information related to a process instance. | [Source](../lib/process-services-cloud/src/lib/process/process-header/components/process-header-cloud.component.ts) | +| [Process Instance List Cloud component](process-services-cloud/components/process-list-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Renders a list containing all the process instances matched by the parameters specified. | [Source](../lib/process-services-cloud/src/lib/process/process-list/components/process-list-cloud.component.ts) | +| [Start Process Cloud Component](process-services-cloud/components/start-process-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Starts a process. | [Source](../lib/process-services-cloud/src/lib/process/start-process/components/start-process-cloud.component.ts) | +| [Start Task Cloud Component](process-services-cloud/components/start-task-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Creates/starts a new task for the specified app. | [Source](../lib/process-services-cloud/src/lib/task/start-task/components/start-task-cloud.component.ts) | +| [Task Filters Cloud component](process-services-cloud/components/task-filters-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows all available filters. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/components/task-filters-cloud.component.ts) | +| [Form cloud component](process-services-cloud/components/task-form-cloud.component.md) | Shows a form for a task. | [Source](../lib/process-services-cloud/src/lib/task/task-form/components/task-form-cloud.component.ts) | +| [Task Header Cloud Component](process-services-cloud/components/task-header-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows all the information related to a task. | [Source](../lib/process-services-cloud/src/lib/task/task-header/components/task-header-cloud.component.ts) | +| [Task List Cloud component](process-services-cloud/components/task-list-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Renders a list containing all the tasks matched by the parameters specified. | [Source](../lib/process-services-cloud/src/lib/task/task-list/components/task-list-cloud.component.ts) | ### Directives -| Name | Description | Source link | -| ---- | ----------- | ----------- | -| [Cancel Process Directive](process-services-cloud/directives/cancel-process.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Cancels a process | [Source](../lib/process-services-cloud/src/lib/process/directives/cancel-process.directive.ts) | -| [Claim Task Cloud Directive](process-services-cloud/directives/claim-task-cloud.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Claims a task | [Source](../lib/process-services-cloud/src/lib/task/directives/claim-task-cloud.directive.ts) | -| [Complete Task Directive](process-services-cloud/directives/complete-task.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Completes a task. | [Source](../lib/process-services-cloud/src/lib/task/directives/complete-task.directive.ts) | -| [Unclaim Task Cloud Directive](process-services-cloud/directives/unclaim-task-cloud.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Unclaims a task | [Source](../lib/process-services-cloud/src/lib/task/directives/unclaim-task-cloud.directive.ts) | +| Name | Description | Source link | +| -------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | ----------------------------------------------------------------------------------------------- | +| [Cancel Process Directive](process-services-cloud/directives/cancel-process.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Cancels a process | [Source](../lib/process-services-cloud/src/lib/process/directives/cancel-process.directive.ts) | +| [Claim Task Cloud Directive](process-services-cloud/directives/claim-task-cloud.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Claims a task | [Source](../lib/process-services-cloud/src/lib/task/directives/claim-task-cloud.directive.ts) | +| [Complete Task Directive](process-services-cloud/directives/complete-task.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Completes a task. | [Source](../lib/process-services-cloud/src/lib/task/directives/complete-task.directive.ts) | +| [Unclaim Task Cloud Directive](process-services-cloud/directives/unclaim-task-cloud.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Unclaims a task | [Source](../lib/process-services-cloud/src/lib/task/directives/unclaim-task-cloud.directive.ts) | ### Pipes -| Name | Description | Source link | -| ---- | ----------- | ----------- | -| [Group initial pipe](process-services-cloud/pipes/group-initial.pipe.md) | Extracts the initial character from a group name. | [Source](../lib/process-services-cloud/src/lib/group/pipe/group-initial.pipe.ts) | +| Name | Description | Source link | +| ---------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| [Group initial pipe](process-services-cloud/pipes/group-initial.pipe.md) | Extracts the initial character from a group name. | [Source](../lib/process-services-cloud/src/lib/group/pipe/group-initial.pipe.ts) | | [Process name cloud pipe](process-services-cloud/pipes/process-name-cloud.pipe.md) | When an identifier is specified, the input will be transformed replacing the identifiers with the values of the selected process definition provided. | [Source](../lib/process-services-cloud/src/lib/pipes/process-name-cloud.pipe.ts) | ### Services -| Name | Description | Source link | -| ---- | ----------- | ----------- | -| [Apps Process Cloud Service](process-services-cloud/services/apps-process-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Gets details of deployed apps for the current user. | [Source](../lib/process-services-cloud/src/lib/app/services/apps-process-cloud.service.ts) | -| [Form cloud service](process-services-cloud/services/form-cloud.service.md) | Implements Process Services form methods | [Source](../lib/process-services-cloud/src/lib/form/services/form-cloud.service.ts) | -| [Group Cloud Service](process-services-cloud/services/group-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Searches and gets information for groups. | [Source](../lib/process-services-cloud/src/lib/group/services/group-cloud.service.ts) | -| [Local Preference Cloud Service](process-services-cloud/services/local-preference-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages Local Storage preferences. | [Source](../lib/process-services-cloud/src/lib/services/local-preference-cloud.service.ts) | -| [Process Cloud Service](process-services-cloud/services/process-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages cloud process instances. | [Source](../lib/process-services-cloud/src/lib/process/services/process-cloud.service.ts) | -| [Process Filter Cloud Service](process-services-cloud/services/process-filter-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manage Process Filters, which are pre-configured Process Instance queries. | [Source](../lib/process-services-cloud/src/lib/process/process-filters/services/process-filter-cloud.service.ts) | -| [Process List Cloud Service](process-services-cloud/services/process-list-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Searches processes. | [Source](../lib/process-services-cloud/src/lib/process/process-list/services/process-list-cloud.service.ts) | -| [Start Process Cloud Service](process-services-cloud/services/start-process-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Gets process definitions and starts processes. | [Source](../lib/process-services-cloud/src/lib/process/start-process/services/start-process-cloud.service.ts) | -| [Start Task Cloud Service](process-services-cloud/services/start-task-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Starts standalone tasks. | [Source](../lib/process-services-cloud/src/lib/task/services/start-task-cloud.service.ts) | -| [Task Cloud Service](process-services-cloud/services/task-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages task cloud. | [Source](../lib/process-services-cloud/src/lib/task/services/task-cloud.service.ts) | -| [Task Filter Cloud Service](process-services-cloud/services/task-filter-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages task filters. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/services/task-filter-cloud.service.ts) | -| [Task List Cloud Service](process-services-cloud/services/task-list-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Searches tasks. | [Source](../lib/process-services-cloud/src/lib/task/task-list/services/task-list-cloud.service.ts) | -| [User Preference Cloud Service](process-services-cloud/services/user-preference-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages user preferences. | [Source](../lib/process-services-cloud/src/lib/services/user-preference-cloud.service.ts) | +| Name | Description | Source link | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| [Apps Process Cloud Service](process-services-cloud/services/apps-process-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Gets details of deployed apps for the current user. | [Source](../lib/process-services-cloud/src/lib/app/services/apps-process-cloud.service.ts) | +| [Form cloud service](process-services-cloud/services/form-cloud.service.md) | Implements Process Services form methods | [Source](../lib/process-services-cloud/src/lib/form/services/form-cloud.service.ts) | +| [Group Cloud Service](process-services-cloud/services/group-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Searches and gets information for groups. | [Source](../lib/process-services-cloud/src/lib/group/services/group-cloud.service.ts) | +| [Local Preference Cloud Service](process-services-cloud/services/local-preference-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages Local Storage preferences. | [Source](../lib/process-services-cloud/src/lib/services/local-preference-cloud.service.ts) | +| [Process Cloud Service](process-services-cloud/services/process-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages cloud process instances. | [Source](../lib/process-services-cloud/src/lib/process/services/process-cloud.service.ts) | +| [Process Filter Cloud Service](process-services-cloud/services/process-filter-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manage Process Filters, which are pre-configured Process Instance queries. | [Source](../lib/process-services-cloud/src/lib/process/process-filters/services/process-filter-cloud.service.ts) | +| [Process List Cloud Service](process-services-cloud/services/process-list-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Searches processes. | [Source](../lib/process-services-cloud/src/lib/process/process-list/services/process-list-cloud.service.ts) | +| [Start Process Cloud Service](process-services-cloud/services/start-process-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Gets process definitions and starts processes. | [Source](../lib/process-services-cloud/src/lib/process/start-process/services/start-process-cloud.service.ts) | +| [Start Task Cloud Service](process-services-cloud/services/start-task-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Starts standalone tasks. | [Source](../lib/process-services-cloud/src/lib/task/services/start-task-cloud.service.ts) | +| [Task Cloud Service](process-services-cloud/services/task-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages task cloud. | [Source](../lib/process-services-cloud/src/lib/task/services/task-cloud.service.ts) | +| [Task Filter Cloud Service](process-services-cloud/services/task-filter-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages task filters. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/services/task-filter-cloud.service.ts) | +| [Task List Cloud Service](process-services-cloud/services/task-list-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Searches tasks. | [Source](../lib/process-services-cloud/src/lib/task/task-list/services/task-list-cloud.service.ts) | +| [User Preference Cloud Service](process-services-cloud/services/user-preference-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages user preferences. | [Source](../lib/process-services-cloud/src/lib/services/user-preference-cloud.service.ts) | @@ -504,15 +504,15 @@ for more information about installing and using the source code. ### Components -| Name | Description | Source link | -| ---- | ----------- | ----------- | -| [Dynamic Component](extensions/components/dynamic.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays dynamically-loaded extension components. | [Source](../lib/extensions/src/lib/components/dynamic-component/dynamic.component.ts) | -| [Preview Extension Component](extensions/components/preview-extension.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Supports dynamically-loaded viewer preview extensions. | [Source](../lib/extensions/src/lib/components/viewer/preview-extension.component.ts) | +| Name | Description | Source link | +| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------------------------------------- | +| [Dynamic Component](extensions/components/dynamic.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays dynamically-loaded extension components. | [Source](../lib/extensions/src/lib/components/dynamic-component/dynamic.component.ts) | +| [Preview Extension Component](extensions/components/preview-extension.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Supports dynamically-loaded viewer preview extensions. | [Source](../lib/extensions/src/lib/components/viewer/preview-extension.component.ts) | ### Services -| Name | Description | Source link | -| ---- | ----------- | ----------- | +| Name | Description | Source link | +| -------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | ----------------------------------------------------------------- | | [Extension Service](extensions/services/extension.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages and runs basic extension functionality. | [Source](../lib/extensions/src/lib/services/extension.service.ts) | @@ -530,13 +530,13 @@ for more information about installing and using the source code. ### Components -| Name | Description | Source link | -| ---- | ----------- | ----------- | -| [Analytics Generator Component](insights/components/analytics-generator.component.md) | Generates and shows charts | [Source](../lib/insights/src/lib/analytics-process/components/analytics-generator.component.ts) | -| [APS Analytics List Component](insights/components/analytics-report-list.component.md) | Shows a list of all available reports | [Source](../lib/insights/src/lib/analytics-process/components/analytics-report-list.component.ts) | -| [APS Analytics Component](insights/components/analytics.component.md) | Shows the charts related to the reportId passed as input | [Source](../lib/insights/src/lib/analytics-process/components/analytics.component.ts) | -| [Diagram Component](insights/components/diagram.component.md) | Displays process diagrams. | [Source](../lib/insights/src/lib/diagram/components/diagram.component.ts) | -| [Widget component](insights/components/widget.component.md) | Base class for standard and custom widget classes. | [Source](../lib/insights/src/lib/analytics-process/components/widgets/widget.component.ts) | +| Name | Description | Source link | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | +| [Analytics Generator Component](insights/components/analytics-generator.component.md) | Generates and shows charts | [Source](../lib/insights/src/lib/analytics-process/components/analytics-generator.component.ts) | +| [APS Analytics List Component](insights/components/analytics-report-list.component.md) | Shows a list of all available reports | [Source](../lib/insights/src/lib/analytics-process/components/analytics-report-list.component.ts) | +| [APS Analytics Component](insights/components/analytics.component.md) | Shows the charts related to the reportId passed as input | [Source](../lib/insights/src/lib/analytics-process/components/analytics.component.ts) | +| [Diagram Component](insights/components/diagram.component.md) | Displays process diagrams. | [Source](../lib/insights/src/lib/diagram/components/diagram.component.ts) | +| [Widget component](insights/components/widget.component.md) | Base class for standard and custom widget classes. | [Source](../lib/insights/src/lib/analytics-process/components/widgets/widget.component.ts) | diff --git a/docs/content-services/components/add-permission-panel.component.md b/docs/content-services/components/add-permission-panel.component.md index e9d6e667ca..334c2b5b8d 100644 --- a/docs/content-services/components/add-permission-panel.component.md +++ b/docs/content-services/components/add-permission-panel.component.md @@ -25,8 +25,8 @@ Searches for people or groups to add to the current node permissions. ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| ------ | ----------------------------------------------------------------- | ------------------------------------------------ | | select | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a permission list item is selected. | ## Details diff --git a/docs/content-services/components/add-permission.component.md b/docs/content-services/components/add-permission.component.md index 353d6e5d15..4300df47ab 100644 --- a/docs/content-services/components/add-permission.component.md +++ b/docs/content-services/components/add-permission.component.md @@ -25,16 +25,16 @@ Searches for people or groups to add to the current node permissions. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| nodeId | `string` | | ID of the target node. | +| Name | Type | Default value | Description | +| ------ | -------- | ------------- | ---------------------- | +| nodeId | `string` | | ID of the target node. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs during the update. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when the node is updated successfully. | +| Name | Type | Description | +| ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs during the update. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when the node is updated successfully. | ## Details diff --git a/docs/content-services/components/breadcrumb.component.md b/docs/content-services/components/breadcrumb.component.md index b05119228b..6508380846 100644 --- a/docs/content-services/components/breadcrumb.component.md +++ b/docs/content-services/components/breadcrumb.component.md @@ -23,19 +23,19 @@ Indicates the current position within a navigation hierarchy. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| folderNode | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | null | Active node, builds UI based on folderNode.path.elements collection. | -| maxItems | `number` | | Maximum number of nodes to display before wrapping them with a dropdown element. | -| root | `string` | null | (optional) Name of the root element of the breadcrumb. You can use this property to rename "Company Home" to "Personal Files" for example. You can use an i18n resource key for the property value. | -| rootId | `string` | null | (optional) The id of the root element. You can use this property to set a custom element the breadcrumb should start with. | -| target | [`DocumentListComponent`](../../content-services/components/document-list.component.md) | | (optional) [Document List component](../../content-services/components/document-list.component.md) to operate with. The list will update when the breadcrumb is clicked. | -| transform | `Function` | | Transformation to be performed on the chosen/folder node before building the breadcrumb UI. Can be useful when custom formatting is needed for the breadcrumb. You can change the path elements from the node that are used to build the breadcrumb using this function. | +| Name | Type | Default value | Description | +| ---------- | -------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| folderNode | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | null | Active node, builds UI based on folderNode.path.elements collection. | +| maxItems | `number` | | Maximum number of nodes to display before wrapping them with a dropdown element. | +| root | `string` | null | (optional) Name of the root element of the breadcrumb. You can use this property to rename "Company Home" to "Personal Files" for example. You can use an i18n resource key for the property value. | +| rootId | `string` | null | (optional) The id of the root element. You can use this property to set a custom element the breadcrumb should start with. | +| target | [`DocumentListComponent`](../../content-services/components/document-list.component.md) | | (optional) [Document List component](../../content-services/components/document-list.component.md) to operate with. The list will update when the breadcrumb is clicked. | +| transform | `Function` | | Transformation to be performed on the chosen/folder node before building the breadcrumb UI. Can be useful when custom formatting is needed for the breadcrumb. You can change the path elements from the node that are used to build the breadcrumb using this function. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | | navigate | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PathElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PathElement.md)`>` | Emitted when the user clicks on a breadcrumb. | ## Details diff --git a/docs/content-services/components/content-action.component.md b/docs/content-services/components/content-action.component.md index 97a56c078d..4373055bcd 100644 --- a/docs/content-services/components/content-action.component.md +++ b/docs/content-services/components/content-action.component.md @@ -82,25 +82,25 @@ export class MyView { ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| disableWithNoPermission | `boolean` | | Should this action be disabled in the menu if the user doesn't have permission for it? | -| disabled | `boolean \| Function` | false | Is the menu item disabled? | -| handler | `string` | | System actions. Can be "delete", "download", "copy" or "move". | -| icon | `string` | | The name of the icon to display next to the menu command (can be left blank). | -| permission | `string` | | The permission type. | -| target | `string` | | Type of item that the action applies to. Can be "document" or "folder" | -| title | `string` | "Action" | The title of the action as shown in the menu. | -| visible | `boolean \| Function` | true | Visibility state (see examples). | +| Name | Type | Default value | Description | +| ----------------------- | --------------------- | ------------- | -------------------------------------------------------------------------------------- | +| disableWithNoPermission | `boolean` | | Should this action be disabled in the menu if the user doesn't have permission for it? | +| disabled | `boolean \| Function` | false | Is the menu item disabled? | +| handler | `string` | | System actions. Can be "delete", "download", "copy" or "move". | +| icon | `string` | | The name of the icon to display next to the menu command (can be left blank). | +| permission | `string` | | The permission type. | +| target | `string` | | Type of item that the action applies to. Can be "document" or "folder" | +| title | `string` | "Action" | The title of the action as shown in the menu. | +| visible | `boolean \| Function` | true | Visibility state (see examples). | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs during the action. Applies to copy and move actions. | -| execute | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the user selects the action from the menu. | -| permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a permission error occurs | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the action succeeds with the success string message. Applies to copy, move and delete actions. | +| Name | Type | Description | +| --------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs during the action. Applies to copy and move actions. | +| execute | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the user selects the action from the menu. | +| permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a permission error occurs | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the action succeeds with the success string message. Applies to copy, move and delete actions. | ## Details diff --git a/docs/content-services/components/content-metadata-card.component.md b/docs/content-services/components/content-metadata-card.component.md index d8ece119c9..56d7e3f196 100644 --- a/docs/content-services/components/content-metadata-card.component.md +++ b/docs/content-services/components/content-metadata-card.component.md @@ -25,6 +25,7 @@ Displays and edits metadata related to a node. - [Multi value card properties](#multi-value-card-properties) - [Use chips for multi value properties](#use-chips-for-multi-value-properties) - [Copy to Clipboard on click](#copy-to-clipboard-on-click) +- [Search select options (ACS 7+)](#search-select-options-acs-7) ## Basic Usage @@ -41,15 +42,15 @@ Displays and edits metadata related to a node. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| displayAspect | `string` | null | (optional) This flag displays desired aspect when open for the first time fields. | -| displayEmpty | `boolean` | false | (optional) This flag displays/hides empty metadata fields. | -| multi | `boolean` | false | (optional) This flag allows the component to display more than one accordion at a time. | -| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | (required) The node entity to fetch metadata about | -| preset | `string` | | (required) Name of the metadata preset, which defines aspects and their properties. | -| readOnly | `boolean` | false | (optional) This flag sets the metadata in read only mode preventing changes. | -| displayDefaultProperties | `boolean` | | (optional) This flag displays/hides the metadata properties. | +| Name | Type | Default value | Description | +| ------------------------ | -------------------------------------------------------------------------------------------------------- | ------------- | --------------------------------------------------------------------------------------- | +| displayAspect | `string` | null | (optional) This flag displays desired aspect when open for the first time fields. | +| displayEmpty | `boolean` | false | (optional) This flag displays/hides empty metadata fields. | +| multi | `boolean` | false | (optional) This flag allows the component to display more than one accordion at a time. | +| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | (required) The node entity to fetch metadata about | +| preset | `string` | | (required) Name of the metadata preset, which defines aspects and their properties. | +| readOnly | `boolean` | false | (optional) This flag sets the metadata in read only mode preventing changes. | +| displayDefaultProperties | `boolean` | | (optional) This flag displays/hides the metadata properties. | ## Details @@ -253,20 +254,20 @@ The result of this config would be two accordion groups with the following prope | GROUP-TITLE1-TRANSLATION-KEY | | ---------------------------- | -| exif:param1 | -| exif:param2 | -| ... | -| exif:paramN | -| kitten:custom1 | -| kitten:custom3 | -| owner:name | -| kitten:name | -| kitten:color | +| exif:param1 | +| exif:param2 | +| ... | +| exif:paramN | +| kitten:custom1 | +| kitten:custom3 | +| owner:name | +| kitten:name | +| kitten:color | | GROUP-TITLE2-TRANSLATION-KEY | | ---------------------------- | -| kitten:favourite-food | -| kitten:recommended-food | +| kitten:favourite-food | +| kitten:recommended-food | #### Making properties editable diff --git a/docs/content-services/components/content-node-selector-panel.component.md b/docs/content-services/components/content-node-selector-panel.component.md index 404a472322..ef68538f8c 100644 --- a/docs/content-services/components/content-node-selector-panel.component.md +++ b/docs/content-services/components/content-node-selector-panel.component.md @@ -28,31 +28,31 @@ Opens a [Content Node Selector](content-node-selector.component.md) in its own ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| breadcrumbTransform | `Function` | | Transformation to be performed on the chosen/folder node before building the breadcrumb UI. Can be useful when custom formatting is needed for the breadcrumb. You can change the path elements from the node that are used to build the breadcrumb using this function. | -| currentFolderId | `string` | null | [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) ID of the folder currently listed. | -| dropdownHideMyFiles | `boolean` | false | Hide the "My Files" option added to the site list by default. See the [Sites Dropdown component](sites-dropdown.component.md) for more information. | -| dropdownSiteList | [`SitePaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md) | null | Custom site for site dropdown. This is the same as the `siteList`. property of the Sites Dropdown component (see its doc page for more information). | -| imageResolver | [`ImageResolver`](../../../lib/content-services/src/lib/document-list/data/image-resolver.model.ts) | null | Custom image resolver function. See the [Image Resolver Model](image-resolver.model.md) page for more information. | -| isSelectionValid | [`ValidationFunction`](../../../lib/content-services/src/lib/content-node-selector/content-node-selector-panel.component.ts) | defaultValidation | Function used to decide if the selected node has permission to be selected. Default value is a function that always returns true. | -| pageSize | `number` | | Number of items shown per page in the list. | -| restrictRootToCurrentFolderId | `boolean` | false | If true will restrict the search and breadcrumbs to the currentFolderId | -| selectionMode | `"single" \| "multiple"` | "single" | Define the selection mode for document list. The allowed values are single or multiple | -| where | `string` | | Custom _where_ filter function. See the [Document List component](../../content-services/components/document-list.component.md) for more information. | -| excludeSiteContent | `string[]` | | Custom list of site content componentIds. Used to filter out the corresponding items from the displayed nodes | -| rowFilter | [`RowFilter`](../../../lib/content-services/src/lib/document-list/data/row-filter.model.ts) | | Custom row filter function. See the [Row Filter Model](row-filter.model.md) page for more information. | -| showDropdownSiteList | `boolean` | | Toggle sites list dropdown rendering | -| showFilesInResult | `void` | | Shows the files and folders in the search result | -| showSearch | `boolean` | | Toggle search input rendering | +| Name | Type | Default value | Description | +| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| breadcrumbTransform | `Function` | | Transformation to be performed on the chosen/folder node before building the breadcrumb UI. Can be useful when custom formatting is needed for the breadcrumb. You can change the path elements from the node that are used to build the breadcrumb using this function. | +| currentFolderId | `string` | null | [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) ID of the folder currently listed. | +| dropdownHideMyFiles | `boolean` | false | Hide the "My Files" option added to the site list by default. See the [Sites Dropdown component](sites-dropdown.component.md) for more information. | +| dropdownSiteList | [`SitePaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md) | null | Custom site for site dropdown. This is the same as the `siteList`. property of the Sites Dropdown component (see its doc page for more information). | +| imageResolver | [`ImageResolver`](../../../lib/content-services/src/lib/document-list/data/image-resolver.model.ts) | null | Custom image resolver function. See the [Image Resolver Model](image-resolver.model.md) page for more information. | +| isSelectionValid | [`ValidationFunction`](../../../lib/content-services/src/lib/content-node-selector/content-node-selector-panel.component.ts) | defaultValidation | Function used to decide if the selected node has permission to be selected. Default value is a function that always returns true. | +| pageSize | `number` | | Number of items shown per page in the list. | +| restrictRootToCurrentFolderId | `boolean` | false | If true will restrict the search and breadcrumbs to the currentFolderId | +| selectionMode | `"single" \| "multiple"` | "single" | Define the selection mode for document list. The allowed values are single or multiple | +| where | `string` | | Custom _where_ filter function. See the [Document List component](../../content-services/components/document-list.component.md) for more information. | +| excludeSiteContent | `string[]` | | Custom list of site content componentIds. Used to filter out the corresponding items from the displayed nodes | +| rowFilter | [`RowFilter`](../../../lib/content-services/src/lib/document-list/data/row-filter.model.ts) | | Custom row filter function. See the [Row Filter Model](row-filter.model.md) page for more information. | +| showDropdownSiteList | `boolean` | | Toggle sites list dropdown rendering | +| showFilesInResult | `void` | | Shows the files and folders in the search result | +| showSearch | `boolean` | | Toggle search input rendering | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| navigationChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntryEvent`](../../../lib/content-services/src/lib/document-list/components/node.event.ts)`>` | Emitted when the navigation changes. | -| select | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` | Emitted when the user has chosen an item. | -| siteChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the select site changes. | +| Name | Type | Description | +| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | +| navigationChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntryEvent`](../../../lib/content-services/src/lib/document-list/components/node.event.ts)`>` | Emitted when the navigation changes. | +| select | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` | Emitted when the user has chosen an item. | +| siteChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the select site changes. | ## Details diff --git a/docs/content-services/components/document-list.component.md b/docs/content-services/components/document-list.component.md index 2757bb536a..ebef33f89f 100644 --- a/docs/content-services/components/document-list.component.md +++ b/docs/content-services/components/document-list.component.md @@ -55,52 +55,52 @@ Displays the documents from a repository. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| additionalSorting | [`DataSorting`](../../../lib/core/datatable/data/data-sorting.model.ts) | Defines default sorting. The format is an array of strings `[key direction, otherKey otherDirection]` i.e. `['name desc', 'nodeType asc']` or `['name asc']`. Set this value if you want a base rule to be added to the sorting apart from the one driven by the header. | -| allowDropFiles | `boolean` | false | When true, this enables you to drop files directly into subfolders shown as items in the list or into another file to trigger updating it's version. When false, the dropped file will be added to the current folder (ie, the one containing all the items shown in the list). See the [Upload directive](../../core/directives/upload.directive.md) for further details about how the file drop is handled. | -| contentActions | `boolean` | false | Toggles content actions for each row | -| contentActionsPosition | `string` | "right" | Position of the content actions dropdown menu. Can be set to "left" or "right". | -| contextMenuActions | `boolean` | false | Toggles context menus for each row | -| display | `string` | DisplayMode.List | Change the display mode of the table. Can be "list" or "gallery". | -| emptyFolderImageUrl | `string` | | Custom image for empty folder. Default value: './assets/images/empty_doc_lib.svg' | -| imageResolver | `any \| null` | null | Custom function to choose image file paths to show. See the [Image Resolver Model](image-resolver.model.md) page for more information. | -| includeFields | `string[]` | | Include additional information about the node in the server request. For example: association, isLink, isLocked and others. | -| loading | `boolean` | false | Toggles the loading state and animated spinners for the component. Used in combination with `navigate=false` to perform custom navigation and loading state indication. | -| locationFormat | `string` | "/" | The default route for all the location-based columns (if declared). | -| maxItems | `number` | | Default value is stored in the user preference settings. Use this only if you are not using pagination. | -| multiselect | `boolean` | false | Toggles multiselect mode | -| navigate | `boolean` | true | Toggles navigation to folder content or file preview | -| navigationMode | `string` | | [User](../../../lib/core/pipes/user-initial.pipe.ts) interaction for folder navigation or file preview. Valid values are "click" and "dblclick". Default value: "dblclick" | -| node | [`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md) | null | The Document list will show all the nodes contained in the [NodePaging](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md) entity | -| permissionsStyle | [`PermissionStyleModel`](../../../lib/content-services/src/lib/document-list/models/permissions-style.model.ts)`[]` | \[] | Define a set of CSS styles to apply depending on the permission of the user on that node. See the [Permission Style model](../../../lib/content-services/src/lib/document-list/models/permissions-style.model.ts) page for further details and examples. | -| preselectNodes | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) `[]` | \[] | Array of nodes to preselect . | -| rowStyle | `string` | | The inline style to apply to every row. See the Angular NgStyle docs for more details and usage examples. | -| rowStyleClass | `string` | | The CSS class to apply to every row | -| selectionMode | `string` | "single" | Row selection mode. Can be null, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. | -| showHeader | `string` | | Toggles the header | -| sorting | `string[]` \| [`DataSorting`](../../../lib/core/datatable/data/data-sorting.model.ts) | ['name', 'asc'] | Defines default sorting. The format is an array of 2 strings `[key, direction]` i.e. `['name', 'desc']` or `['name', 'asc']`. Set this value only if you want to override the default sorting detected by the component based on columns. | -| sortingMode | `string` | "server" | Defines sorting mode. Can be either `client` (items in the list are sorted client-side) or `server` (the ordering supplied by the server is used without further client-side sorting). Note that the `server` option _does not_ request the server to sort the data before delivering it. | -| stickyHeader | `boolean` | false | Toggles the sticky header mode. | -| thumbnails | `boolean` | false | Show document thumbnails rather than icons | -| where | `string` | | Filters the [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) list using the _where_ condition of the REST API (for example, isFolder=true). See the REST API documentation for more information. | -| currentFolderId | `string` | null | The ID of the folder node to display or a reserved string alias for special sources | -| rowFilter | [`RowFilter`](../../../lib/content-services/src/lib/document-list/data/row-filter.model.ts) | | Custom function to choose whether to show or hide rows. See the [Row Filter Model](row-filter.model.md) page for more information. | -| headerFilters | `boolean` | false | Toggles the header filters mode. | -| filterValue | any | | Initial value for filter. | +| Name | Type | Default value | Description | +| ---------------------- | ----------------------------------------------------------------------------------------------------------------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| additionalSorting | [`DataSorting`](../../../lib/core/datatable/data/data-sorting.model.ts) | | Defines default sorting. The format is an array of strings `[key direction, otherKey otherDirection]` i.e. `['name desc', 'nodeType asc']` or `['name asc']`. Set this value if you want a base rule to be added to the sorting apart from the one driven by the header. | +| allowDropFiles | `boolean` | false | When true, this enables you to drop files directly into subfolders shown as items in the list or into another file to trigger updating it's version. When false, the dropped file will be added to the current folder (ie, the one containing all the items shown in the list). See the [Upload directive](../../core/directives/upload.directive.md) for further details about how the file drop is handled. | +| contentActions | `boolean` | false | Toggles content actions for each row | +| contentActionsPosition | `string` | "right" | Position of the content actions dropdown menu. Can be set to "left" or "right". | +| contextMenuActions | `boolean` | false | Toggles context menus for each row | +| currentFolderId | `string` | null | The ID of the folder node to display or a reserved string alias for special sources | +| display | `string` | DisplayMode.List | Change the display mode of the table. Can be "list" or "gallery". | +| emptyFolderImageUrl | `string` | | Custom image for empty folder. Default value: './assets/images/empty_doc_lib.svg' | +| filterValue | `any` | | Initial value for filter. | +| headerFilters | `boolean` | false | Toggles the header filters mode. | +| imageResolver | `any \| null` | null | Custom function to choose image file paths to show. See the [Image Resolver Model](image-resolver.model.md) page for more information. | +| includeFields | `string[]` | | Include additional information about the node in the server request. For example: association, isLink, isLocked and others. | +| loading | `boolean` | false | Toggles the loading state and animated spinners for the component. Used in combination with `navigate=false` to perform custom navigation and loading state indication. | +| locationFormat | `string` | "/" | The default route for all the location-based columns (if declared). | +| maxItems | `number` | | Default value is stored in the user preference settings. Use this only if you are not using pagination. | +| multiselect | `boolean` | false | Toggles multiselect mode | +| navigate | `boolean` | true | Toggles navigation to folder content or file preview | +| navigationMode | `string` | | [User](../../../lib/core/pipes/user-initial.pipe.ts) interaction for folder navigation or file preview. Valid values are "click" and "dblclick". Default value: "dblclick" | +| node | [`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md) | null | The Document list will show all the nodes contained in the [NodePaging](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md) entity | +| permissionsStyle | [`PermissionStyleModel`](../../../lib/content-services/src/lib/document-list/models/permissions-style.model.ts)`[]` | \[] | Define a set of CSS styles to apply depending on the permission of the user on that node. See the [Permission Style model](../../../lib/content-services/src/lib/document-list/models/permissions-style.model.ts) page for further details and examples. | +| preselectNodes | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` | \[] | Array of nodes to be pre-selected. All nodes in the array are pre-selected in multi selection mode, but only the first node is pre-selected in single selection mode. | +| rowStyle | `string` | | The inline style to apply to every row. See the Angular NgStyle docs for more details and usage examples. | +| rowStyleClass | `string` | | The CSS class to apply to every row | +| selectionMode | `string` | "single" | Row selection mode. Can be null, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. | +| showHeader | `string` | ShowHeaderMode.Data | Toggles the header | +| sorting | `string[] \| `[`DataSorting`](../../../lib/core/datatable/data/data-sorting.model.ts) | ['name', 'asc'] | Defines default sorting. The format is an array of 2 strings `[key, direction]` i.e. `['name', 'desc']` or `['name', 'asc']`. Set this value only if you want to override the default sorting detected by the component based on columns. | +| sortingMode | `string` | "server" | Defines sorting mode. Can be either `client` (items in the list are sorted client-side) or `server` (the ordering supplied by the server is used without further client-side sorting). Note that the `server` option _does not_ request the server to sort the data before delivering it. | +| stickyHeader | `boolean` | false | Toggles the sticky header mode. | +| thumbnails | `boolean` | false | Show document thumbnails rather than icons | +| where | `string` | | Filters the [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) list using the _where_ condition of the REST API (for example, isFolder=true). See the REST API documentation for more information. | +| rowFilter | [`RowFilter`](../../../lib/content-services/src/lib/document-list/data/row-filter.model.ts) | | Custom function to choose whether to show or hide rows. See the [Row Filter Model](row-filter.model.md) page for more information. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the API fails to get the Document List data | -| folderChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntryEvent`](../../../lib/content-services/src/lib/document-list/components/node.event.ts)`>` | Emitted when the current display folder changes | -| nodeClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntityEvent`](../../../lib/content-services/src/lib/document-list/components/node.event.ts)`>` | Emitted when the user clicks a list node | -| nodeDblClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntityEvent`](../../../lib/content-services/src/lib/document-list/components/node.event.ts)`>` | Emitted when the user double-clicks a list node | -| nodeSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]>` | Emitted when the node selection change | -| preview | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntityEvent`](../../../lib/content-services/src/lib/document-list/components/node.event.ts)`>` | Emitted when the user acts upon files with either single or double click (depends on `navigation-mode`). Useful for integration with the [Viewer component](../../core/components/viewer.component.md). | -| ready | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` | Emitted when the Document List has loaded all items and is ready for use. | -| filterSelection | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FilterSearch[]`](../../../lib/content-services/src/lib/search/filter-search.interface.ts)`>` | Emitted when a filter value is selected. | +| Name | Type | Description | +| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the API fails to get the Document List data | +| filterSelection | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FilterSearch`](../../../lib/content-services/src/lib/search/filter-search.interface.ts)`[]>` | Emitted when a filter value is selected | +| folderChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntryEvent`](../../../lib/content-services/src/lib/document-list/components/node.event.ts)`>` | Emitted when the current display folder changes | +| nodeClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntityEvent`](../../../lib/content-services/src/lib/document-list/components/node.event.ts)`>` | Emitted when the user clicks a list node | +| nodeDblClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntityEvent`](../../../lib/content-services/src/lib/document-list/components/node.event.ts)`>` | Emitted when the user double-clicks a list node | +| nodeSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]>` | Emitted when the node selection change | +| preview | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntityEvent`](../../../lib/content-services/src/lib/document-list/components/node.event.ts)`>` | Emitted when the user acts upon files with either single or double click (depends on `navigation-mode`). Useful for integration with the [Viewer component](../../core/components/viewer.component.md). | +| ready | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` | Emitted when the Document List has loaded all items and is ready for use | ## Details @@ -117,12 +117,12 @@ The Document list will automatically show special icons for : `Smart Folder`, `L Below are the DOM events the DocumentList component emits. All of them are _bubbling_, meaning you can handle them in any component up the parent hierarchy, even if the DocumentList is wrapped by one or more other components. -| Name | Description | -| ---- | ----------- | -| node-click | Emitted when user clicks the node | +| Name | Description | +| ------------- | ---------------------------------------- | +| node-click | Emitted when user clicks the node | | node-dblclick | Emitted when user double-clicks the node | -| node-select | Emitted when user selects a node | -| node-unselect | Emitted when user unselects a node | +| node-select | Emitted when user selects a node | +| node-unselect | Emitted when user unselects a node | Every event is represented by a [CustomEvent](https://developer.mozilla.org/en/docs/Web/API/CustomEvent) instance. Each event will have at least the following properties as part of the `Event.detail` property value: @@ -567,13 +567,13 @@ You can also add tooltips, styling, automatic column title translation and other You can use the following components as column templates: -| Name | Description | -| ---- | ----------- | -| `adf-name-column` | Renders the hyperlink-styled name of the node. Provides a formatted tooltip. Emits the `name-click` DOM event, which can be handled by any parent component. | -| `adf-library-name-column` | Renders the library name. Provides formatted tooltips and extra details for libraries with the same names on the page. Emits the `name-click` DOM event, which can be handled by any parent component. | -| `adf-library-role-column` | Renders i18n-enabled information about the Library (Site) role (`Manager`, `Collaborator`, `Contributor`, `Consumer`) | -| `adf-library-status-column` | Renders i18n-enabled information about the Library (Site) status (`Public`, `Private`, `Moderated`, `Unknown`) | -| `adf-trashcan-name-column` | Renders the name of the deleted node. Distinguishes between a Library (Site) and File/Folder nodes. Provides proper tooltips. | +| Name | Description | +| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `adf-name-column` | Renders the hyperlink-styled name of the node. Provides a formatted tooltip. Emits the `name-click` DOM event, which can be handled by any parent component. | +| `adf-library-name-column` | Renders the library name. Provides formatted tooltips and extra details for libraries with the same names on the page. Emits the `name-click` DOM event, which can be handled by any parent component. | +| `adf-library-role-column` | Renders i18n-enabled information about the Library (Site) role (`Manager`, `Collaborator`, `Contributor`, `Consumer`) | +| `adf-library-status-column` | Renders i18n-enabled information about the Library (Site) status (`Public`, `Private`, `Moderated`, `Unknown`) | +| `adf-trashcan-name-column` | Renders the name of the deleted node. Distinguishes between a Library (Site) and File/Folder nodes. Provides proper tooltips. | All the components above require only the `context` property to be bound, since each component fetches and renders the information it needs from the underlying node. @@ -701,6 +701,7 @@ You can enable Header filters in your document list simply setting to true its ` [headerFilters]="true"> ``` + ![Header filters](../../docassets/images/header-filters.png) ## Advanced usage and customization diff --git a/docs/content-services/components/dropdown-breadcrumb.component.md b/docs/content-services/components/dropdown-breadcrumb.component.md index a06bdbe5d9..16c22e83ab 100644 --- a/docs/content-services/components/dropdown-breadcrumb.component.md +++ b/docs/content-services/components/dropdown-breadcrumb.component.md @@ -24,19 +24,19 @@ Indicates the current position within a navigation hierarchy using a dropdown me ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| folderNode | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | null | Active node, builds UI based on folderNode.path.elements collection. | -| maxItems | `number` | | Maximum number of nodes to display before wrapping them with a dropdown element. | -| root | `string` | null | (optional) Name of the root element of the breadcrumb. You can use this property to rename "Company Home" to "Personal Files" for example. You can use an i18n resource key for the property value. | -| rootId | `string` | null | (optional) The id of the root element. You can use this property to set a custom element the breadcrumb should start with. | -| target | [`DocumentListComponent`](../../content-services/components/document-list.component.md) | | (optional) [Document List component](../../content-services/components/document-list.component.md) to operate with. The list will update when the breadcrumb is clicked. | -| transform | `Function` | | Transformation to be performed on the chosen/folder node before building the breadcrumb UI. Can be useful when custom formatting is needed for the breadcrumb. You can change the path elements from the node that are used to build the breadcrumb using this function. | +| Name | Type | Default value | Description | +| ---------- | -------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| folderNode | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | null | Active node, builds UI based on folderNode.path.elements collection. | +| maxItems | `number` | | Maximum number of nodes to display before wrapping them with a dropdown element. | +| root | `string` | null | (optional) Name of the root element of the breadcrumb. You can use this property to rename "Company Home" to "Personal Files" for example. You can use an i18n resource key for the property value. | +| rootId | `string` | null | (optional) The id of the root element. You can use this property to set a custom element the breadcrumb should start with. | +| target | [`DocumentListComponent`](../../content-services/components/document-list.component.md) | | (optional) [Document List component](../../content-services/components/document-list.component.md) to operate with. The list will update when the breadcrumb is clicked. | +| transform | `Function` | | Transformation to be performed on the chosen/folder node before building the breadcrumb UI. Can be useful when custom formatting is needed for the breadcrumb. You can change the path elements from the node that are used to build the breadcrumb using this function. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | | navigate | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PathElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PathElement.md)`>` | Emitted when the user clicks on a breadcrumb. | ## Details diff --git a/docs/content-services/components/file-uploading-dialog.component.md b/docs/content-services/components/file-uploading-dialog.component.md index f42860b940..ff45494fc9 100644 --- a/docs/content-services/components/file-uploading-dialog.component.md +++ b/docs/content-services/components/file-uploading-dialog.component.md @@ -19,14 +19,14 @@ Shows a dialog listing all the files uploaded with the Upload Button or Drag Are ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| position | `string` | "right" | Dialog position. Can be 'left' or 'right'. | +| Name | Type | Default value | Description | +| -------- | -------- | ------------- | ------------------------------------------ | +| position | `string` | "right" | Dialog position. Can be 'left' or 'right'. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| ----- | ----------------------------------------------------------------- | --------------------------------------------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a file in the list has an error. | ## Details diff --git a/docs/content-services/components/like.component.md b/docs/content-services/components/like.component.md index e38c9e14e1..b64fccf501 100644 --- a/docs/content-services/components/like.component.md +++ b/docs/content-services/components/like.component.md @@ -21,14 +21,14 @@ Allows a user to add "likes" to an item. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| nodeId | `string` | | Identifier of a node to apply likes to. | +| Name | Type | Default value | Description | +| ------ | -------- | ------------- | --------------------------------------- | +| nodeId | `string` | | Identifier of a node to apply likes to. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| ---------- | ----------------------------------------------------------------- | ------------------------------------- | | changeVote | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "vote" gets changed. | ## See also diff --git a/docs/content-services/components/permission-list.component.md b/docs/content-services/components/permission-list.component.md index f69e1e7954..5963af5d58 100644 --- a/docs/content-services/components/permission-list.component.md +++ b/docs/content-services/components/permission-list.component.md @@ -35,15 +35,15 @@ but you can also supply your own content: ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| nodeId | `string` | "" | ID of the node whose permissions you want to show. | +| Name | Type | Default value | Description | +| ------ | -------- | ------------- | -------------------------------------------------- | +| nodeId | `string` | "" | ID of the node whose permissions you want to show. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| Name | Type | Description | +| ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | | update | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PermissionElement.md)`>` | Emitted when the permission is updated. | ## Details diff --git a/docs/content-services/components/rating.component.md b/docs/content-services/components/rating.component.md index 2481a126e7..c8bc7fb26d 100644 --- a/docs/content-services/components/rating.component.md +++ b/docs/content-services/components/rating.component.md @@ -32,14 +32,14 @@ If the average is decimal number it will be rounded. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| nodeId | `string` | | Identifier of the node to apply the rating to. | +| Name | Type | Default value | Description | +| ------ | -------- | ------------- | ---------------------------------------------- | +| nodeId | `string` | | Identifier of the node to apply the rating to. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| ---------- | ----------------------------------------------------------------- | ------------------------------------- | | changeVote | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "vote" gets changed. | ## See also diff --git a/docs/content-services/components/search-chip-list.component.md b/docs/content-services/components/search-chip-list.component.md index 8adc4813ac..0a2298984d 100644 --- a/docs/content-services/components/search-chip-list.component.md +++ b/docs/content-services/components/search-chip-list.component.md @@ -22,7 +22,7 @@ Displays search criteria as a set of "chips". ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| clearAll | `boolean` | false | Flag used to enable the display of a clear-all-filters button. | -| searchFilter | [`SearchFilterComponent`](../../content-services/components/search-filter.component.md) | | Search filter to supply the data for the chips. | +| Name | Type | Default value | Description | +| ------------ | --------------------------------------------------------------------------------------- | ------------- | -------------------------------------------------------------- | +| clearAll | `boolean` | false | Flag used to enable the display of a clear-all-filters button. | +| searchFilter | [`SearchFilterComponent`](../../content-services/components/search-filter.component.md) | | Search filter to supply the data for the chips. | diff --git a/docs/content-services/components/search-control.component.md b/docs/content-services/components/search-control.component.md index 987199399c..02e5b1c63b 100644 --- a/docs/content-services/components/search-control.component.md +++ b/docs/content-services/components/search-control.component.md @@ -40,22 +40,22 @@ You can show your own custom template when no results are found for the search: ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| autocomplete | `boolean` | false | Toggles auto-completion of the search input field. | -| expandable | `boolean` | true | Toggles whether to use an expanding search control. If false then a regular input is used. | -| highlight | `boolean` | false | Toggles highlighting of the search term in the results. | -| inputType | `string` | "text" | Type of the input field to render, e.g. "search" or "text" (default). | -| liveSearchEnabled | `boolean` | true | Toggles "find-as-you-type" suggestions for possible matches. | -| liveSearchMaxResults | `number` | 5 | Maximum number of results to show in the live search. | +| Name | Type | Default value | Description | +| -------------------- | --------- | ------------- | ------------------------------------------------------------------------------------------ | +| autocomplete | `boolean` | false | Toggles auto-completion of the search input field. | +| expandable | `boolean` | true | Toggles whether to use an expanding search control. If false then a regular input is used. | +| highlight | `boolean` | false | Toggles highlighting of the search term in the results. | +| inputType | `string` | "text" | Type of the input field to render, e.g. "search" or "text" (default). | +| liveSearchEnabled | `boolean` | true | Toggles "find-as-you-type" suggestions for possible matches. | +| liveSearchMaxResults | `number` | 5 | Maximum number of results to show in the live search. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| optionClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a file item from the list of "find-as-you-type" results is selected. | -| searchChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the search term is changed. The search term is provided in the 'value' property of the returned object. If the term is less than three characters in length then it is truncated to an empty string. | -| submit | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the search is submitted by pressing the ENTER key. The search term is provided as the value of the event. | +| Name | Type | Description | +| ------------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| optionClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a file item from the list of "find-as-you-type" results is selected. | +| searchChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the search term is changed. The search term is provided in the 'value' property of the returned object. If the term is less than three characters in length then it is truncated to an empty string. | +| submit | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the search is submitted by pressing the ENTER key. The search term is provided as the value of the event. | ## Details diff --git a/docs/content-services/components/search-filter.component.md b/docs/content-services/components/search-filter.component.md index e8b911d9c6..0c42d75f48 100644 --- a/docs/content-services/components/search-filter.component.md +++ b/docs/content-services/components/search-filter.component.md @@ -194,13 +194,13 @@ The Sorting configuration section consists of two blocks: The properties of the `options` objects are as follows: -| Name | Type | Description | -| ---- | ---- | ----------- | -| key | string | Unique key to identify the entry. This can also be used to map [`DataColumn`](../../../lib/core/datatable/data/data-column.model.ts) instances. | -| label | string | Display text, which can also be an [i18n resource key](../../user-guide/internationalization.md). | -| type | string | This specifies how to order the results. It can be based on a field, based on the position of the document in the index, or by score/relevance. | -| field | string | The name of the field. | -| ascending | boolean | The sorting order defined as `true` for ascending order and `false` for descending order | +| Name | Type | Description | +| --------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | +| key | string | Unique key to identify the entry. This can also be used to map [`DataColumn`](../../../lib/core/datatable/data/data-column.model.ts) instances. | +| label | string | Display text, which can also be an [i18n resource key](../../user-guide/internationalization.md). | +| type | string | This specifies how to order the results. It can be based on a field, based on the position of the document in the index, or by score/relevance. | +| field | string | The name of the field. | +| ascending | boolean | The sorting order defined as `true` for ascending order and `false` for descending order | See the [Sort](https://docs.alfresco.com/5.2/concepts/search-api-sort.html) element in the [ACS Search API](https://docs.alfresco.com/5.2/concepts/search-api.html) @@ -239,14 +239,14 @@ The Search Filter supports a number of widgets out of the box, each implemented by an ADF component. The `selector` property specifies which [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) is used for a category: -| [`Widget`](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) name | Selector | Description | -| ------------------------------------------------------------------------------- | -------- | ----------- | -| [Check List](search-check-list.component.md) | `check-list` | Toggles individual query fragments for the search | -| [Date Range](search-date-range.component.md) | `date-range` | Specifies a range f dates that a field may contain | -| [Number Range](search-number-range.component.md) | `number-range` | Specifies a range of numeric values that a field may contain | -| [Radio List](search-radio.component.md) | `radio` | Selects one query fragment from a list of options | -| [Slider](search-slider.component.md) | `slider` | Selects a single numeric value in a given range that a field may contain | -| [Text](search-text.component.md) | `text` | Specifies a text value that a field may contain | +| [`Widget`](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) name | Selector | Description | +| ------------------------------------------------------------------------------- | -------------- | ------------------------------------------------------------------------ | +| [Check List](search-check-list.component.md) | `check-list` | Toggles individual query fragments for the search | +| [Date Range](search-date-range.component.md) | `date-range` | Specifies a range f dates that a field may contain | +| [Number Range](search-number-range.component.md) | `number-range` | Specifies a range of numeric values that a field may contain | +| [Radio List](search-radio.component.md) | `radio` | Selects one query fragment from a list of options | +| [Slider](search-slider.component.md) | `slider` | Selects a single numeric value in a given range that a field may contain | +| [Text](search-text.component.md) | `text` | Specifies a text value that a field may contain | See the individual [Search Widget](../interfaces/search-widget.interface.md) pages for full details of their usage and settings. @@ -297,15 +297,15 @@ the next block of results. #### FacetField Properties -| Name | Type | Default | Description | -| ---- | ---- | ------- | ----------- | -| field | string | | Specifies the facet field. | -| mincount | number | 1 | Specifies the minimum count required for a facet field to be included in the response. The default value is 1. | -| label | string | | Specifies the label to include in place of the facet field. | -| prefix | string | | Restricts the possible constraints to only indexed values with a specified prefix. | -| limit | number | | Maximum number of results | -| pageSize | number | 5 | Display page size | -| offset | number | | Offset position | +| Name | Type | Default | Description | +| -------- | ------ | ------- | -------------------------------------------------------------------------------------------------------------- | +| field | string | | Specifies the facet field. | +| mincount | number | 1 | Specifies the minimum count required for a facet field to be included in the response. The default value is 1. | +| label | string | | Specifies the label to include in place of the facet field. | +| prefix | string | | Restricts the possible constraints to only indexed values with a specified prefix. | +| limit | number | | Maximum number of results | +| pageSize | number | 5 | Display page size | +| offset | number | | Offset position | ### Facet Queries @@ -384,10 +384,10 @@ use overlapping ranges if necessary. #### FacetIntervals Properties -| Name | Type | Description | -| ---- | ---- | ----------- | -| intervals | array | Specifies the fields to facet by interval. | -| expanded | boolean | Toggles expanded state of the facet intervals. | +| Name | Type | Description | +| --------- | ------- | ---------------------------------------------- | +| intervals | array | Specifies the fields to facet by interval. | +| expanded | boolean | Toggles expanded state of the facet intervals. | Note: the `sets` parameter from the Search API (which sets the intervals for all fields) is not yet supported. diff --git a/docs/content-services/components/search.component.md b/docs/content-services/components/search.component.md index bf7b92ed3a..50cbda225e 100644 --- a/docs/content-services/components/search.component.md +++ b/docs/content-services/components/search.component.md @@ -34,19 +34,19 @@ Searches items for supplied search terms. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| displayWith | `Function \| null` | null | Function that maps an option's value to its display value in the trigger. | -| maxResults | `number` | 20 | Maximum number of results to show in the search. | -| searchTerm | `string` | "" | Search term to use when executing the search. Updating this value will run a new search and update the results. | -| skipResults | `number` | 0 | Number of results to skip from the results pagination. | -| classList | `void` | | CSS class for display. | +| Name | Type | Default value | Description | +| ----------- | ------------------ | ------------- | --------------------------------------------------------------------------------------------------------------- | +| displayWith | `Function \| null` | null | Function that maps an option's value to its display value in the trigger. | +| maxResults | `number` | 20 | Maximum number of results to show in the search. | +| searchTerm | `string` | "" | Search term to use when executing the search. Updating this value will run a new search and update the results. | +| skipResults | `number` | 0 | Number of results to skip from the results pagination. | +| classList | `void` | | CSS class for display. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| Name | Type | Description | +| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | | resultLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` | Emitted when search results have fully loaded. | ## Details diff --git a/docs/content-services/components/sites-dropdown.component.md b/docs/content-services/components/sites-dropdown.component.md index 1c558b8c7e..b4451bea6d 100644 --- a/docs/content-services/components/sites-dropdown.component.md +++ b/docs/content-services/components/sites-dropdown.component.md @@ -23,16 +23,16 @@ Displays a dropdown menu to show and interact with the sites of the current user ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| hideMyFiles | `boolean` | false | Hide the "My Files" option. | -| placeholder | `string` | | Text or a translation key to act as a placeholder. Default value is the key "DROPDOWN.PLACEHOLDER_LABEL". | -| relations | `string` | | Filter for the results of the sites query. Possible values are "members" and "containers". When "members" is used, the site list will be restricted to the sites that the user is a member of. | -| siteList | [`SitePaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md) | null | A custom list of sites to be displayed by the dropdown. If no value is given, the sites of the current user are displayed by default. A list of objects only with properties 'title' and 'guid' is enough to be able to display the dropdown. | -| value | `string` | null | Id of the selected site | +| Name | Type | Default value | Description | +| ----------- | --------------------------------------------------------------------------------------------------------------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| hideMyFiles | `boolean` | false | Hide the "My Files" option. | +| placeholder | `string` | | Text or a translation key to act as a placeholder. Default value is the key "DROPDOWN.PLACEHOLDER_LABEL". | +| relations | `string` | | Filter for the results of the sites query. Possible values are "members" and "containers". When "members" is used, the site list will be restricted to the sites that the user is a member of. | +| siteList | [`SitePaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md) | null | A custom list of sites to be displayed by the dropdown. If no value is given, the sites of the current user are displayed by default. A list of objects only with properties 'title' and 'guid' is enough to be able to display the dropdown. | +| value | `string` | null | Id of the selected site | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | | change | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`>` | Emitted when the user selects a site. When the default option is selected, an empty model is emitted. | diff --git a/docs/content-services/components/tag-actions.component.md b/docs/content-services/components/tag-actions.component.md index 78dbc778e3..66515603ab 100644 --- a/docs/content-services/components/tag-actions.component.md +++ b/docs/content-services/components/tag-actions.component.md @@ -23,14 +23,14 @@ Shows available actions for tags. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| nodeId | `string` | | The identifier of a node. | +| Name | Type | Default value | Description | +| ------ | -------- | ------------- | ------------------------- | +| nodeId | `string` | | The identifier of a node. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| result | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an action is chosen. | +| Name | Type | Description | +| ---------- | ----------------------------------------------------------------- | ----------------------------------------- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| result | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an action is chosen. | | successAdd | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a tag is added successfully. | diff --git a/docs/content-services/components/tag-list.component.md b/docs/content-services/components/tag-list.component.md index 3e4fe204e3..94cc36d920 100644 --- a/docs/content-services/components/tag-list.component.md +++ b/docs/content-services/components/tag-list.component.md @@ -15,8 +15,8 @@ Shows tags for an item. ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| ------ | ----------------------------------------------------------------- | ------------------------------- | | result | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a tag is selected. | ## See Also diff --git a/docs/content-services/components/tag-node-list.component.md b/docs/content-services/components/tag-node-list.component.md index b5aafc72ef..9e2fe3cb77 100644 --- a/docs/content-services/components/tag-node-list.component.md +++ b/docs/content-services/components/tag-node-list.component.md @@ -23,13 +23,13 @@ Shows tags for a node. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| nodeId | `string` | | The identifier of a node. | -| showDelete | `boolean` | true | Show delete button | +| Name | Type | Default value | Description | +| ---------- | --------- | ------------- | ------------------------- | +| nodeId | `string` | | The identifier of a node. | +| showDelete | `boolean` | true | Show delete button | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| ------- | ----------------------------------------------------------------- | ------------------------------- | | results | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a tag is selected. | diff --git a/docs/content-services/components/tree-view.component.md b/docs/content-services/components/tree-view.component.md index c9bf0f7fd4..b0ca5ec392 100644 --- a/docs/content-services/components/tree-view.component.md +++ b/docs/content-services/components/tree-view.component.md @@ -23,13 +23,13 @@ Shows the folder and subfolders of a node as a tree view. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| nodeId | `string` | | Identifier of the node to display. | +| Name | Type | Default value | Description | +| ------ | -------- | ------------- | ---------------------------------- | +| nodeId | `string` | | Identifier of the node to display. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an invalid node id is given. | +| Name | Type | Description | +| ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an invalid node id is given. | | nodeClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` | Emitted when a node in the tree view is clicked. | diff --git a/docs/content-services/components/upload-button.component.md b/docs/content-services/components/upload-button.component.md index c74ed62492..5bf296b61b 100644 --- a/docs/content-services/components/upload-button.component.md +++ b/docs/content-services/components/upload-button.component.md @@ -27,31 +27,31 @@ Activates a file upload. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| acceptedFilesType | `string` | "\*" | Filter for accepted file types. | -| comment | `string` | | When you overwrite existing content, you can use the comment field to add a version comment that appears in the version history | -| disabled | `boolean` | false | Toggles component disabled state (if there is no node permission checking). | -| file | `File` | | Custom added file. The upload button type will be 'button' instead of 'file' | -| majorVersion | `boolean` | false | majorVersion boolean field to true to indicate a major version should be created. | -| maxFilesSize | `number` | | Sets a limit on the maximum size (in bytes) of a file to be uploaded. Has no effect if undefined. | -| multipleFiles | `boolean` | false | Allows/disallows multiple files | -| nodeType | `string` | "cm:content" | Custom node type for uploaded file | -| rootFolderId | `string` | "-root-" | The ID of the root. Use the nodeId for Content Services or the taskId/processId for Process Services. | -| staticTitle | `string` | | Defines the text of the upload button. | -| tooltip | `string` | null | Custom tooltip text. | -| uploadFolders | `boolean` | false | Allows/disallows upload folders (only for Chrome). | -| versioning | `boolean` | false | Toggles versioning. | +| Name | Type | Default value | Description | +| ----------------- | --------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------- | +| acceptedFilesType | `string` | "\*" | Filter for accepted file types. | +| comment | `string` | | When you overwrite existing content, you can use the comment field to add a version comment that appears in the version history | +| disabled | `boolean` | false | Toggles component disabled state (if there is no node permission checking). | +| file | `File` | | Custom added file. The upload button type will be 'button' instead of 'file' | +| majorVersion | `boolean` | false | majorVersion boolean field to true to indicate a major version should be created. | +| maxFilesSize | `number` | | Sets a limit on the maximum size (in bytes) of a file to be uploaded. Has no effect if undefined. | +| multipleFiles | `boolean` | false | Allows/disallows multiple files | +| nodeType | `string` | "cm:content" | Custom node type for uploaded file | +| rootFolderId | `string` | "-root-" | The ID of the root. Use the nodeId for Content Services or the taskId/processId for Process Services. | +| staticTitle | `string` | | Defines the text of the upload button. | +| tooltip | `string` | null | Custom tooltip text. | +| uploadFolders | `boolean` | false | Allows/disallows upload folders (only for Chrome). | +| versioning | `boolean` | false | Toggles versioning. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../../lib/content-services/src/lib/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PermissionModel`](../../../lib/content-services/src/lib/document-list/models/permissions.model.ts)`>` | Emitted when create permission is missing. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the file is uploaded successfully. | -| updateFileVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`>` | Emitted when dropping a file over another file to update the version. | +| Name | Type | Description | +| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | +| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../../lib/content-services/src/lib/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PermissionModel`](../../../lib/content-services/src/lib/document-list/models/permissions.model.ts)`>` | Emitted when create permission is missing. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the file is uploaded successfully. | +| updateFileVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`>` | Emitted when dropping a file over another file to update the version. | ## Details diff --git a/docs/content-services/components/upload-drag-area.component.md b/docs/content-services/components/upload-drag-area.component.md index 0ac2010f09..1e27528df0 100644 --- a/docs/content-services/components/upload-drag-area.component.md +++ b/docs/content-services/components/upload-drag-area.component.md @@ -59,25 +59,25 @@ as the drag/drop target: ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| acceptedFilesType | `string` | "\*" | Filter for accepted file types. | -| comment | `string` | | When you overwrite existing content, you can use the comment field to add a version comment that appears in the version history | -| disabled | `boolean` | false | Toggles component disabled state (if there is no node permission checking). | -| majorVersion | `boolean` | false | majorVersion boolean field to true to indicate a major version should be created. | -| maxFilesSize | `number` | | Sets a limit on the maximum size (in bytes) of a file to be uploaded. Has no effect if undefined. | -| nodeType | `string` | "cm:content" | Custom node type for uploaded file | -| rootFolderId | `string` | "-root-" | The ID of the root. Use the nodeId for Content Services or the taskId/processId for Process Services. | -| versioning | `boolean` | false | Toggles versioning. | +| Name | Type | Default value | Description | +| ----------------- | --------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------- | +| acceptedFilesType | `string` | "\*" | Filter for accepted file types. | +| comment | `string` | | When you overwrite existing content, you can use the comment field to add a version comment that appears in the version history | +| disabled | `boolean` | false | Toggles component disabled state (if there is no node permission checking). | +| majorVersion | `boolean` | false | majorVersion boolean field to true to indicate a major version should be created. | +| maxFilesSize | `number` | | Sets a limit on the maximum size (in bytes) of a file to be uploaded. Has no effect if undefined. | +| nodeType | `string` | "cm:content" | Custom node type for uploaded file | +| rootFolderId | `string` | "-root-" | The ID of the root. Use the nodeId for Content Services or the taskId/processId for Process Services. | +| versioning | `boolean` | false | Toggles versioning. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../../lib/content-services/src/lib/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the file is uploaded successfully. | -| updateFileVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`>` | Emitted when dropping a file over another file to update the version. | +| Name | Type | Description | +| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | +| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../../lib/content-services/src/lib/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the file is uploaded successfully. | +| updateFileVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`>` | Emitted when dropping a file over another file to update the version. | ## Details diff --git a/docs/content-services/components/upload-version-button.component.md b/docs/content-services/components/upload-version-button.component.md index 42717cc660..c4f3a127dc 100644 --- a/docs/content-services/components/upload-version-button.component.md +++ b/docs/content-services/components/upload-version-button.component.md @@ -29,32 +29,32 @@ to enrich the features and decrease the restrictions currently applied to node v ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| acceptedFilesType | `string` | "\*" | Filter for accepted file types. | -| comment | `string` | | When you overwrite existing content, you can use the comment field to add a version comment that appears in the version history | -| disabled | `boolean` | false | Toggles component disabled state (if there is no node permission checking). | -| file | `File` | | Custom added file. The upload button type will be 'button' instead of 'file' | -| majorVersion | `boolean` | false | majorVersion boolean field to true to indicate a major version should be created. | -| maxFilesSize | `number` | | Sets a limit on the maximum size (in bytes) of a file to be uploaded. Has no effect if undefined. | -| multipleFiles | `boolean` | false | Allows/disallows multiple files | -| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | (**Required**) The node to be versioned. | -| nodeType | `string` | "cm:content" | Custom node type for uploaded file | -| rootFolderId | `string` | "-root-" | The ID of the root. Use the nodeId for Content Services or the taskId/processId for Process Services. | -| staticTitle | `string` | | Defines the text of the upload button. | -| tooltip | `string` | null | Custom tooltip text. | -| uploadFolders | `boolean` | false | Allows/disallows upload folders (only for Chrome). | -| versioning | `boolean` | false | Toggles versioning. | +| Name | Type | Default value | Description | +| ----------------- | -------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------- | +| acceptedFilesType | `string` | "\*" | Filter for accepted file types. | +| comment | `string` | | When you overwrite existing content, you can use the comment field to add a version comment that appears in the version history | +| disabled | `boolean` | false | Toggles component disabled state (if there is no node permission checking). | +| file | `File` | | Custom added file. The upload button type will be 'button' instead of 'file' | +| majorVersion | `boolean` | false | majorVersion boolean field to true to indicate a major version should be created. | +| maxFilesSize | `number` | | Sets a limit on the maximum size (in bytes) of a file to be uploaded. Has no effect if undefined. | +| multipleFiles | `boolean` | false | Allows/disallows multiple files | +| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | (**Required**) The node to be versioned. | +| nodeType | `string` | "cm:content" | Custom node type for uploaded file | +| rootFolderId | `string` | "-root-" | The ID of the root. Use the nodeId for Content Services or the taskId/processId for Process Services. | +| staticTitle | `string` | | Defines the text of the upload button. | +| tooltip | `string` | null | Custom tooltip text. | +| uploadFolders | `boolean` | false | Allows/disallows upload folders (only for Chrome). | +| versioning | `boolean` | false | Toggles versioning. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../../lib/content-services/src/lib/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PermissionModel`](../../../lib/content-services/src/lib/document-list/models/permissions.model.ts)`>` | Emitted when create permission is missing. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the file is uploaded successfully. | -| updateFileVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`>` | Emitted when dropping a file over another file to update the version. | +| Name | Type | Description | +| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | +| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../../lib/content-services/src/lib/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PermissionModel`](../../../lib/content-services/src/lib/document-list/models/permissions.model.ts)`>` | Emitted when create permission is missing. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the file is uploaded successfully. | +| updateFileVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`>` | Emitted when dropping a file over another file to update the version. | ## Details diff --git a/docs/content-services/components/version-comparison.component.md b/docs/content-services/components/version-comparison.component.md index cf96a4744b..9f96219c59 100644 --- a/docs/content-services/components/version-comparison.component.md +++ b/docs/content-services/components/version-comparison.component.md @@ -24,7 +24,7 @@ Displays the side by side comparison between the current target node (type, name ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| newFileVersion | `File` | | New file for updating current version. | -| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | Target node. | +| Name | Type | Default value | Description | +| -------------- | -------------------------------------------------------------------------------------------------------- | ------------- | -------------------------------------- | +| newFileVersion | `File` | | New file for updating current version. | +| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | Target node. | diff --git a/docs/content-services/components/version-list.component.md b/docs/content-services/components/version-list.component.md index 9c59986a97..69cafb70d8 100644 --- a/docs/content-services/components/version-list.component.md +++ b/docs/content-services/components/version-list.component.md @@ -19,21 +19,21 @@ Displays the version history of a node in a [Version Manager component](version- ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| allowDownload | `boolean` | true | Enable/disable downloading a version of the current node. | -| allowViewVersions | `boolean` | true | Enable/disable viewing a version of the current node. | -| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | The target node. | -| showActions | `boolean` | true | Toggles showing/hiding of version actions | -| showComments | `boolean` | true | Toggles showing/hiding of comments | +| Name | Type | Default value | Description | +| ----------------- | -------------------------------------------------------------------------------------------------------- | ------------- | --------------------------------------------------------- | +| allowDownload | `boolean` | true | Enable/disable downloading a version of the current node. | +| allowViewVersions | `boolean` | true | Enable/disable viewing a version of the current node. | +| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | The target node. | +| showActions | `boolean` | true | Toggles showing/hiding of version actions | +| showComments | `boolean` | true | Toggles showing/hiding of comments | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| deleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when a version is deleted | -| restored | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when a version is restored | -| viewVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when viewing a version | +| Name | Type | Description | +| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------- | +| deleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when a version is deleted | +| restored | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when a version is restored | +| viewVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when viewing a version | ## Details diff --git a/docs/content-services/components/version-manager.component.md b/docs/content-services/components/version-manager.component.md index 8e4ff4136f..bf97e16285 100644 --- a/docs/content-services/components/version-manager.component.md +++ b/docs/content-services/components/version-manager.component.md @@ -27,22 +27,22 @@ Displays the version history of a node with the ability to upload a new version. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| allowDownload | `boolean` | true | Enable/disable downloading a version of the current node. | -| newFileVersion | `File` | | New file for updating current version. | -| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | Target node to manage version history. | -| showComments | `boolean` | true | Toggles showing/hiding of comments. | -| showVersionComparison | `boolean` | false | Toggles showing/hiding the [version comparison component](../../content-services/components/version-comparison.component.md). | +| Name | Type | Default value | Description | +| --------------------- | -------------------------------------------------------------------------------------------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------- | +| allowDownload | `boolean` | true | Enable/disable downloading a version of the current node. | +| newFileVersion | `File` | | New file for updating current version. | +| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | Target node to manage version history. | +| showComments | `boolean` | true | Toggles showing/hiding of comments. | +| showVersionComparison | `boolean` | false | Toggles showing/hiding the [version comparison component](../../content-services/components/version-comparison.component.md). | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| uploadCancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an cancelling during upload. | -| uploadError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when an error occurs during upload. | +| Name | Type | Description | +| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------- | +| uploadCancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an cancelling during upload. | +| uploadError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when an error occurs during upload. | | uploadSuccess | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when a file is uploaded successfully. | -| viewVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when viewing a version. | +| viewVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when viewing a version. | ## Details @@ -50,9 +50,9 @@ Displays the version history of a node with the ability to upload a new version. Each version has a context menu on the right, with the following actions. -| Action | Versions | Description | -| ------ | -------- | ----------- | -| Restore | All | Revert the current version to the selected one with creating a new version of it. | +| Action | Versions | Description | +| ------- | -------- | --------------------------------------------------------------------------------- | +| Restore | All | Revert the current version to the selected one with creating a new version of it. | ## See also diff --git a/docs/content-services/components/webscript.component.md b/docs/content-services/components/webscript.component.md index 78ae5356c3..be7d65f4aa 100644 --- a/docs/content-services/components/webscript.component.md +++ b/docs/content-services/components/webscript.component.md @@ -62,19 +62,19 @@ export class AppComponent { ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| contentType | `string` | "TEXT" | Content type to interpret the data received from the webscript. Can be "JSON" , "HTML" , "DATATABLE" or "TEXT" | -| contextRoot | `string` | "alfresco" | Path where the application is deployed | -| scriptArgs | `any` | | Arguments to pass to the webscript. | -| scriptPath | `string` | | (required) Path to the webscript (as defined by webscript). | -| servicePath | `string` | "service" | Path that the webscript service is mapped to. | -| showData | `boolean` | true | Toggles whether to show or hide the data. | +| Name | Type | Default value | Description | +| ----------- | --------- | ------------- | -------------------------------------------------------------------------------------------------------------- | +| contentType | `string` | "TEXT" | Content type to interpret the data received from the webscript. Can be "JSON" , "HTML" , "DATATABLE" or "TEXT" | +| contextRoot | `string` | "alfresco" | Path where the application is deployed | +| scriptArgs | `any` | | Arguments to pass to the webscript. | +| scriptPath | `string` | | (required) Path to the webscript (as defined by webscript). | +| servicePath | `string` | "service" | Path that the webscript service is mapped to. | +| showData | `boolean` | true | Toggles whether to show or hide the data. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| ------- | ----------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the operation succeeds. You can get the plain data from the webscript through the **success** event parameter and use it as you need in your application. | ## Details diff --git a/docs/content-services/dialogs/library.dialog.md b/docs/content-services/dialogs/library.dialog.md index 03e2dea6a1..c35678433b 100644 --- a/docs/content-services/dialogs/library.dialog.md +++ b/docs/content-services/dialogs/library.dialog.md @@ -25,9 +25,9 @@ Creates a new Content Services document library/site. ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| Name | Type | Description | +| ------- | ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the new library is created successfully. The event parameter is a [SiteEntry](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md) object with the details of the newly-created library. | ## Details diff --git a/docs/content-services/directives/content-node-share.directive.md b/docs/content-services/directives/content-node-share.directive.md index 6dca220830..03baabd13f 100644 --- a/docs/content-services/directives/content-node-share.directive.md +++ b/docs/content-services/directives/content-node-share.directive.md @@ -33,10 +33,10 @@ Creates and manages public shared links for files. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| baseShareUrl | `string` | | Prefix to add to the generated link. | -| node | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) | | [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to share. | +| Name | Type | Default value | Description | +| ------------ | ------------------------------------------------------------------------------------------------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------- | +| baseShareUrl | `string` | | Prefix to add to the generated link. | +| node | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) | | [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to share. | ## Details diff --git a/docs/content-services/directives/file-draggable.directive.md b/docs/content-services/directives/file-draggable.directive.md index 32bc85af3f..6dee9418bb 100644 --- a/docs/content-services/directives/file-draggable.directive.md +++ b/docs/content-services/directives/file-draggable.directive.md @@ -38,16 +38,16 @@ Some sample CSS to show the drag and drop area: ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| enabled | `boolean` | true | Enables/disables drag-and-drop functionality. | +| Name | Type | Default value | Description | +| ------- | --------- | ------------- | --------------------------------------------- | +| enabled | `boolean` | true | Enables/disables drag-and-drop functionality. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| filesDropped | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when one or more files are dragged and dropped onto the draggable element. | -| folderEntityDropped | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a directory is dragged and dropped onto the draggable element. | +| Name | Type | Description | +| ------------------- | -------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| filesDropped | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when one or more files are dragged and dropped onto the draggable element. | +| folderEntityDropped | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a directory is dragged and dropped onto the draggable element. | ## Details diff --git a/docs/content-services/directives/folder-create.directive.md b/docs/content-services/directives/folder-create.directive.md index 779c43ae02..84ba995213 100644 --- a/docs/content-services/directives/folder-create.directive.md +++ b/docs/content-services/directives/folder-create.directive.md @@ -30,18 +30,18 @@ Creates folders. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| nodeType | `string` | "cm:folder" | Type of node to create. | -| parentNodeId | `string` | | Parent folder where the new folder will be located after creation. | -| title | `string` | null | Title of folder creation dialog. | +| Name | Type | Default value | Description | +| ------------ | -------- | ------------- | ------------------------------------------------------------------ | +| nodeType | `string` | "cm:folder" | Type of node to create. | +| parentNodeId | `string` | | Parent folder where the new folder will be located after creation. | +| title | `string` | null | Title of folder creation dialog. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs (eg, a folder with same name already exists). | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when the folder is created successfully. | +| Name | Type | Description | +| ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs (eg, a folder with same name already exists). | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when the folder is created successfully. | ## Details diff --git a/docs/content-services/directives/folder-edit.directive.md b/docs/content-services/directives/folder-edit.directive.md index 921bf19e23..8ce868cc99 100644 --- a/docs/content-services/directives/folder-edit.directive.md +++ b/docs/content-services/directives/folder-edit.directive.md @@ -30,17 +30,17 @@ Allows folders to be edited. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| folder | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | Folder node to edit. | -| title | `string` | null | Title of folder edit dialog. | +| Name | Type | Default value | Description | +| ------ | -------------------------------------------------------------------------------------------------------- | ------------- | ---------------------------- | +| folder | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | Folder node to edit. | +| title | `string` | null | Title of folder edit dialog. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs (eg, a folder with same name already exists). | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when the folder has been edited successfully. | +| Name | Type | Description | +| ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs (eg, a folder with same name already exists). | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when the folder has been edited successfully. | ## Details diff --git a/docs/content-services/directives/inherited-button.directive.md b/docs/content-services/directives/inherited-button.directive.md index 310f8065f2..8d1347343d 100644 --- a/docs/content-services/directives/inherited-button.directive.md +++ b/docs/content-services/directives/inherited-button.directive.md @@ -22,15 +22,15 @@ Update the current node by adding/removing the inherited permissions. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| nodeId | `string` | | ID of the node to add/remove inherited permissions. | +| Name | Type | Default value | Description | +| ------ | -------- | ------------- | --------------------------------------------------- | +| nodeId | `string` | | ID of the node to add/remove inherited permissions. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| Name | Type | Description | +| ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | | updated | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when the node is updated. | ## Details diff --git a/docs/content-services/directives/node-lock.directive.md b/docs/content-services/directives/node-lock.directive.md index 5e47a818f4..7768fbac2f 100644 --- a/docs/content-services/directives/node-lock.directive.md +++ b/docs/content-services/directives/node-lock.directive.md @@ -21,9 +21,9 @@ Locks or unlocks a node. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to lock/unlock. | +| Name | Type | Default value | Description | +| ---- | -------------------------------------------------------------------------------------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------- | +| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to lock/unlock. | ## Details diff --git a/docs/content-services/interfaces/search-widget.interface.md b/docs/content-services/interfaces/search-widget.interface.md index 6c6f9a189c..333184f999 100644 --- a/docs/content-services/interfaces/search-widget.interface.md +++ b/docs/content-services/interfaces/search-widget.interface.md @@ -32,11 +32,11 @@ export interface SearchWidget { ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| id | `string` | | Unique identifying value for the [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) | -| settings | [`SearchWidgetSettings`](../../../lib/content-services/src/lib/search/search-widget-settings.interface.ts) | | Settings for component properties | -| context | [`SearchQueryBuilderService`](../../content-services/services/search-query-builder.service.md) | | Instance of the [Search Query Builder service](../services/search-query-builder.service.md) to process the query | +| Name | Type | Default value | Description | +| -------- | ---------------------------------------------------------------------------------------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------- | +| id | `string` | | Unique identifying value for the [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) | +| settings | [`SearchWidgetSettings`](../../../lib/content-services/src/lib/search/search-widget-settings.interface.ts) | | Settings for component properties | +| context | [`SearchQueryBuilderService`](../../content-services/services/search-query-builder.service.md) | | Instance of the [Search Query Builder service](../services/search-query-builder.service.md) to process the query | ## Details diff --git a/docs/content-services/models/permissions-style.model.md b/docs/content-services/models/permissions-style.model.md index c4e72b9d68..e3406e89cb 100644 --- a/docs/content-services/models/permissions-style.model.md +++ b/docs/content-services/models/permissions-style.model.md @@ -13,12 +13,12 @@ Sets custom CSS styles for rows of a Document List according to the item's permi ### Properties -| [`Property`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/property.ts) | Type | Description | -| ----------------------------------------------------------------------------------------------- | ---- | ----------- | -| isFile | boolean | Does this style apply to files? | -| isFolder | boolean | Does this style apply to folders? | -| permission | Permissions | An enum value defining the permissions that this style applies to (see below) | -| css | string | The name of the CSS class to add | +| [`Property`](../../../lib/content-services/src/lib/content-metadata/interfaces/property.interface.ts) | Type | Description | +| ----------------------------------------------------------------------------------------------------- | ----------- | ----------------------------------------------------------------------------- | +| isFile | boolean | Does this style apply to files? | +| isFolder | boolean | Does this style apply to folders? | +| permission | Permissions | An enum value defining the permissions that this style applies to (see below) | +| css | string | The name of the CSS class to add | ## Details diff --git a/docs/content-services/services/audit.service.md b/docs/content-services/services/audit.service.md index ab34a4fed7..bf64ad0e40 100644 --- a/docs/content-services/services/audit.service.md +++ b/docs/content-services/services/audit.service.md @@ -13,45 +13,44 @@ Manages Audit apps and entries. ### Methods -- **getAuditApps**(opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditAppPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/AuditAppPaging.md)`>`
- List audit applications. - - _opts:_ `any` - (Optional) Options. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditAppPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/AuditAppPaging.md)`>` - Target Audit Apps. -- **getAuditApp**(auditApplicationId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditAppEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/AuditAppEntry.md)`>`
- Get audit application info. - - _auditApplicationId:_ `string` - The identifier of an audit application. - - _opts:_ `any` - (Optional) Options. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditAppEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/AuditAppEntry.md)`>` - Target Audit App. -- **updateAuditApp**(auditApplicationId: `string`, auditAppBodyUpdate: `boolean`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditApp`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/AuditApp.md)` | {}>`
- Update audit application info. - - _auditApplicationId:_ `string` - The identifier of an audit application. - - _auditAppBodyUpdate:_ `boolean` - The audit application to update. - - _opts:_ `any` - (Optional) Options. - - **Returns** - Information about audit application that were updated -- **getAuditEntries**(auditApplicationId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditEntryPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/AuditEntryPaging.md)`>`
- List audit entries for an audit application. - - _auditApplicationId:_ `string` - The identifier of an audit application. - - _opts:_ `any` - (Optional) Options. - - **Returns** - A list of audit entries for audit application. -- **getAuditEntry**(auditApplicationId: `string`, auditEntryId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditEntryEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/AuditEntryEntry.md)`>`
- Get audit entry. - - _auditApplicationId:_ `string` - The identifier of an audit application. - - _auditEntryId:_ `string` - The identifier of an audit entry. - - _opts:_ `any` - (Optional) Options. - - **Returns** - Targe audit entry. -- **getAuditEntriesForNode**(nodeId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditEntryPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/AuditEntryPaging.md)`>`
- List audit entries for a node. - - _nodeId:_ `string` - The identifier of a node. - - _opts:_ `any` - (Optional) Options. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditEntryPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/AuditEntryPaging.md)`>` - A list of audit entries for node. - **deleteAuditEntries**(auditApplicationId: `string`, where: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Permanently delete audit entries for an audit application. - _auditApplicationId:_ `string` - The identifier of an audit application. - _where:_ `string` - Audit entries to permanently delete for an audit application, given an inclusive time period or range of ids. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - empty response body + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - - **deleteAuditEntry**(auditApplicationId: `string`, auditEntryId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Permanently delete an audit entry. - - _auditApplicationId:_ `string` - The identifier of an audit application. - - _auditEntryId:_ `string` - The identifier of an audit entry. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - empty response body - + - _auditApplicationId:_ `string` - The identifier of an audit application. + - _auditEntryId:_ `string` - The identifier of an audit entry. + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - +- **getAuditApp**(auditApplicationId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditAppEntry`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditAppEntry.ts)`>`
+ Get audit application info. + - _auditApplicationId:_ `string` - The identifier of an audit application. + - _opts:_ `any` - (Optional) (Optional) (Optional) Options. + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditAppEntry`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditAppEntry.ts)`>` - +- **getAuditApps**(opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditAppPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditAppPaging.ts)`>`
+ List audit applications. + - _opts:_ `any` - (Optional) (Optional) (Optional) Options. + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditAppPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditAppPaging.ts)`>` - +- **getAuditEntries**(auditApplicationId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditEntryPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditEntryPaging.ts)`>`
+ List audit entries for an audit application. + - _auditApplicationId:_ `string` - The identifier of an audit application. + - _opts:_ `any` - (Optional) (Optional) (Optional) Options. + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditEntryPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditEntryPaging.ts)`>` - +- **getAuditEntriesForNode**(nodeId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditEntryPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditEntryPaging.ts)`>`
+ List audit entries for a node. + - _nodeId:_ `string` - The identifier of a node. + - _opts:_ `any` - (Optional) (Optional) (Optional) Options. + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditEntryPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditEntryPaging.ts)`>` - +- **getAuditEntry**(auditApplicationId: `string`, auditEntryId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditEntryEntry`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditEntryEntry.ts)`>`
+ Get audit entry. + - _auditApplicationId:_ `string` - The identifier of an audit application. + - _auditEntryId:_ `string` - The identifier of an audit entry. + - _opts:_ `any` - (Optional) (Optional) (Optional) Options. + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditEntryEntry`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditEntryEntry.ts)`>` - +- **updateAuditApp**(auditApplicationId: `string`, auditAppBodyUpdate: `boolean`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditApp`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditApp.ts)`|Function>`
+ Update audit application info. + - _auditApplicationId:_ `string` - The identifier of an audit application. + - _auditAppBodyUpdate:_ `boolean` - The audit application to update. + - _opts:_ `any` - (Optional) (Optional) (Optional) Options. + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditApp`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditApp.ts)`|Function>` - diff --git a/docs/content-services/services/content-node-dialog.service.md b/docs/content-services/services/content-node-dialog.service.md index 5677f759e6..eac9c8136d 100644 --- a/docs/content-services/services/content-node-dialog.service.md +++ b/docs/content-services/services/content-node-dialog.service.md @@ -27,6 +27,9 @@ Displays and manages dialogs for selecting content to open, copy or upload. - _permission:_ `string` - (Optional) Permission for the operation - _excludeSiteContent:_ `string[]` - (Optional) The site content that should be filtered out - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about files that were copied/moved +- **openFileBrowseDialogByDefaultLocation**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`
+ Opens a file browser at a default myFile location. shows files and folders in the dialog search result. + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the selected file(s) - **openFileBrowseDialogByFolderId**(folderNodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`
Opens a file browser at a chosen folder location. shows files and folders in the dialog search result. - _folderNodeId:_ `string` - ID of the folder to use diff --git a/docs/content-services/services/document-list.service.md b/docs/content-services/services/document-list.service.md index eabee1fd88..792e49fc49 100644 --- a/docs/content-services/services/document-list.service.md +++ b/docs/content-services/services/document-list.service.md @@ -42,7 +42,6 @@ Implements node operations used by the [Document List component](../components/d - _nodeId:_ `any` - - **Returns** `boolean` - - - **loadFolderByNodeId**(nodeId: `string`, pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), includeFields: `string[]`, where?: `string`, orderBy?: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DocumentLoaderNode`](../../../lib/content-services/src/lib/document-list/models/document-folder.model.ts)`>`
Load a folder by Node Id. - _nodeId:_ `string` - ID of the folder node diff --git a/docs/content-services/services/rating.service.md b/docs/content-services/services/rating.service.md index a3abcf6e0d..9bffc82364 100644 --- a/docs/content-services/services/rating.service.md +++ b/docs/content-services/services/rating.service.md @@ -18,17 +18,17 @@ Manages ratings for items in Content Services. - _nodeId:_ `string` - Target node - _ratingType:_ `any` - Type of rating to remove (can be "likes" or "fiveStar") - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null response indicating that the operation is complete -- **getRating**(nodeId: `string`, ratingType: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RatingEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/RatingEntry.md)`|__type>`
+- **getRating**(nodeId: `string`, ratingType: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RatingEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/RatingEntry.md)`|Function>`
Gets the current user's rating for a node. - _nodeId:_ `string` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to get the rating from - _ratingType:_ `any` - Type of rating (can be "likes" or "fiveStar") - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RatingEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/RatingEntry.md)`|__type>` - The rating value -- **postRating**(nodeId: `string`, ratingType: `string`, vote: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RatingEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/RatingEntry.md)`|__type>`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RatingEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/RatingEntry.md)`|Function>` - The rating value +- **postRating**(nodeId: `string`, ratingType: `string`, vote: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RatingEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/RatingEntry.md)`|Function>`
Adds the current user's rating for a node. - _nodeId:_ `string` - Target node for the rating - _ratingType:_ `string` - Type of rating (can be "likes" or "fiveStar") - _vote:_ `any` - Rating value (boolean for "likes", numeric 0..5 for "fiveStar") - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RatingEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/RatingEntry.md)`|__type>` - Details about the rating, including the new value + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RatingEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/RatingEntry.md)`|Function>` - Details about the rating, including the new value ## Details diff --git a/docs/content-services/services/search-query-builder.service.md b/docs/content-services/services/search-query-builder.service.md index 02d9e565d7..89b1123368 100644 --- a/docs/content-services/services/search-query-builder.service.md +++ b/docs/content-services/services/search-query-builder.service.md @@ -23,8 +23,9 @@ Stores information from all the custom search and faceted search widgets, compil - **buildQuery**(): `QueryBody`
Builds the current query. - **Returns** `QueryBody` - The finished query -- **execute**()
+- **execute**(queryBody?: `QueryBody`)
Builds and executes the current query. + - _queryBody:_ `QueryBody` - (Optional) (Optional) - **getFacetField**(label: `string`): [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts)
Gets a facet field by label. - _label:_ `string` - Label of the facet field @@ -54,11 +55,9 @@ Stores information from all the custom search and faceted search widgets, compil - **isFilterServiceActive**(): `boolean`
- **Returns** `boolean` - - - **loadConfiguration**(): [`SearchConfiguration`](../../../lib/content-services/src/lib/search/search-configuration.interface.ts)
- **Returns** [`SearchConfiguration`](../../../lib/content-services/src/lib/search/search-configuration.interface.ts) - - - **removeFilterQuery**(query: `string`)
Removes an existing filter query. - _query:_ `string` - The query to remove @@ -67,9 +66,13 @@ Stores information from all the custom search and faceted search widgets, compil - _field:_ [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts) - The target field - _bucket:_ [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts) - Bucket to remove - **resetToDefaults**()
+- **search**(queryBody: `QueryBody`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ResultSetPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/search-rest-api/docs/ResultSetPaging.md)`>`
-- **update**()
+ - _queryBody:_ `QueryBody` - + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ResultSetPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/search-rest-api/docs/ResultSetPaging.md)`>` - +- **update**(queryBody?: `QueryBody`)
Builds the current query and triggers the `updated` event. + - _queryBody:_ `QueryBody` - (Optional) (Optional) ## Details diff --git a/docs/core/components/card-view.component.md b/docs/core/components/card-view.component.md index 72e55c7756..1780139528 100644 --- a/docs/core/components/card-view.component.md +++ b/docs/core/components/card-view.component.md @@ -106,16 +106,16 @@ Defining properties from Typescript: ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| copyToClipboardAction | `boolean` | true | Toggles whether or not to enable copy to clipboard action. | -| displayClearAction | `boolean` | true | Toggles whether or not to display clear action. | -| displayEmpty | `boolean` | true | Toggles whether or not to show empty items in non-editable mode. | -| displayNoneOption | `boolean` | true | Toggles whether or not to display none option. | -| editable | `boolean` | | Toggles whether or not the items can be edited. | -| multiValueSeparator | `string` | DEFAULT_SEPARATOR | String separator between multi-value property items. | -| properties | [`CardViewItem`](../../../lib/core/card-view/interfaces/card-view-item.interface.ts)`[]` | | (**required**) Items to show in the card view. | -| useChipsForMultiValueProperty | `boolean` | true | Toggles whether or not to enable chips for multivalued properties. | +| Name | Type | Default value | Description | +| ----------------------------- | ---------------------------------------------------------------------------------------- | ----------------- | ------------------------------------------------------------------ | +| copyToClipboardAction | `boolean` | true | Toggles whether or not to enable copy to clipboard action. | +| displayClearAction | `boolean` | true | Toggles whether or not to display clear action. | +| displayEmpty | `boolean` | true | Toggles whether or not to show empty items in non-editable mode. | +| displayNoneOption | `boolean` | true | Toggles whether or not to display none option. | +| editable | `boolean` | | Toggles whether or not the items can be edited. | +| multiValueSeparator | `string` | DEFAULT_SEPARATOR | String separator between multi-value property items. | +| properties | [`CardViewItem`](../../../lib/core/card-view/interfaces/card-view-item.interface.ts)`[]` | | (**required**) Items to show in the card view. | +| useChipsForMultiValueProperty | `boolean` | true | Toggles whether or not to enable chips for multivalued properties. | ## Details @@ -157,7 +157,7 @@ You can optionally set up the card view so that its properties can be edited. Yo the editing of properties at two levels: - **Global level** - _via the editable parameter of the card-view.component_ -- **[`Property`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/property.ts) level** - _in each property via the editable attribute_ +- **[`Property`](../../../lib/content-services/src/lib/content-metadata/interfaces/property.interface.ts) level** - _in each property via the editable attribute_ If you set the global editable parameter to false, no properties can be edited regardless of their individual `editable` settings. @@ -182,22 +182,22 @@ specific data types, as described below. const textItemProperty = new CardViewTextItemModel(options); ``` -| Name | Type | Default | Description | -| ---- | ---- | ------- | ----------- | -| label\* | string | | Item label | -| value\* | any | | The original data value for the item | -| key\* | string | | Identifying key (important when editing the item) | -| default | any | | The default value to display if the value is empty | -| displayValue\* | string | | The value to display | -| editable | boolean | false | Toggles whether the item is editable | -| clickable | boolean | false | Toggles whether the property responds to clicks | -| clickableCallBack | function | null | Function to execute when click the element | -| copyToClipboardAction | `boolean` | true | Toggles whether or not to enable copy to clipboard action. | -| useChipsForMultiValueProperty | `boolean` | true | Toggles whether or not to enable chips for multivalued properties. | -| multiValueSeparator | `string` | ',' | String separator between multi-value property items. | -| icon | string | | The material icon to show beside the item if it is clickable | -| multiline | boolean | false | Single or multiline text | -| pipes | [`CardViewTextItemPipeProperty`](../../../lib/core/card-view/interfaces/card-view-textitem-pipe-property.interface.ts)\[] | \[] | Pipes to be applied to the text before display | +| Name | Type | Default | Description | +| ----------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------ | +| label\* | string | | Item label | +| value\* | any | | The original data value for the item | +| key\* | string | | Identifying key (important when editing the item) | +| default | any | | The default value to display if the value is empty | +| displayValue\* | string | | The value to display | +| editable | boolean | false | Toggles whether the item is editable | +| clickable | boolean | false | Toggles whether the property responds to clicks | +| clickableCallBack | function | null | Function to execute when click the element | +| copyToClipboardAction | `boolean` | true | Toggles whether or not to enable copy to clipboard action. | +| useChipsForMultiValueProperty | `boolean` | true | Toggles whether or not to enable chips for multivalued properties. | +| multiValueSeparator | `string` | ',' | String separator between multi-value property items. | +| icon | string | | The material icon to show beside the item if it is clickable | +| multiline | boolean | false | Single or multiline text | +| pipes | [`CardViewTextItemPipeProperty`](../../../lib/core/card-view/interfaces/card-view-textitem-pipe-property.interface.ts)\[] | \[] | Pipes to be applied to the text before display | ##### Using pipes with a Card Text Item @@ -227,14 +227,14 @@ new CardViewTextItemModel({ const mapItemProperty = new CardViewMapItemModel(options); ``` -| Name | Type | Default | Description | -| ---- | ---- | ------- | ----------- | -| label\* | string | | Item label | -| value\* | Map | | A map that contains the key value pairs | -| key\* | string | | Identifying key (important when editing the item) | -| default | any | | The default value to display if the value is empty | -| displayValue\* | string | | The value to display | -| clickable | boolean | false | Toggles whether the property responds to clicks | +| Name | Type | Default | Description | +| -------------- | ------- | ------- | -------------------------------------------------- | +| label\* | string | | Item label | +| value\* | Map | | A map that contains the key value pairs | +| key\* | string | | Identifying key (important when editing the item) | +| default | any | | The default value to display if the value is empty | +| displayValue\* | string | | The value to display | +| clickable | boolean | false | Toggles whether the property responds to clicks | #### Card Date Item @@ -244,16 +244,16 @@ const mapItemProperty = new CardViewMapItemModel(options); const dateItemProperty = new CardViewDateItemModel(options); ``` -| Name | Type | Default | Description | -| ---- | ---- | ------- | ----------- | -| label\* | string | | Item label | -| value\* | any | | The original data value for the item | -| copyToClipboardAction | `boolean` | true | Toggles whether or not to enable copy to clipboard action. | -| key\* | string | | Identifying key (important when editing the item) | -| default | any | | The default value to display if the value is empty | -| displayValue\* | any | | The value to display | -| editable | boolean | false | Toggles whether the item is editable | -| format | string | "MMM DD YYYY" | Any date format that momentjs accepts | +| Name | Type | Default | Description | +| --------------------- | --------- | ------------- | ---------------------------------------------------------- | +| label\* | string | | Item label | +| value\* | any | | The original data value for the item | +| copyToClipboardAction | `boolean` | true | Toggles whether or not to enable copy to clipboard action. | +| key\* | string | | Identifying key (important when editing the item) | +| default | any | | The default value to display if the value is empty | +| displayValue\* | any | | The value to display | +| editable | boolean | false | Toggles whether the item is editable | +| format | string | "MMM DD YYYY" | Any date format that momentjs accepts | #### Card Datetime Item @@ -263,15 +263,15 @@ const dateItemProperty = new CardViewDateItemModel(options); const datetimeItemProperty = new CardViewDatetimeItemModel(options); ``` -| Name | Type | Default | Description | -| ---- | ---- | ------- | ----------- | -| label\* | string | | Item label | -| value\* | any | | The original data value for the item | -| key\* | string | | Identifying key (important when editing the item) | -| default | any | any | The default value to display if the value is empty | -| displayValue\* | string | | The value to display | -| editable | boolean | false | Toggles whether the item is editable | -| format | string | "MMM DD YYYY HH:mm" | Any datetime format that momentjs accepts | +| Name | Type | Default | Description | +| -------------- | ------- | ------------------- | -------------------------------------------------- | +| label\* | string | | Item label | +| value\* | any | | The original data value for the item | +| key\* | string | | Identifying key (important when editing the item) | +| default | any | any | The default value to display if the value is empty | +| displayValue\* | string | | The value to display | +| editable | boolean | false | Toggles whether the item is editable | +| format | string | "MMM DD YYYY HH:mm" | Any datetime format that momentjs accepts | #### Card Bool Item @@ -281,14 +281,14 @@ const datetimeItemProperty = new CardViewDatetimeItemModel(options); const boolItemProperty = new CardViewBoolItemModel(options); ``` -| Name | Type | Default | Description | -| ---- | ---- | ------- | ----------- | -| label\* | string | | Item label | -| value\* | boolean | | The original data value for the item | -| key\* | string | | Identifying key (important when editing the item) | -| default | boolean | false | The default value to display if the value is empty | -| displayValue\* | boolean | | The value to display | -| editable | boolean | false | Toggles whether the item is editable | +| Name | Type | Default | Description | +| -------------- | ------- | ------- | -------------------------------------------------- | +| label\* | string | | Item label | +| value\* | boolean | | The original data value for the item | +| key\* | string | | Identifying key (important when editing the item) | +| default | boolean | false | The default value to display if the value is empty | +| displayValue\* | boolean | | The value to display | +| editable | boolean | false | Toggles whether the item is editable | #### Card Int Item @@ -298,14 +298,14 @@ const boolItemProperty = new CardViewBoolItemModel(options); const intItemProperty = new CardViewIntItemModel(options); ``` -| Name | Type | Default | Description | -| ---- | ---- | ------- | ----------- | -| label\* | string | | Item label | -| value\* | integer | | The original data value for the item | -| key\* | string | | Identifying key (important when editing the item) | -| default | integer | | The default value to display if the value is empty | -| displayValue\* | integer | | The value to display | -| editable | boolean | false | Toggles whether the item is editable | +| Name | Type | Default | Description | +| -------------- | ------- | ------- | -------------------------------------------------- | +| label\* | string | | Item label | +| value\* | integer | | The original data value for the item | +| key\* | string | | Identifying key (important when editing the item) | +| default | integer | | The default value to display if the value is empty | +| displayValue\* | integer | | The value to display | +| editable | boolean | false | Toggles whether the item is editable | #### Card Float Item @@ -315,14 +315,14 @@ const intItemProperty = new CardViewIntItemModel(options); const floatItemProperty = new CardViewFloatItemModel(options); ``` -| Name | Type | Default | Description | -| ---- | ---- | ------- | ----------- | -| label\* | string | | Item label | -| value\* | float | | The original data value for the item | -| key\* | string | | Identifying key (important when editing the item) | -| default | float | | The default value to display if the value is empty | -| displayValue\* | float | | The value to display | -| editable | boolean | false | Toggles whether the item is editable | +| Name | Type | Default | Description | +| -------------- | ------- | ------- | -------------------------------------------------- | +| label\* | string | | Item label | +| value\* | float | | The original data value for the item | +| key\* | string | | Identifying key (important when editing the item) | +| default | float | | The default value to display if the value is empty | +| displayValue\* | float | | The value to display | +| editable | boolean | false | Toggles whether the item is editable | #### Card Key Value Pairs Item @@ -332,12 +332,12 @@ const floatItemProperty = new CardViewFloatItemModel(options); const keyValuePairsItemProperty = new CardViewKeyValuePairsItemModel(options); ``` -| Name | Type | Default | Description | -| ---- | ---- | ------- | ----------- | -| label\* | string | | Item label | -| key\* | string | | Identifying key (important when editing the item) | -| editable | boolean | false | Toggles whether the item is editable | -| value\* | `[{ name: '', value: '' }, ...]` | | The original data value for the item | +| Name | Type | Default | Description | +| -------- | -------------------------------- | ------- | ------------------------------------------------- | +| label\* | string | | Item label | +| key\* | string | | Identifying key (important when editing the item) | +| editable | boolean | false | Toggles whether the item is editable | +| value\* | `[{ name: '', value: '' }, ...]` | | The original data value for the item | #### Card Select Item @@ -347,13 +347,13 @@ const keyValuePairsItemProperty = new CardViewKeyValuePairsItemModel(options); const selectItemProperty = new CardViewSelectItemModel(options); ``` -| Name | Type | Default | Description | -| ---- | ---- | ------- | ----------- | -| label\* | string | | Item label | -| key\* | string | | Identifying key (important when editing the item) | -| editable | boolean | false | Toggles whether the item is editable | -| value | string | | The original data value for the item | -| options$\* | [`Observable`](http://reactivex.io/documentation/observable.html)<[`CardViewSelectItemOption`](../../../lib/core/card-view/interfaces/card-view-selectitem-properties.interface.ts)\[]> | | The original data value for the item | +| Name | Type | Default | Description | +| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------- | ------------------------------------------------- | +| label\* | string | | Item label | +| key\* | string | | Identifying key (important when editing the item) | +| editable | boolean | false | Toggles whether the item is editable | +| value | string | | The original data value for the item | +| options$\* | [`Observable`](http://reactivex.io/documentation/observable.html)<[`CardViewSelectItemOption`](../../../lib/core/card-view/interfaces/card-view-selectitem-properties.interface.ts)\[]> | | The original data value for the item | #### Card Array Item @@ -363,12 +363,12 @@ const selectItemProperty = new CardViewSelectItemModel(options); const arrayItemProperty = new CardViewArrayItemModel(items); ``` -| Name | Type | Default | Description | -| ---- | ---- | ------- | ----------- | -| label\* | string | | Item label | -| key\* | string | | Identifying key (important when editing the item) | -| editable | boolean | false | Toggles whether the item is editable | -| value | [`Observable`](http://reactivex.io/documentation/observable.html)<[`CardViewArrayItem`](../../../lib/core/card-view/models/card-view-arrayitem.model.ts)\[]> | | The original data value for the item | +| Name | Type | Default | Description | +| -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | ------------------------------------------------- | +| label\* | string | | Item label | +| key\* | string | | Identifying key (important when editing the item) | +| editable | boolean | false | Toggles whether the item is editable | +| value | [`Observable`](http://reactivex.io/documentation/observable.html)<[`CardViewArrayItem`](../../../lib/core/card-view/models/card-view-arrayitem.model.ts)\[]> | | The original data value for the item | ## See also diff --git a/docs/core/components/comment-list.component.md b/docs/core/components/comment-list.component.md index 7f3c423d8c..ff26de9ce3 100644 --- a/docs/core/components/comment-list.component.md +++ b/docs/core/components/comment-list.component.md @@ -63,12 +63,12 @@ In the component template use the [comment list component](comment-list.componen ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| comments | [`CommentModel`](../../../lib/core/models/comment.model.ts)`[]` | | The comments data used to populate the list. | +| Name | Type | Default value | Description | +| -------- | --------------------------------------------------------------- | ------------- | -------------------------------------------- | +| comments | [`CommentModel`](../../../lib/core/models/comment.model.ts)`[]` | | The comments data used to populate the list. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| -------- | --------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | | clickRow | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`>` | Emitted when the user clicks on one of the comment rows. | diff --git a/docs/core/components/comments.component.md b/docs/core/components/comments.component.md index 36e82a36c7..15bd52599a 100644 --- a/docs/core/components/comments.component.md +++ b/docs/core/components/comments.component.md @@ -32,14 +32,14 @@ Displays comments from users involved in a specified task or content and allows ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| nodeId | `string` | | The numeric ID of the node. | -| readOnly | `boolean` | false | Are the comments read only? | -| taskId | `string` | | The numeric ID of the task. | +| Name | Type | Default value | Description | +| -------- | --------- | ------------- | --------------------------- | +| nodeId | `string` | | The numeric ID of the node. | +| readOnly | `boolean` | false | Are the comments read only? | +| taskId | `string` | | The numeric ID of the task. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| ----- | ----------------------------------------------------------------- | --------------------------------------------------------------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs while displaying/adding a comment. | diff --git a/docs/core/components/data-column.component.md b/docs/core/components/data-column.component.md index 4d27f19ffd..4141e5ebcd 100644 --- a/docs/core/components/data-column.component.md +++ b/docs/core/components/data-column.component.md @@ -41,20 +41,20 @@ Defines column properties for DataTable, Tasklist, Document List and other compo ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| copyContent | `boolean` | | Enables/disables a [Clipboard directive](../../core/directives/clipboard.directive.md) to allow copying of cell contents. | -| cssClass | `string` | | Additional CSS class to be applied to column (header and cells). | -| editable | `boolean` | false | Toggles the editing support of the column data. | -| focus | `boolean` | true | Enable or disable cell focus | -| format | `string` | | Value format (if supported by the parent component), for example format of the date. | -| formatTooltip | `Function` | | Custom tooltip formatter function. | -| key | `string` | | Data source key. Can be either a column/property key like `title` or a property path like `createdBy.name`. | -| sortable | `boolean` | true | Toggles ability to sort by this column, for example by clicking the column header. | -| sortingKey | `string` | | When using server side sorting the column used by the api call where the sorting will be performed | -| srTitle | `string` | | Title to be used for screen readers. | -| title | `string` | "" | Display title of the column, typically used for column headers. You can use the i18n resource key to get it translated automatically. | -| type | `string` | "text" | Value type for the column. Possible settings are 'text', 'image', 'date', 'fileSize', 'location', and 'json'. | +| Name | Type | Default value | Description | +| ------------- | ---------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------- | +| copyContent | `boolean` | | Enables/disables a [Clipboard directive](../../core/directives/clipboard.directive.md) to allow copying of cell contents. | +| cssClass | `string` | | Additional CSS class to be applied to column (header and cells). | +| editable | `boolean` | false | Toggles the editing support of the column data. | +| focus | `boolean` | true | Enable or disable cell focus | +| format | `string` | | Value format (if supported by the parent component), for example format of the date. | +| formatTooltip | `Function` | | Custom tooltip formatter function. | +| key | `string` | | Data source key. Can be either a column/property key like `title` or a property path like `createdBy.name`. | +| sortable | `boolean` | true | Toggles ability to sort by this column, for example by clicking the column header. | +| sortingKey | `string` | | When using server side sorting the column used by the api call where the sorting will be performed | +| srTitle | `string` | | Title to be used for screen readers. | +| title | `string` | "" | Display title of the column, typically used for column headers. You can use the i18n resource key to get it translated automatically. | +| type | `string` | "text" | Value type for the column. Possible settings are 'text', 'image', 'date', 'fileSize', 'location', and 'json'. | ## Details @@ -124,11 +124,11 @@ You can provide custom column/cell templates that may contain other Angular comp Every cell in the DataTable component is bound to the dynamic data context containing the following properties: -| Name | Type | Description | -| ---- | ---- | ----------- | -| data | [`DataTableAdapter`](../../../lib/core/datatable/data/datatable-adapter.ts) | Data adapter instance. | -| row | [`DataRow`](../../../lib/core/datatable/data/data-row.model.ts) | Current data row instance. | -| col | [`DataColumn`](../../../lib/core/datatable/data/data-column.model.ts) | Current data column instance. | +| Name | Type | Description | +| ---- | --------------------------------------------------------------------------- | ----------------------------- | +| data | [`DataTableAdapter`](../../../lib/core/datatable/data/datatable-adapter.ts) | Data adapter instance. | +| row | [`DataRow`](../../../lib/core/datatable/data/data-row.model.ts) | Current data row instance. | +| col | [`DataColumn`](../../../lib/core/datatable/data/data-column.model.ts) | Current data column instance. | You can use all three properties to gain full access to underlying data from within your custom templates. In order to wire HTML templates with the data context you will need to define a variable that is bound to `$implicit` as shown below: diff --git a/docs/core/components/datatable.component.md b/docs/core/components/datatable.component.md index cdf7dbe0dd..b106ea58cb 100644 --- a/docs/core/components/datatable.component.md +++ b/docs/core/components/datatable.component.md @@ -342,38 +342,38 @@ Learm more about styling your datatable: [Customizing the component's styles](#c ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| actions | `boolean` | false | Toggles the data actions column. | -| actionsPosition | `string` | "right" | Position of the actions dropdown menu. Can be "left" or "right". | -| allowFiltering | `boolean` | false | Flag that indicate if the datatable allow the use facet [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) search for filtering. | -| columns | `any[]` | \[] | The columns that the datatable will show. | -| contextMenu | `boolean` | false | Toggles custom context menu for the component. | -| data | [`DataTableAdapter`](../../../lib/core/datatable/data/datatable-adapter.ts) | | Data source for the table | -| display | `string` | DisplayMode.List | Selects the display mode of the table. Can be "list" or "gallery". | -| fallbackThumbnail | `string` | | Fallback image for rows where the thumbnail is missing. | -| loading | `boolean` | false | Flag that indicates if the datatable is in loading state and needs to show the loading template (see the docs to learn how to configure a loading template). | -| multiselect | `boolean` | false | Toggles multiple row selection, which renders checkboxes at the beginning of each row. | -| noPermission | `boolean` | false | Flag that indicates if the datatable should show the "no permission" template. | -| resolverFn | `Function` | null | Custom resolver function which is used to parse dynamic column objects see the docs to learn how to configure a resolverFn. | -| rowMenuCacheEnabled | `boolean` | true | Should the items for the row actions menu be cached for reuse after they are loaded the first time? | -| rowStyle | `string` | | The inline style to apply to every row. See [NgStyle](https://angular.io/docs/ts/latest/api/common/index/NgStyle-directive.html) docs for more details and usage examples. | -| rowStyleClass | `string` | "" | The CSS class to apply to every row. | -| rows | `any[]` | \[] | The rows that the datatable will show. | -| selectionMode | `string` | "single" | Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. | -| showHeader | `string` | | Toggles the header. | -| sorting | `any[]` | \[] | Define the sort order of the datatable. Possible values are : [`created`, `desc`], [`created`, `asc`], [`due`, `desc`], [`due`, `asc`] | -| stickyHeader | `boolean` | false | Toggles the sticky header mode. | +| Name | Type | Default value | Description | +| ------------------- | --------------------------------------------------------------------------- | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| actions | `boolean` | false | Toggles the data actions column. | +| actionsPosition | `string` | "right" | Position of the actions dropdown menu. Can be "left" or "right". | +| allowFiltering | `boolean` | false | Flag that indicate if the datatable allow the use facet [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) search for filtering. | +| columns | `any[]` | \[] | The columns that the datatable will show. | +| contextMenu | `boolean` | false | Toggles custom context menu for the component. | +| data | [`DataTableAdapter`](../../../lib/core/datatable/data/datatable-adapter.ts) | | Data source for the table | +| display | `string` | DisplayMode.List | Selects the display mode of the table. Can be "list" or "gallery". | +| fallbackThumbnail | `string` | | Fallback image for rows where the thumbnail is missing. | +| loading | `boolean` | false | Flag that indicates if the datatable is in loading state and needs to show the loading template (see the docs to learn how to configure a loading template). | +| multiselect | `boolean` | false | Toggles multiple row selection, which renders checkboxes at the beginning of each row. | +| noPermission | `boolean` | false | Flag that indicates if the datatable should show the "no permission" template. | +| resolverFn | `Function` | null | Custom resolver function which is used to parse dynamic column objects see the docs to learn how to configure a resolverFn. | +| rowMenuCacheEnabled | `boolean` | true | Should the items for the row actions menu be cached for reuse after they are loaded the first time? | +| rowStyle | `string` | | The inline style to apply to every row. See [NgStyle](https://angular.io/docs/ts/latest/api/common/index/NgStyle-directive.html) docs for more details and usage examples. | +| rowStyleClass | `string` | "" | The CSS class to apply to every row. | +| rows | `any[]` | \[] | The rows that the datatable will show. | +| selectionMode | `string` | "single" | Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. | +| showHeader | `string` | ShowHeaderMode.Data | Toggles the header. | +| sorting | `any[]` | \[] | Define the sort order of the datatable. Possible values are : [`created`, `desc`], [`created`, `asc`], [`due`, `desc`], [`due`, `asc`] | +| stickyHeader | `boolean` | false | Toggles the sticky header mode. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| executeRowAction | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowActionEvent`](../../../lib/core/datatable/components/data-row-action.event.ts)`>` | Emitted when the user executes a row action. | -| rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowEvent`](../../../lib/core/datatable/data/data-row-event.model.ts)`>` | Emitted when the user clicks a row. | -| rowDblClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowEvent`](../../../lib/core/datatable/data/data-row-event.model.ts)`>` | Emitted when the user double-clicks a row. | -| showRowActionsMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the actions menu is displayed for a row. | -| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. | +| Name | Type | Description | +| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | +| executeRowAction | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowActionEvent`](../../../lib/core/datatable/components/data-row-action.event.ts)`>` | Emitted when the user executes a row action. | +| rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowEvent`](../../../lib/core/datatable/data/data-row-event.model.ts)`>` | Emitted when the user clicks a row. | +| rowDblClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowEvent`](../../../lib/core/datatable/data/data-row-event.model.ts)`>` | Emitted when the user double-clicks a row. | +| showRowActionsMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the actions menu is displayed for a row. | +| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. | ## Details @@ -395,18 +395,18 @@ for more information. Below are the DOM events emitted by the DataTable component. These events bubble up the component tree and can be handled by any parent component. -| Name | Description | -| ---- | ----------- | -| row-click | Raised when user clicks a row | -| row-dblclick | Raised when user double-clicks a row | -| row-select | Raised after user selects a row | -| row-unselect | Raised after user unselects a row | -| row-keyup | Raised on the 'keyup' event for the focused row. | +| Name | Description | +| --------------- | ---------------------------------------------------- | +| row-click | Raised when user clicks a row | +| row-dblclick | Raised when user double-clicks a row | +| row-select | Raised after user selects a row | +| row-unselect | Raised after user unselects a row | +| row-keyup | Raised on the 'keyup' event for the focused row. | | sorting-changed | Raised after user clicks the sortable column header. | -| header-dragover | Raised when dragging content over the header. | -| header-drop | Raised when data is dropped on the column header. | -| cell-dragover | Raised when dragging data over the cell. | -| cell-drop | Raised when data is dropped on the column cell. | +| header-dragover | Raised when dragging content over the header. | +| header-drop | Raised when data is dropped on the column header. | +| cell-dragover | Raised when dragging data over the cell. | +| cell-drop | Raised when data is dropped on the column cell. | #### Drop Events diff --git a/docs/core/components/empty-content.component.md b/docs/core/components/empty-content.component.md index 454a8c07ea..79290a0af0 100644 --- a/docs/core/components/empty-content.component.md +++ b/docs/core/components/empty-content.component.md @@ -29,11 +29,11 @@ Provides a generic "Empty Content" placeholder for components. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| icon | `string` | "cake" | Material Icon to use. | -| subtitle | `string` | "" | String or Resource Key for the subtitle. | -| title | `string` | "" | String or Resource Key for the title. | +| Name | Type | Default value | Description | +| -------- | -------- | ------------- | ---------------------------------------- | +| icon | `string` | "cake" | Material Icon to use. | +| subtitle | `string` | "" | String or Resource Key for the subtitle. | +| title | `string` | "" | String or Resource Key for the title. | ## Details diff --git a/docs/core/components/error-content.component.md b/docs/core/components/error-content.component.md index 99cbc247e8..e7d8338cf4 100644 --- a/docs/core/components/error-content.component.md +++ b/docs/core/components/error-content.component.md @@ -21,9 +21,9 @@ this.router.navigate(['/error', errorCode]); ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| errorCode | `string` | | Error code associated with this error. | +| Name | Type | Default value | Description | +| --------- | -------- | ------------- | -------------------------------------- | +| errorCode | `string` | | Error code associated with this error. | ## Details diff --git a/docs/core/components/form-field.component.md b/docs/core/components/form-field.component.md index 7f5d40704c..7495b262c3 100644 --- a/docs/core/components/form-field.component.md +++ b/docs/core/components/form-field.component.md @@ -25,9 +25,9 @@ based on the field type or the metadata information. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| field | [`FormFieldModel`](../../core/models/form-field.model.md) | null | Contains all the necessary data needed to determine what UI [`Widget`](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) 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. | +| Name | Type | Default value | Description | +| ----- | --------------------------------------------------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| field | [`FormFieldModel`](../../core/models/form-field.model.md) | null | Contains all the necessary data needed to determine what UI [`Widget`](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) 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 @@ -38,24 +38,24 @@ uses `` components to render the form fields. Forms defined in APS have the following default mappings for the form fields: -| _APS [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) Designer_ [`Widget`](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) | Field Type | Component Type | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------- | -------------- | -| Text | text | [`TextWidgetComponent`](../../../lib/core/form/components/widgets/text/text.widget.ts) | -| Multi-line text | multi-line-text | [`MultilineTextWidgetComponentComponent`](../../../lib/core/form/components/widgets/multiline-text/multiline-text.widget.ts) | -| Number | integer | [`NumberWidgetComponent`](../../../lib/core/form/components/widgets/number/number.widget.ts) | -| Checkbox | boolean | [`CheckboxWidgetComponent`](../../../lib/core/form/components/widgets/checkbox/checkbox.widget.ts) | -| Date | date | [`DateWidgetComponent`](../../../lib/core/form/components/widgets/date/date.widget.ts) | -| Dropdown | dropdown | [`DropdownWidgetComponent`](../../../lib/core/form/components/widgets/dropdown/dropdown.widget.ts) | -| Typeahead | typeahead | [`TypeaheadWidgetComponent`](../../../lib/core/form/components/widgets/typeahead/typeahead.widget.ts) | -| Amount | amount | [`AmountWidgetComponent`](../../../lib/core/form/components/widgets/amount/amount.widget.ts) | -| Radio buttons | radio-buttons | [`RadioButtonsWidgetComponent`](../../../lib/core/form/components/widgets/radio-buttons/radio-buttons.widget.ts) | -| People | people | [`PeopleWidgetComponent`](../../../lib/core/form/components/widgets/people/people.widget.ts) | -| Group of people | functional-group | [`FunctionalGroupWidgetComponent`](../../../lib/core/form/components/widgets/functional-group/functional-group.widget.ts) | -| Dynamic table | dynamic-table | [`DynamicTableWidgetComponent`](../../../lib/core/form/components/widgets/dynamic-table/dynamic-table.widget.ts) | -| Hyperlink | hyperlink | [`HyperlinkWidgetComponent`](../../../lib/core/form/components/widgets/hyperlink/hyperlink.widget.ts) | -| Header | group | [`ContainerWidgetComponent`](../../../lib/core/form/components/widgets/container/container.widget.ts) | -| Attach File | upload | AttachWidgetComponent or [`UploadWidgetComponent`](../../../lib/core/form/components/widgets/upload/upload.widget.ts) (based on metadata) | -| Display value | readonly | [`TextWidgetComponent`](../../../lib/core/form/components/widgets/text/text.widget.ts) | -| Display text | readonly-text | [`DisplayTextWidgetComponent`](../../../lib/core/form/components/widgets/display-text/display-text.widget.ts) | -| N/A | container | [`ContainerWidgetComponent`](../../../lib/core/form/components/widgets/container/container.widget.ts) (layout component) | -| N/A | N/A | [`UnknownWidgetComponent`](../../../lib/core/form/components/widgets/unknown/unknown.widget.ts) | +| _APS [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) Designer_ [`Widget`](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) | Field Type | Component Type | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | +| Text | text | [`TextWidgetComponent`](../../../lib/core/form/components/widgets/text/text.widget.ts) | +| Multi-line text | multi-line-text | [`MultilineTextWidgetComponentComponent`](../../../lib/core/form/components/widgets/multiline-text/multiline-text.widget.ts) | +| Number | integer | [`NumberWidgetComponent`](../../../lib/core/form/components/widgets/number/number.widget.ts) | +| Checkbox | boolean | [`CheckboxWidgetComponent`](../../../lib/core/form/components/widgets/checkbox/checkbox.widget.ts) | +| Date | date | [`DateWidgetComponent`](../../../lib/core/form/components/widgets/date/date.widget.ts) | +| Dropdown | dropdown | [`DropdownWidgetComponent`](../../../lib/core/form/components/widgets/dropdown/dropdown.widget.ts) | +| Typeahead | typeahead | [`TypeaheadWidgetComponent`](../../../lib/core/form/components/widgets/typeahead/typeahead.widget.ts) | +| Amount | amount | [`AmountWidgetComponent`](../../../lib/core/form/components/widgets/amount/amount.widget.ts) | +| Radio buttons | radio-buttons | [`RadioButtonsWidgetComponent`](../../../lib/core/form/components/widgets/radio-buttons/radio-buttons.widget.ts) | +| People | people | [`PeopleWidgetComponent`](../../../lib/core/form/components/widgets/people/people.widget.ts) | +| Group of people | functional-group | [`FunctionalGroupWidgetComponent`](../../../lib/core/form/components/widgets/functional-group/functional-group.widget.ts) | +| Dynamic table | dynamic-table | [`DynamicTableWidgetComponent`](../../../lib/core/form/components/widgets/dynamic-table/dynamic-table.widget.ts) | +| Hyperlink | hyperlink | [`HyperlinkWidgetComponent`](../../../lib/core/form/components/widgets/hyperlink/hyperlink.widget.ts) | +| Header | group | [`ContainerWidgetComponent`](../../../lib/core/form/components/widgets/container/container.widget.ts) | +| Attach File | upload | AttachWidgetComponent or [`UploadWidgetComponent`](../../../lib/core/form/components/widgets/upload/upload.widget.ts) (based on metadata) | +| Display value | readonly | [`TextWidgetComponent`](../../../lib/core/form/components/widgets/text/text.widget.ts) | +| Display text | readonly-text | [`DisplayTextWidgetComponent`](../../../lib/core/form/components/widgets/display-text/display-text.widget.ts) | +| N/A | container | [`ContainerWidgetComponent`](../../../lib/core/form/components/widgets/container/container.widget.ts) (layout component) | +| N/A | N/A | [`UnknownWidgetComponent`](../../../lib/core/form/components/widgets/unknown/unknown.widget.ts) | diff --git a/docs/core/components/form-list.component.md b/docs/core/components/form-list.component.md index 837d00b3c9..663f189801 100644 --- a/docs/core/components/form-list.component.md +++ b/docs/core/components/form-list.component.md @@ -21,6 +21,6 @@ Shows forms as a list. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| forms | `any[]` | \[] | The array that contains the information to show inside the list. | +| Name | Type | Default value | Description | +| ----- | ------- | ------------- | ---------------------------------------------------------------- | +| forms | `any[]` | \[] | The array that contains the information to show inside the list. | diff --git a/docs/core/components/header.component.md b/docs/core/components/header.component.md index 5bf5e7a49a..976bf6abf5 100644 --- a/docs/core/components/header.component.md +++ b/docs/core/components/header.component.md @@ -36,21 +36,21 @@ body of the element: ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| color | `string` | | Background color for the header. It can be any hex color code or one of the Material theme colors: 'primary', 'accent' or 'warn'. | -| expandedSidenav | `boolean` | true | expandedSidenav: Toggles the expanded state of the component. | -| logo | `string` | | Path to an image file for the application logo. | -| position | `string` | "start" | The side of the page that the drawer is attached to (can be 'start' or 'end') | -| redirectUrl | `string \| any[]` | "/" | The router link for the application logo, when clicked. | -| showSidenavToggle | `boolean` | true | Toggles whether the sidenav button will be displayed in the header or not. | -| title | `string` | | Title of the application. | -| tooltip | `string` | | The tooltip text for the application logo. | +| Name | Type | Default value | Description | +| ----------------- | ----------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------- | +| color | `string` | | Background color for the header. It can be any hex color code or one of the Material theme colors: 'primary', 'accent' or 'warn'. | +| expandedSidenav | `boolean` | true | expandedSidenav: Toggles the expanded state of the component. | +| logo | `string` | | Path to an image file for the application logo. | +| position | `string` | "start" | The side of the page that the drawer is attached to (can be 'start' or 'end') | +| redirectUrl | `string \| any[]` | "/" | The router link for the application logo, when clicked. | +| showSidenavToggle | `boolean` | true | Toggles whether the sidenav button will be displayed in the header or not. | +| title | `string` | | Title of the application. | +| tooltip | `string` | | The tooltip text for the application logo. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| ------- | --------------------------------------------------------------------- | ------------------------------------------- | | clicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the sidenav button is clicked. | ## Details diff --git a/docs/core/components/host-settings.component.md b/docs/core/components/host-settings.component.md index 33618246b5..c289952347 100644 --- a/docs/core/components/host-settings.component.md +++ b/docs/core/components/host-settings.component.md @@ -32,14 +32,14 @@ Validates the URLs for ACS and APS and saves them in the user's local storage ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| providers | `string[]` | | Tells the component which provider options are available. Possible valid values are "ECM" (Content), "BPM" (Process) , "ALL" (Content and Process), 'OAUTH2' SSO. | +| Name | Type | Default value | Description | +| --------- | ---------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| providers | `string[]` | | Tells the component which provider options are available. Possible valid values are "ECM" (Content), "BPM" (Process) , "ALL" (Content and Process), 'OAUTH2' SSO. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the user cancels the changes. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the URL is invalid. | +| Name | Type | Description | +| ------- | --------------------------------------------------------------------- | -------------------------------------------------- | +| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the user cancels the changes. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the URL is invalid. | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the changes are successfully applied. | diff --git a/docs/core/components/icon.component.md b/docs/core/components/icon.component.md index af76fac0ad..25fb45fb25 100644 --- a/docs/core/components/icon.component.md +++ b/docs/core/components/icon.component.md @@ -26,10 +26,10 @@ Provides a universal way of rendering registered and named icons. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| color | [`ThemePalette`](https://github.com/angular/components/blob/master/src/material/core/common-behaviors/color.ts) | | Theme color palette for the component. | -| value | `string` | | Icon value, which can be either a ligature name or a custom icon in the format `[namespace]:[name]`. | +| Name | Type | Default value | Description | +| ----- | --------------------------------------------------------------------------------------------------------------- | ------------- | ---------------------------------------------------------------------------------------------------- | +| color | [`ThemePalette`](https://github.com/angular/components/blob/master/src/material/core/common-behaviors/color.ts) | | Theme color palette for the component. | +| value | `string` | | Icon value, which can be either a ligature name or a custom icon in the format `[namespace]:[name]`. | ## Details diff --git a/docs/core/components/infinite-pagination.component.md b/docs/core/components/infinite-pagination.component.md index 0ea6844b7a..305ba25557 100644 --- a/docs/core/components/infinite-pagination.component.md +++ b/docs/core/components/infinite-pagination.component.md @@ -36,16 +36,16 @@ Adds "infinite" pagination to the component it is used with. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| isLoading | `boolean` | false | Is a new page loading? | -| pageSize | `number` | | Number of items that are added with each "load more" event. | -| target | [`PaginatedComponent`](../../../lib/core/pagination/paginated-component.interface.ts) | | Component that provides custom pagination support. | +| Name | Type | Default value | Description | +| --------- | ------------------------------------------------------------------------------------- | ------------- | ----------------------------------------------------------- | +| isLoading | `boolean` | false | Is a new page loading? | +| pageSize | `number` | | Number of items that are added with each "load more" event. | +| target | [`PaginatedComponent`](../../../lib/core/pagination/paginated-component.interface.ts) | | Component that provides custom pagination support. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------- | | loadMore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`RequestPaginationModel`](../../../lib/core/models/request-pagination.model.ts)`>` | Emitted when the "Load More" button is clicked. | ## Details diff --git a/docs/core/components/info-drawer-layout.component.md b/docs/core/components/info-drawer-layout.component.md index 147b26e06c..aa2f9b25e1 100644 --- a/docs/core/components/info-drawer-layout.component.md +++ b/docs/core/components/info-drawer-layout.component.md @@ -42,9 +42,9 @@ with the following names: ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| showHeader | `boolean` | true | The visibility of the header. | +| Name | Type | Default value | Description | +| ---------- | --------- | ------------- | ----------------------------- | +| showHeader | `boolean` | true | The visibility of the header. | ## Details diff --git a/docs/core/components/info-drawer-tab.component.md b/docs/core/components/info-drawer-tab.component.md index b3a0f54416..a81e407dc0 100644 --- a/docs/core/components/info-drawer-tab.component.md +++ b/docs/core/components/info-drawer-tab.component.md @@ -53,10 +53,10 @@ You can also combine `icon` and `label` properties. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| icon | `string` | null | Icon to render for the tab. | -| label | `string` | "" | The title of the tab (string or translation key). | +| Name | Type | Default value | Description | +| ----- | -------- | ------------- | ------------------------------------------------- | +| icon | `string` | null | Icon to render for the tab. | +| label | `string` | "" | The title of the tab (string or translation key). | ## Details diff --git a/docs/core/components/info-drawer.component.md b/docs/core/components/info-drawer.component.md index 7461420194..27b3724e71 100644 --- a/docs/core/components/info-drawer.component.md +++ b/docs/core/components/info-drawer.component.md @@ -47,16 +47,16 @@ have any content you like: ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| selectedIndex | `number` | 0 | The selected index tab. | -| showHeader | `boolean` | true | The visibility of the header. | -| title | `string \| null` | null | The title of the info drawer (string or translation key). | +| Name | Type | Default value | Description | +| ------------- | ---------------- | ------------- | --------------------------------------------------------- | +| selectedIndex | `number` | 0 | The selected index tab. | +| showHeader | `boolean` | true | The visibility of the header. | +| title | `string \| null` | null | The title of the info drawer (string or translation key). | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| ---------- | -------------------------------------------------------------------- | ---------------------------------------------- | | currentTab | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the currently active tab changes. | ## Details diff --git a/docs/core/components/json-cell.component.md b/docs/core/components/json-cell.component.md index 73a986c2c4..d4517394a5 100644 --- a/docs/core/components/json-cell.component.md +++ b/docs/core/components/json-cell.component.md @@ -39,15 +39,15 @@ You can specify the cell inside the `app.config.json` file: ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| column | [`DataColumn`](../../../lib/core/datatable/data/data-column.model.ts) | | Data that defines the column. | -| copyContent | `boolean` | | Enables/disables a [Clipboard directive](../../core/directives/clipboard.directive.md) to allow copying of the cell's content. | -| data | [`DataTableAdapter`](../../../lib/core/datatable/data/datatable-adapter.ts) | | Data table adapter instance. | -| editable | `boolean` | false | Editable JSON. | -| resolverFn | `Function` | null | Custom resolver function which is used to parse dynamic column objects | -| row | [`DataRow`](../../../lib/core/datatable/data/data-row.model.ts) | | Data that defines the row. | -| tooltip | `string` | | Text for the cell's tooltip. | +| Name | Type | Default value | Description | +| ----------- | --------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------ | +| column | [`DataColumn`](../../../lib/core/datatable/data/data-column.model.ts) | | Data that defines the column. | +| copyContent | `boolean` | | Enables/disables a [Clipboard directive](../../core/directives/clipboard.directive.md) to allow copying of the cell's content. | +| data | [`DataTableAdapter`](../../../lib/core/datatable/data/datatable-adapter.ts) | | Data table adapter instance. | +| editable | `boolean` | false | Editable JSON. | +| resolverFn | `Function` | null | Custom resolver function which is used to parse dynamic column objects | +| row | [`DataRow`](../../../lib/core/datatable/data/data-row.model.ts) | | Data that defines the row. | +| tooltip | `string` | | Text for the cell's tooltip. | ## Details diff --git a/docs/core/components/login-dialog-panel.component.md b/docs/core/components/login-dialog-panel.component.md index 560f6250d9..d238f1cf39 100644 --- a/docs/core/components/login-dialog-panel.component.md +++ b/docs/core/components/login-dialog-panel.component.md @@ -13,8 +13,8 @@ Shows and manages a login dialog. ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| ------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginSuccessEvent`](../../../lib/core/login/models/login-success.event.ts)`>` | Emitted when the login succeeds. | ## Details diff --git a/docs/core/components/login.component.md b/docs/core/components/login.component.md index 5625781a51..cd15bc7494 100644 --- a/docs/core/components/login.component.md +++ b/docs/core/components/login.component.md @@ -75,25 +75,25 @@ with custom input fields handled by your application or parent component: ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| backgroundImageUrl | `string` | | Path to a custom background image. | -| copyrightText | `string` | | The copyright text below the login box. | -| fieldsValidation | `any` | | Custom validation rules for the login form. | -| logoImageUrl | `string` | | Path to a custom logo image. | -| needHelpLink | `string` | "" | Sets the URL of the NEED HELP link in the footer. | -| registerLink | `string` | "" | Sets the URL of the REGISTER link in the footer. | -| showLoginActions | `boolean` | true | Should the extra actions (`Need Help`, `Register`, etc) be shown? | -| showRememberMe | `boolean` | true | Should the `Remember me` checkbox be shown? When selected, this option will remember the logged-in user after the browser is closed to avoid logging in repeatedly. | -| successRoute | `string` | null | Route to redirect to on successful login. | +| Name | Type | Default value | Description | +| ------------------ | --------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| backgroundImageUrl | `string` | | Path to a custom background image. | +| copyrightText | `string` | | The copyright text below the login box. | +| fieldsValidation | `any` | | Custom validation rules for the login form. | +| logoImageUrl | `string` | | Path to a custom logo image. | +| needHelpLink | `string` | "" | Sets the URL of the NEED HELP link in the footer. | +| registerLink | `string` | "" | Sets the URL of the REGISTER link in the footer. | +| showLoginActions | `boolean` | true | Should the extra actions (`Need Help`, `Register`, etc) be shown? | +| showRememberMe | `boolean` | true | Should the `Remember me` checkbox be shown? When selected, this option will remember the logged-in user after the browser is closed to avoid logging in repeatedly. | +| successRoute | `string` | null | Route to redirect to on successful login. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginErrorEvent`](../../../lib/core/login/models/login-error.event.ts)`>` | Emitted when the login fails. | -| executeSubmit | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginSubmitEvent`](../../../lib/core/login/models/login-submit.event.ts)`>` | Emitted when the login form is submitted. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginSuccessEvent`](../../../lib/core/login/models/login-success.event.ts)`>` | Emitted when the login is successful. | +| Name | Type | Description | +| ------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginErrorEvent`](../../../lib/core/login/models/login-error.event.ts)`>` | Emitted when the login fails. | +| executeSubmit | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginSubmitEvent`](../../../lib/core/login/models/login-submit.event.ts)`>` | Emitted when the login form is submitted. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginSuccessEvent`](../../../lib/core/login/models/login-success.event.ts)`>` | Emitted when the login is successful. | ## Details diff --git a/docs/core/components/notification-history.component.md b/docs/core/components/notification-history.component.md index ed9263396b..902f4d60ea 100644 --- a/docs/core/components/notification-history.component.md +++ b/docs/core/components/notification-history.component.md @@ -22,7 +22,7 @@ The main purpose of the [Notification history component](../../core/components/n ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| menuPositionX | `string` | "after" | Custom choice for opening the menu at the bottom. Can be `before` or `after`. | -| menuPositionY | `string` | "below" | Custom choice for opening the menu at the bottom. Can be `above` or `below`. | +| Name | Type | Default value | Description | +| ------------- | -------- | ------------- | ----------------------------------------------------------------------------- | +| menuPositionX | `string` | "after" | Custom choice for opening the menu at the bottom. Can be `before` or `after`. | +| menuPositionY | `string` | "below" | Custom choice for opening the menu at the bottom. Can be `above` or `below`. | diff --git a/docs/core/components/pagination.component.md b/docs/core/components/pagination.component.md index 034de55072..01d4200316 100644 --- a/docs/core/components/pagination.component.md +++ b/docs/core/components/pagination.component.md @@ -40,21 +40,21 @@ Adds pagination to the component it is used with. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| supportedPageSizes | `number[]` | | An array of page sizes. | -| target | [`PaginatedComponent`](../../../lib/core/pagination/paginated-component.interface.ts) | | Component that provides custom pagination support. | -| pagination | [`PaginationModel`](../../../lib/core/models/pagination.model.ts) | | Pagination object. | +| Name | Type | Default value | Description | +| ------------------ | ------------------------------------------------------------------------------------- | ------------- | -------------------------------------------------- | +| supportedPageSizes | `number[]` | | An array of page sizes. | +| target | [`PaginatedComponent`](../../../lib/core/pagination/paginated-component.interface.ts) | | Component that provides custom pagination support. | +| pagination | [`PaginationModel`](../../../lib/core/models/pagination.model.ts) | | Pagination object. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| change | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/models/pagination.model.ts)`>` | Emitted when pagination changes in any way. | -| changePageNumber | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/models/pagination.model.ts)`>` | Emitted when the page number changes. | -| changePageSize | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/models/pagination.model.ts)`>` | Emitted when the page size changes. | -| nextPage | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/models/pagination.model.ts)`>` | Emitted when the next page is requested. | -| prevPage | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/models/pagination.model.ts)`>` | Emitted when the previous page is requested. | +| Name | Type | Description | +| ---------------- | --------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | +| change | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/models/pagination.model.ts)`>` | Emitted when pagination changes in any way. | +| changePageNumber | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/models/pagination.model.ts)`>` | Emitted when the page number changes. | +| changePageSize | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/models/pagination.model.ts)`>` | Emitted when the page size changes. | +| nextPage | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/models/pagination.model.ts)`>` | Emitted when the next page is requested. | +| prevPage | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/models/pagination.model.ts)`>` | Emitted when the previous page is requested. | ## Details diff --git a/docs/core/components/search-text-input.component.md b/docs/core/components/search-text-input.component.md index 8dd7540f4e..069dc6c7e0 100644 --- a/docs/core/components/search-text-input.component.md +++ b/docs/core/components/search-text-input.component.md @@ -26,24 +26,24 @@ Displays a input text that supports autocompletion ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| autocomplete | `boolean` | false | Toggles auto-completion of the search input field. | -| collapseOnSubmit | `boolean` | true | Collapse search bar on submit. | -| debounceTime | `number` | 0 | Debounce time in milliseconds. | -| defaultState | `SearchTextStateEnum` | | Default state expanded or Collapsed. | -| expandable | `boolean` | true | Toggles whether to use an expanding search control. If false then a regular input is used. | -| focusListener | [`Observable`](http://reactivex.io/documentation/observable.html)`` | | Listener for results-list events (focus, blur and focusout). | -| inputType | `string` | "text" | Type of the input field to render, e.g. "search" or "text" (default). | -| liveSearchEnabled | `boolean` | true | Toggles "find-as-you-type" suggestions for possible matches. | -| searchAutocomplete | `any` | false | Trigger autocomplete results on input change. | -| searchTerm | `string` | "" | Search term preselected | +| Name | Type | Default value | Description | +| ------------------ | ------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------ | +| autocomplete | `boolean` | false | Toggles auto-completion of the search input field. | +| collapseOnSubmit | `boolean` | true | Collapse search bar on submit. | +| debounceTime | `number` | 0 | Debounce time in milliseconds. | +| defaultState | `SearchTextStateEnum` | | Default state expanded or Collapsed. | +| expandable | `boolean` | true | Toggles whether to use an expanding search control. If false then a regular input is used. | +| focusListener | [`Observable`](http://reactivex.io/documentation/observable.html)`` | | Listener for results-list events (focus, blur and focusout). | +| inputType | `string` | "text" | Type of the input field to render, e.g. "search" or "text" (default). | +| liveSearchEnabled | `boolean` | true | Toggles "find-as-you-type" suggestions for possible matches. | +| searchAutocomplete | `any` | false | Trigger autocomplete results on input change. | +| searchTerm | `string` | "" | Search term preselected | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| reset | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the result list is reset | -| searchChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the search term is changed. The search term is provided in the 'value' property of the returned object. If the term is less than three characters in length then it is truncated to an empty string. | -| selectResult | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the result list is selected | -| submit | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the search is submitted by pressing the ENTER key. The search term is provided as the value of the event. | +| Name | Type | Description | +| ------------ | --------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| reset | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the result list is reset | +| searchChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the search term is changed. The search term is provided in the 'value' property of the returned object. If the term is less than three characters in length then it is truncated to an empty string. | +| selectResult | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the result list is selected | +| submit | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the search is submitted by pressing the ENTER key. The search term is provided as the value of the event. | diff --git a/docs/core/components/sidebar-action-menu.component.md b/docs/core/components/sidebar-action-menu.component.md index aac06d52a4..843cb181af 100644 --- a/docs/core/components/sidebar-action-menu.component.md +++ b/docs/core/components/sidebar-action-menu.component.md @@ -42,11 +42,11 @@ the following names: ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| expanded | `boolean` | | Toggle the sidebar action menu on expand. | -| title | `string` | | The title of the sidebar action. | -| width | `number` | 272 | Width in pixels for sidebar action menu options. | +| Name | Type | Default value | Description | +| -------- | --------- | ------------- | ------------------------------------------------ | +| expanded | `boolean` | | Toggle the sidebar action menu on expand. | +| title | `string` | | The title of the sidebar action. | +| width | `number` | 272 | Width in pixels for sidebar action menu options. | ## Details diff --git a/docs/core/components/sidenav-layout.component.md b/docs/core/components/sidenav-layout.component.md index 12c571a1e2..669e86a05c 100644 --- a/docs/core/components/sidenav-layout.component.md +++ b/docs/core/components/sidenav-layout.component.md @@ -67,19 +67,19 @@ sub-components (note the use of `` in the sub-components' body sect ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| expandedSidenav | `boolean` | true | Should the navigation region be expanded initially? | -| hideSidenav | `boolean` | false | Toggles showing/hiding the navigation region. | -| position | `string` | "start" | The side that the drawer is attached to. Possible values are 'start' and 'end'. | -| sidenavMax | `number` | | Maximum size of the navigation region. | -| sidenavMin | `number` | | Minimum size of the navigation region. | -| stepOver | `number` | | Screen size at which display switches from small screen to large screen configuration. | +| Name | Type | Default value | Description | +| --------------- | --------- | ------------- | -------------------------------------------------------------------------------------- | +| expandedSidenav | `boolean` | true | Should the navigation region be expanded initially? | +| hideSidenav | `boolean` | false | Toggles showing/hiding the navigation region. | +| position | `string` | "start" | The side that the drawer is attached to. Possible values are 'start' and 'end'. | +| sidenavMax | `number` | | Maximum size of the navigation region. | +| sidenavMin | `number` | | Minimum size of the navigation region. | +| stepOver | `number` | | Screen size at which display switches from small screen to large screen configuration. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| -------- | --------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | expanded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the menu toggle and the collapsed/expanded state of the sideNav changes. | ## Details @@ -124,9 +124,9 @@ Each template is given a context containing the following methods: Beside the template context's **isMenuMinimized** variable, another way to listen to the component's menu's open/closed state is with the `menuOpenState$` observable, which is driven by a `BehaviorSubject` in the background. The value emitted by this observable is the opposite of the `isMenuMinimized` template variable. -| Name | Type | Default | Description | -| ---- | ---- | ------- | ----------- | -| menuOpenState$ | [`Observable`](http://reactivex.io/documentation/observable.html)<boolean> | true | Another way to listen to menu open/closed state | +| Name | Type | Default | Description | +| -------------- | ----------------------------------------------------------------------------- | ------- | ----------------------------------------------- | +| menuOpenState$ | [`Observable`](http://reactivex.io/documentation/observable.html)<boolean> | true | Another way to listen to menu open/closed state | Every time the menu state is changed, the following values are emitted: diff --git a/docs/core/components/sorting-picker.component.md b/docs/core/components/sorting-picker.component.md index 8c1a20d787..e1009d5143 100644 --- a/docs/core/components/sorting-picker.component.md +++ b/docs/core/components/sorting-picker.component.md @@ -26,18 +26,18 @@ Selects from a set of predefined sorting definitions and directions. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| ascending | `boolean` | true | Current sorting direction | -| options | `Array` | \[] | Available sorting options | -| selected | `string` | | Currently selected option key | +| Name | Type | Default value | Description | +| --------- | ----------------- | ------------- | ----------------------------- | +| ascending | `boolean` | true | Current sorting direction | +| options | `Array` | \[] | Available sorting options | +| selected | `string` | | Currently selected option key | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| sortingChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Raised each time direction gets changed. | -| valueChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Raised each time sorting key gets changed. | +| Name | Type | Description | +| ------------- | --------------------------------------------------------------------- | ------------------------------------------ | +| sortingChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Raised each time direction gets changed. | +| valueChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Raised each time sorting key gets changed. | ## Details diff --git a/docs/core/components/start-form.component.md b/docs/core/components/start-form.component.md index 5c631746c4..75184ed33d 100644 --- a/docs/core/components/start-form.component.md +++ b/docs/core/components/start-form.component.md @@ -24,45 +24,46 @@ Displays the Start [`Form`](../../../lib/process-services/src/lib/task-list/mode ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| 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. | -| 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. | -| nameNode | `string` | | Name to assign to the new node where the metadata are stored. | -| nodeId | `string` | | Content Services node ID for the form metadata. | -| path | `string` | | Path of the folder where the metadata will be stored. | -| processDefinitionId | `string` | | [Definition](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/definition.ts) ID of the process to start, this parameter can not be use in combination with processId | -| processId | `string` | | Process ID of the process to start, this parameter can not be use in combination with processDefinitionId | -| readOnly | `boolean` | false | Toggle readonly state of the form. Forces all form widgets to render as readonly if enabled. | -| readOnlyForm | `boolean` | false | Is the form read-only (ie, can't be edited)? | -| saveMetadata | `boolean` | false | Toggle saving of form metadata. | -| showCompleteButton | `boolean` | true | Toggle rendering of the `Complete` outcome button. | -| showOutcomeButtons | `boolean` | true | Should form outcome buttons be shown? | -| showRefreshButton | `boolean` | true | Should the refresh button be shown? | -| showSaveButton | `boolean` | true | Toggle rendering of the `Save` outcome button. | -| 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. | +| Name | Type | Default value | Description | +| ------------------------- | -------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| 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. | +| enableFixedSpacedForm | `boolean` | true | The form will set a prefixed space for invisible fields. | +| 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. | +| nameNode | `string` | | Name to assign to the new node where the metadata are stored. | +| nodeId | `string` | | Content Services node ID for the form metadata. | +| path | `string` | | Path of the folder where the metadata will be stored. | +| processDefinitionId | `string` | | [Definition](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/definition.ts) ID of the process to start, this parameter can not be use in combination with processId | +| processId | `string` | | Process ID of the process to start, this parameter can not be use in combination with processDefinitionId | +| readOnly | `boolean` | false | Toggle readonly state of the form. Forces all form widgets to render as readonly if enabled. | +| readOnlyForm | `boolean` | false | Is the form read-only (ie, can't be edited)? | +| saveMetadata | `boolean` | false | Toggle saving of form metadata. | +| showCompleteButton | `boolean` | true | Toggle rendering of the `Complete` outcome button. | +| showOutcomeButtons | `boolean` | true | Should form outcome buttons be shown? | +| showRefreshButton | `boolean` | true | Should the refresh button be shown? | +| showSaveButton | `boolean` | true | Toggle rendering of the `Save` outcome button. | +| 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. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when any error occurs. | -| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. | -| formCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. | -| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when a field of the form is clicked. | -| formDataRefreshed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when form values are refreshed due to a data property change. | -| formError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormFieldModel`](../../core/models/form-field.model.md)`[]>` | Emitted when the supplied form values have a validation error. | -| formLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is loaded or reloaded. | -| formSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Save` or custom outcomes. | -| outcomeClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the user clicks one of the outcome buttons that completes the form. | +| Name | Type | Description | +| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when any error occurs. | +| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. | +| formCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. | +| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when a field of the form is clicked. | +| formDataRefreshed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when form values are refreshed due to a data property change. | +| formError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormFieldModel`](../../core/models/form-field.model.md)`[]>` | Emitted when the supplied form values have a validation error. | +| formLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is loaded or reloaded. | +| formSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Save` or custom outcomes. | +| outcomeClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the user clicks one of the outcome buttons that completes the form. | ## Details diff --git a/docs/core/components/text-mask.component.md b/docs/core/components/text-mask.component.md index f9cf465d84..ab45dd881d 100644 --- a/docs/core/components/text-mask.component.md +++ b/docs/core/components/text-mask.component.md @@ -19,9 +19,9 @@ Implements text field input masks. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| inputMask | `Function` | | Object defining mask and "reversed" status. | +| Name | Type | Default value | Description | +| --------- | ---------- | ------------- | ------------------------------------------- | +| inputMask | `Function` | | Object defining mask and "reversed" status. | ## Details diff --git a/docs/core/components/toolbar.component.md b/docs/core/components/toolbar.component.md index 741fa577d7..3124e7b9c9 100644 --- a/docs/core/components/toolbar.component.md +++ b/docs/core/components/toolbar.component.md @@ -72,10 +72,10 @@ pushed to the right by a spacer: ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| color | [`ThemePalette`](https://github.com/angular/components/blob/master/src/material/core/common-behaviors/color.ts) | | Toolbar color. Can be changed to empty value (default), `primary`, `accent` or `warn`. | -| title | `string` | "" | Toolbar title. | +| Name | Type | Default value | Description | +| ----- | --------------------------------------------------------------------------------------------------------------- | ------------- | -------------------------------------------------------------------------------------- | +| color | [`ThemePalette`](https://github.com/angular/components/blob/master/src/material/core/common-behaviors/color.ts) | | Toolbar color. Can be changed to empty value (default), `primary`, `accent` or `warn`. | +| title | `string` | "" | Toolbar title. | ## Details diff --git a/docs/core/components/user-info.component.md b/docs/core/components/user-info.component.md index 4732b194a1..40c1759929 100644 --- a/docs/core/components/user-info.component.md +++ b/docs/core/components/user-info.component.md @@ -19,14 +19,14 @@ Shows user information. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| bpmBackgroundImage | `string` | | Custom path for the background banner image for APS users. | -| ecmBackgroundImage | `string` | | Custom path for the background banner image for ACS users. | -| menuPositionX | [`MenuPositionX`](https://github.com/angular/components/blob/master/src/material/menu/menu-positions.ts) | "after" | Custom choice for opening the menu at the bottom. Can be `before` or `after`. | -| menuPositionY | [`MenuPositionY`](https://github.com/angular/components/blob/master/src/material/menu/menu-positions.ts) | "below" | Custom choice for opening the menu at the bottom. Can be `above` or `below`. | -| namePosition | `string` | "right" | When the username is shown, this defines its position relative to the user info button. Can be `right` or `left`. | -| showName | `boolean` | true | Shows/hides the username next to the user info button. | +| Name | Type | Default value | Description | +| ------------------ | -------------------------------------------------------------------------------------------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------- | +| bpmBackgroundImage | `string` | | Custom path for the background banner image for APS users. | +| ecmBackgroundImage | `string` | | Custom path for the background banner image for ACS users. | +| menuPositionX | [`MenuPositionX`](https://github.com/angular/components/blob/master/src/material/menu/menu-positions.ts) | "after" | Custom choice for opening the menu at the bottom. Can be `before` or `after`. | +| menuPositionY | [`MenuPositionY`](https://github.com/angular/components/blob/master/src/material/menu/menu-positions.ts) | "below" | Custom choice for opening the menu at the bottom. Can be `above` or `below`. | +| namePosition | `string` | "right" | When the username is shown, this defines its position relative to the user info button. Can be `right` or `left`. | +| showName | `boolean` | true | Shows/hides the username next to the user info button. | ## Details diff --git a/docs/core/components/viewer.component.md b/docs/core/components/viewer.component.md index 08ca87dcb6..2bf0590b69 100644 --- a/docs/core/components/viewer.component.md +++ b/docs/core/components/viewer.component.md @@ -74,57 +74,57 @@ See the [Custom layout](#custom-layout) section for full details of all availabl ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| allowDownload | `boolean` | true | Toggles downloading. | -| allowFullScreen | `boolean` | true | Toggles the 'Full Screen' feature. | -| allowGoBack | `boolean` | true | Allows `back` navigation | -| allowLeftSidebar | `boolean` | false | Allow the left the sidebar. | -| allowNavigate | `boolean` | false | Toggles before/next navigation. You can use the arrow buttons to navigate between documents in the collection. | -| allowPrint | `boolean` | false | Toggles printing. | -| allowRightSidebar | `boolean` | false | Allow the right sidebar. | -| allowThumbnails | `boolean` | true | Toggles PDF thumbnails. | -| blobFile | [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) | | Loads a [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) File | -| canNavigateBefore | `boolean` | true | Toggles the "before" ("<") button. Requires `allowNavigate` to be enabled. | -| canNavigateNext | `boolean` | true | Toggles the next (">") button. Requires `allowNavigate` to be enabled. | -| displayName | `string` | | Specifies the name of the file when it is not available from the URL. | -| fileName | `string` | | Content filename. | -| maxRetries | `number` | 30 | Number of times the Viewer will retry fetching content Rendition. There is a delay of at least one second between attempts. | -| mimeType | `string` | | MIME type of the file content (when not determined by the filename extension). | -| nodeId | `string` | null | [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) Id of the file to load. | -| overlayMode | `boolean` | false | If `true` then show the Viewer as a full page over the current content. Otherwise fit inside the parent div. | -| sharedLinkId | `string` | null | Shared link id (to display shared file). | -| showLeftSidebar | `boolean` | false | Toggles left sidebar visibility. Requires `allowLeftSidebar` to be set to `true`. | -| showRightSidebar | `boolean` | false | Toggles right sidebar visibility. Requires `allowRightSidebar` to be set to `true`. | -| showToolbar | `boolean` | true | Hide or show the toolbar | -| showViewer | `boolean` | true | Hide or show the viewer | -| sidebarLeftTemplate | [`TemplateRef`](https://angular.io/api/core/TemplateRef)`` | null | The template for the left sidebar. The template context contains the loaded node data. | -| sidebarRightTemplate | [`TemplateRef`](https://angular.io/api/core/TemplateRef)`` | null | The template for the right sidebar. The template context contains the loaded node data. | -| thumbnailsTemplate | [`TemplateRef`](https://angular.io/api/core/TemplateRef)`` | null | The template for the pdf thumbnails. | -| urlFile | `string` | "" | If you want to load an external file that does not come from ACS you can use this URL to specify where to load the file from. | -| urlFileViewer | `string` | null | Viewer to use with the `urlFile` address (`pdf`, `image`, `media`, `text`). Used when `urlFile` has no filename and extension. | -| versionId | `string` | null | Version Id of the file to load. | +| Name | Type | Default value | Description | +| -------------------- | --------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------ | +| allowDownload | `boolean` | true | Toggles downloading. | +| allowFullScreen | `boolean` | true | Toggles the 'Full Screen' feature. | +| allowGoBack | `boolean` | true | Allows `back` navigation | +| allowLeftSidebar | `boolean` | false | Allow the left the sidebar. | +| allowNavigate | `boolean` | false | Toggles before/next navigation. You can use the arrow buttons to navigate between documents in the collection. | +| allowPrint | `boolean` | false | Toggles printing. | +| allowRightSidebar | `boolean` | false | Allow the right sidebar. | +| allowThumbnails | `boolean` | true | Toggles PDF thumbnails. | +| blobFile | [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) | | Loads a [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) File | +| canNavigateBefore | `boolean` | true | Toggles the "before" ("<") button. Requires `allowNavigate` to be enabled. | +| canNavigateNext | `boolean` | true | Toggles the next (">") button. Requires `allowNavigate` to be enabled. | +| displayName | `string` | | Specifies the name of the file when it is not available from the URL. | +| fileName | `string` | | Content filename. | +| maxRetries | `number` | 30 | Number of times the Viewer will retry fetching content Rendition. There is a delay of at least one second between attempts. | +| mimeType | `string` | | MIME type of the file content (when not determined by the filename extension). | +| nodeId | `string` | null | [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) Id of the file to load. | +| overlayMode | `boolean` | false | If `true` then show the Viewer as a full page over the current content. Otherwise fit inside the parent div. | +| sharedLinkId | `string` | null | Shared link id (to display shared file). | +| showLeftSidebar | `boolean` | false | Toggles left sidebar visibility. Requires `allowLeftSidebar` to be set to `true`. | +| showRightSidebar | `boolean` | false | Toggles right sidebar visibility. Requires `allowRightSidebar` to be set to `true`. | +| showToolbar | `boolean` | true | Hide or show the toolbar | +| showViewer | `boolean` | true | Hide or show the viewer | +| sidebarLeftTemplate | [`TemplateRef`](https://angular.io/api/core/TemplateRef)`` | null | The template for the left sidebar. The template context contains the loaded node data. | +| sidebarRightTemplate | [`TemplateRef`](https://angular.io/api/core/TemplateRef)`` | null | The template for the right sidebar. The template context contains the loaded node data. | +| thumbnailsTemplate | [`TemplateRef`](https://angular.io/api/core/TemplateRef)`` | null | The template for the pdf thumbnails. | +| urlFile | `string` | "" | If you want to load an external file that does not come from ACS you can use this URL to specify where to load the file from. | +| urlFileViewer | `string` | null | Viewer to use with the `urlFile` address (`pdf`, `image`, `media`, `text`). Used when `urlFile` has no filename and extension. | +| versionId | `string` | null | Version Id of the file to load. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| extensionChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the filename extension changes. | -| goBack | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../../lib/core/events/base.event.ts)`>` | Emitted when user clicks the 'Back' button. | -| invalidSharedLink | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the shared link used is not valid. | -| navigateBefore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when user clicks 'Navigate Before' ("<") button. | -| navigateNext | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when user clicks 'Navigate Next' (">") button. | -| print | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../../lib/core/events/base.event.ts)`>` | Emitted when user clicks the 'Print' button. | -| showViewerChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the viewer is shown or hidden. | +| Name | Type | Description | +| ----------------- | -------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | +| extensionChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the filename extension changes. | +| goBack | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../../lib/core/events/base.event.ts)`>` | Emitted when user clicks the 'Back' button. | +| invalidSharedLink | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the shared link used is not valid. | +| navigateBefore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when user clicks 'Navigate Before' ("<") button. | +| navigateNext | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when user clicks 'Navigate Next' (">") button. | +| print | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../../lib/core/events/base.event.ts)`>` | Emitted when user clicks the 'Print' button. | +| showViewerChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the viewer is shown or hidden. | ## Keyboard shortcuts -| Name | Description | -| ---- | ----------- | -| Esc | Close the viewer (overlay mode only). | -| Left | Invoke 'Navigate before' action. | -| Right | Invoke 'Navigate next' action. | -| Ctrl+F | Activate full-screen mode. | +| Name | Description | +| ------ | ------------------------------------- | +| Esc | Close the viewer (overlay mode only). | +| Left | Invoke 'Navigate before' action. | +| Right | Invoke 'Navigate next' action. | +| Ctrl+F | Activate full-screen mode. | ## Details diff --git a/docs/core/directives/check-allowable-operation.directive.md b/docs/core/directives/check-allowable-operation.directive.md index 0e84ae2603..ebdb870565 100644 --- a/docs/core/directives/check-allowable-operation.directive.md +++ b/docs/core/directives/check-allowable-operation.directive.md @@ -40,10 +40,10 @@ Selectively disables an HTML element or Angular component. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| nodes | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` | \[] | Nodes to check permission for. | -| permission | `string` | null | [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) permission to check (create, delete, update, updatePermissions, !create, !delete, !update, !updatePermissions). | +| Name | Type | Default value | Description | +| ---------- | ----------------------------------------------------------------------------------------------------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| nodes | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` | \[] | Nodes to check permission for. | +| permission | `string` | null | [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) permission to check (create, delete, update, updatePermissions, !create, !delete, !update, !updatePermissions). | ## Details diff --git a/docs/core/directives/clipboard.directive.md b/docs/core/directives/clipboard.directive.md index 0a29f4839f..913fdfdf2c 100644 --- a/docs/core/directives/clipboard.directive.md +++ b/docs/core/directives/clipboard.directive.md @@ -25,11 +25,11 @@ Copies text to the clipboard. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| message | `string` | | Translation key or message for snackbar notification. | -| placeholder | `string` | | Translation key or message for the tooltip. | -| target | [`HTMLInputElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement)` \| `[`HTMLTextAreaElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTextAreaElement) | | Reference to the HTML element containing the text to copy. | +| Name | Type | Default value | Description | +| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ---------------------------------------------------------- | +| message | `string` | | Translation key or message for snackbar notification. | +| placeholder | `string` | | Translation key or message for the tooltip. | +| target | [`HTMLInputElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement)` \| `[`HTMLTextAreaElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTextAreaElement) | | Reference to the HTML element containing the text to copy. | ## Details diff --git a/docs/core/directives/context-menu.directive.md b/docs/core/directives/context-menu.directive.md index 008eefecfc..24b0b86215 100644 --- a/docs/core/directives/context-menu.directive.md +++ b/docs/core/directives/context-menu.directive.md @@ -47,10 +47,10 @@ export class MyComponent implements OnInit { ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| enabled | `boolean` | false | Is the menu enabled? | -| links | `any[]` | | Items for the menu. | +| Name | Type | Default value | Description | +| ------- | --------- | ------------- | -------------------- | +| enabled | `boolean` | false | Is the menu enabled? | +| links | `any[]` | | Items for the menu. | ## Details diff --git a/docs/core/directives/highlight.directive.md b/docs/core/directives/highlight.directive.md index b877284716..4219debf39 100644 --- a/docs/core/directives/highlight.directive.md +++ b/docs/core/directives/highlight.directive.md @@ -25,11 +25,11 @@ Adds highlighting to selected sections of an HTML element's content. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| classToApply | `string` | "adf-highlight" | CSS class used to apply highlighting. | -| search | `string` | "" | Text to highlight. | -| selector | `string` | "" | Class selector for highlightable elements. | +| Name | Type | Default value | Description | +| ------------ | -------- | --------------- | ------------------------------------------ | +| classToApply | `string` | "adf-highlight" | CSS class used to apply highlighting. | +| search | `string` | "" | Text to highlight. | +| selector | `string` | "" | Class selector for highlightable elements. | ## Details diff --git a/docs/core/directives/logout.directive.md b/docs/core/directives/logout.directive.md index f3e39f96e3..3d155f441c 100644 --- a/docs/core/directives/logout.directive.md +++ b/docs/core/directives/logout.directive.md @@ -19,10 +19,10 @@ Logs the user out when the decorated element is clicked. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| enableRedirect | `boolean` | true | Enable redirecting after logout | -| redirectUri | `string` | "/login" | URI to redirect to after logging out. | +| Name | Type | Default value | Description | +| -------------- | --------- | ------------- | ------------------------------------- | +| enableRedirect | `boolean` | true | Enable redirecting after logout | +| redirectUri | `string` | "/login" | URI to redirect to after logging out. | ## Kerberos diff --git a/docs/core/directives/node-delete.directive.md b/docs/core/directives/node-delete.directive.md index d8310c2666..d6366b01a8 100644 --- a/docs/core/directives/node-delete.directive.md +++ b/docs/core/directives/node-delete.directive.md @@ -28,15 +28,15 @@ Deletes multiple files and folders. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| permanent | `boolean` | false | If true then the nodes are deleted immediately rather than being put in the trash | -| selection | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[] \| DeletedNodeEntity[]` | | Array of nodes to delete. | +| Name | Type | Default value | Description | +| --------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | --------------------------------------------------------------------------------- | +| permanent | `boolean` | false | If true then the nodes are deleted immediately rather than being put in the trash | +| selection | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[] \| DeletedNodeEntity[]` | | Array of nodes to delete. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| ------ | ----------------------------------------------------------------- | ----------------------------------------- | | delete | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the nodes have been deleted. | ## Details diff --git a/docs/core/directives/node-download.directive.md b/docs/core/directives/node-download.directive.md index 3af811b5fb..4591af63bc 100644 --- a/docs/core/directives/node-download.directive.md +++ b/docs/core/directives/node-download.directive.md @@ -29,7 +29,7 @@ Allows folders and/or files to be downloaded, with multiple nodes packed as a '. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| nodes | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)` \| `[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` | | Nodes to download. | -| version | [`VersionEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/VersionEntry.md) | | [Node's](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) version to download. | +| Name | Type | Default value | Description | +| ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------- | +| nodes | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)` \| `[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` | | Nodes to download. | +| version | [`VersionEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/VersionEntry.md) | | [Node's](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) version to download. | diff --git a/docs/core/directives/node-favorite.directive.md b/docs/core/directives/node-favorite.directive.md index 456c265c88..8a40233c78 100644 --- a/docs/core/directives/node-favorite.directive.md +++ b/docs/core/directives/node-favorite.directive.md @@ -41,15 +41,15 @@ export class MyComponent { ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| selection | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` | \[] | Array of nodes to toggle as favorites. | +| Name | Type | Default value | Description | +| --------- | ----------------------------------------------------------------------------------------------------------------------- | ------------- | -------------------------------------- | +| selection | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` | \[] | Array of nodes to toggle as favorites. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the favorite setting fails. | +| Name | Type | Description | +| ------ | ----------------------------------------------------------------- | ---------------------------------------------- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the favorite setting fails. | | toggle | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the favorite setting is complete. | ## Details diff --git a/docs/core/directives/node-restore.directive.md b/docs/core/directives/node-restore.directive.md index edb2b2dc00..4eaf6d24b9 100644 --- a/docs/core/directives/node-restore.directive.md +++ b/docs/core/directives/node-restore.directive.md @@ -48,14 +48,14 @@ Restores deleted nodes to their original location. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| selection | [`DeletedNodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/DeletedNodeEntry.md)`[]` | | Array of deleted nodes to restore. | +| Name | Type | Default value | Description | +| --------- | ------------------------------------------------------------------------------------------------------------------------------------ | ------------- | ---------------------------------- | +| selection | [`DeletedNodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/DeletedNodeEntry.md)`[]` | | Array of deleted nodes to restore. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| ------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | | restore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`RestoreMessageModel`](../../../lib/core/directives/node-restore.directive.ts)`>` | Emitted when restoration is complete. | ## Details diff --git a/docs/core/directives/upload.directive.md b/docs/core/directives/upload.directive.md index 7b464b8a0b..960ea0714e 100644 --- a/docs/core/directives/upload.directive.md +++ b/docs/core/directives/upload.directive.md @@ -21,14 +21,14 @@ Uploads content in response to file drag and drop. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| accept | `string` | | (Click mode only) MIME type filter for files to accept. | -| data | `any` | | Data to upload. | -| directory | `boolean` | | (Click mode only) Toggles uploading of directories. | -| enabled | `boolean` | true | Enables/disables uploading. | -| mode | `string[]` | ['drop'] | Upload mode. Can be "drop" (receives dropped files) or "click" (clicking opens a file dialog). Both modes can be active at once. | -| multiple | `boolean` | | Toggles multiple file uploads. | +| Name | Type | Default value | Description | +| --------- | ---------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------- | +| accept | `string` | | (Click mode only) MIME type filter for files to accept. | +| data | `any` | | Data to upload. | +| directory | `boolean` | | (Click mode only) Toggles uploading of directories. | +| enabled | `boolean` | true | Enables/disables uploading. | +| mode | `string[]` | ['drop'] | Upload mode. Can be "drop" (receives dropped files) or "click" (clicking opens a file dialog). Both modes can be active at once. | +| multiple | `boolean` | | Toggles multiple file uploads. | ## Details diff --git a/docs/core/directives/version-compatibility.directive.md b/docs/core/directives/version-compatibility.directive.md index 91e9b7e6a4..6e4e102a66 100644 --- a/docs/core/directives/version-compatibility.directive.md +++ b/docs/core/directives/version-compatibility.directive.md @@ -21,9 +21,9 @@ Enables/disables components based on ACS version in use. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| version | `void` | | Minimum version required for component to work correctly . | +| Name | Type | Default value | Description | +| ------- | ------ | ------------- | ---------------------------------------------------------- | +| version | `void` | | Minimum version required for component to work correctly . | ## Details diff --git a/docs/core/services/app-config.service.md b/docs/core/services/app-config.service.md index 968851b124..0e205e91a2 100644 --- a/docs/core/services/app-config.service.md +++ b/docs/core/services/app-config.service.md @@ -13,10 +13,10 @@ Supports app configuration settings, stored server side. ### Methods -- **get**(key: `string`, defaultValue?: )
+- **get**(key: `string`, defaultValue?: \`\`)
Gets the value of a named property. - _key:_ `string` - Name of the property - - _defaultValue:_ - (Optional) Value to return if the key is not found + - _defaultValue:_ \`\` - (Optional) Value to return if the key is not found - **getLocationHostname**(): `string`
Gets the location.hostname property. - **Returns** `string` - Value of the property @@ -107,11 +107,11 @@ The [`AppConfigService`](../../core/services/app-config.service.md) supports a l The supported variables are: -| Variable name | Runtime value | -| ------------- | ------------- | -| protocol | `location.protocol` | -| hostname | `location.hostname` | -| port | `location.port` | +| Variable name | Runtime value | +| ------------- | ------------------- | +| protocol | `location.protocol` | +| hostname | `location.hostname` | +| port | `location.port` | ## App Config onLoad Stream diff --git a/docs/core/services/authentication.service.md b/docs/core/services/authentication.service.md index 33c0b44076..5cd285868f 100644 --- a/docs/core/services/authentication.service.md +++ b/docs/core/services/authentication.service.md @@ -70,14 +70,12 @@ Provides authentication to ACS and APS. - _provider:_ `string` - - **Returns** `boolean` - - - **isOauth**(): `boolean`
Does the provider support OAuth? - **Returns** `boolean` - True if supported, false otherwise - **isPublicUrl**(): `boolean`
- **Returns** `boolean` - - - **isRememberMeSet**(): `boolean`
Checks whether the "remember me" cookie was set or not. - **Returns** `boolean` - True if set, false otherwise diff --git a/docs/core/services/card-item-types.service.md b/docs/core/services/card-item-types.service.md index 8ea69912a0..e33efad583 100644 --- a/docs/core/services/card-item-types.service.md +++ b/docs/core/services/card-item-types.service.md @@ -13,20 +13,20 @@ Maps type names to field component types for the [Card View component](../compon ### Methods -- **getComponentTypeResolver**(type: `string`, defaultValue: `Type<__type>` = `this.defaultValue`): [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts)
+- **getComponentTypeResolver**(type: `string`, defaultValue: `Type` = `this.defaultValue`): [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts)
Gets the currently active [DynamicComponentResolveFunction](../../../lib/core/services/dynamic-component-mapper.service.ts) for a field type. - _type:_ `string` - The type whose resolver you want - - _defaultValue:_ `Type<__type>` - Default type returned for types that are not yet mapped + - _defaultValue:_ `Type` - Default type returned for types that are not yet mapped - **Returns** [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts) - Resolver function - **register**(components: `Function`, override: `boolean` = `false`)
Register multiple components - _components:_ `Function` - - _override:_ `boolean` - -- **resolveComponentType**(model: [`DynamicComponentModel`](../../../lib/core/services/dynamic-component-mapper.service.ts), defaultValue: `Type<__type>` = `this.defaultValue`): `Type<__type>`
+- **resolveComponentType**(model: [`DynamicComponentModel`](../../../lib/core/services/dynamic-component-mapper.service.ts), defaultValue: `Type` = `this.defaultValue`): `Type`
Finds the component type that is needed to render a form field. - _model:_ [`DynamicComponentModel`](../../../lib/core/services/dynamic-component-mapper.service.ts) - [Form](../../../lib/process-services/src/lib/task-list/models/form.model.ts) field model for the field to render - - _defaultValue:_ `Type<__type>` - Default type returned for field types that are not yet mapped. - - **Returns** `Type<__type>` - Component type + - _defaultValue:_ `Type` - Default type returned for field types that are not yet mapped. + - **Returns** `Type` - Component type - **setComponentTypeResolver**(type: `string`, resolver: [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts), override: `boolean` = `true`)
Sets or optionally replaces a [DynamicComponentResolveFunction](../../../lib/core/services/dynamic-component-mapper.service.ts) for a field type. - _type:_ `string` - The type whose resolver you want to set @@ -42,15 +42,15 @@ model object as a parameter and returns the component type needed to display tha The default mapping is shown below: -| Type string | Component | -| ----------- | --------- | -| 'text' | [`CardViewTextItemComponent`](../../../lib/core/card-view/components/card-view-textitem/card-view-textitem.component.ts) | -| 'int' | [`CardViewTextItemComponent`](../../../lib/core/card-view/components/card-view-textitem/card-view-textitem.component.ts) | -| 'float' | [`CardViewTextItemComponent`](../../../lib/core/card-view/components/card-view-textitem/card-view-textitem.component.ts) | -| 'date' | [`CardViewDateItemComponent`](../../../lib/core/card-view/components/card-view-dateitem/card-view-dateitem.component.ts) | -| 'datetime' | [`CardViewDateItemComponent`](../../../lib/core/card-view/components/card-view-dateitem/card-view-dateitem.component.ts) | -| 'bool' | [`CardViewBoolItemComponent`](../../../lib/core/card-view/components/card-view-boolitem/card-view-boolitem.component.ts) | -| 'map' | [`CardViewMapItemComponent`](../../../lib/core/card-view/components/card-view-mapitem/card-view-mapitem.component.ts) | +| Type string | Component | +| ----------- | ------------------------------------------------------------------------------------------------------------------------ | +| 'text' | [`CardViewTextItemComponent`](../../../lib/core/card-view/components/card-view-textitem/card-view-textitem.component.ts) | +| 'int' | [`CardViewTextItemComponent`](../../../lib/core/card-view/components/card-view-textitem/card-view-textitem.component.ts) | +| 'float' | [`CardViewTextItemComponent`](../../../lib/core/card-view/components/card-view-textitem/card-view-textitem.component.ts) | +| 'date' | [`CardViewDateItemComponent`](../../../lib/core/card-view/components/card-view-dateitem/card-view-dateitem.component.ts) | +| 'datetime' | [`CardViewDateItemComponent`](../../../lib/core/card-view/components/card-view-dateitem/card-view-dateitem.component.ts) | +| 'bool' | [`CardViewBoolItemComponent`](../../../lib/core/card-view/components/card-view-boolitem/card-view-boolitem.component.ts) | +| 'map' | [`CardViewMapItemComponent`](../../../lib/core/card-view/components/card-view-mapitem/card-view-mapitem.component.ts) | ### Adding new type mappings diff --git a/docs/core/services/discovery-api.service.md b/docs/core/services/discovery-api.service.md index 5ef79e20b7..c032ac6443 100644 --- a/docs/core/services/discovery-api.service.md +++ b/docs/core/services/discovery-api.service.md @@ -16,7 +16,6 @@ Gets version and license information for Process Services and Content Services. - **getBPMSystemProperties**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SystemPropertiesRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/SystemPropertiesRepresentation.md)`>`
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SystemPropertiesRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/SystemPropertiesRepresentation.md)`>` - - - **getBpmProductInfo**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`BpmProductVersionModel`](../../../lib/core/models/product-version.model.ts)`>`
Gets product information for Process Services. - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`BpmProductVersionModel`](../../../lib/core/models/product-version.model.ts)`>` - ProductVersionModel containing product details diff --git a/docs/core/services/favorites-api.service.md b/docs/core/services/favorites-api.service.md index aca92821c6..8209cda25b 100644 --- a/docs/core/services/favorites-api.service.md +++ b/docs/core/services/favorites-api.service.md @@ -22,12 +22,10 @@ Gets a list of items a user has marked as their favorites. - _entries:_ `any[]` - - **Returns** `any[]` - - - **remapFavoritesData**(data: `any` = `{}`): [`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)
- _data:_ `any` - - **Returns** [`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md) - - - **remapEntry**(\_\_namedParameters: `Function`): `any`
- _\_\_namedParameters:_ `Function` - diff --git a/docs/core/services/form-rendering.service.md b/docs/core/services/form-rendering.service.md index e9d178a564..88b29fdcc5 100644 --- a/docs/core/services/form-rendering.service.md +++ b/docs/core/services/form-rendering.service.md @@ -13,20 +13,20 @@ Maps a form field type string onto the corresponding form [widget component](../ ### Methods -- **getComponentTypeResolver**(type: `string`, defaultValue: `Type<__type>` = `this.defaultValue`): [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts)
+- **getComponentTypeResolver**(type: `string`, defaultValue: `Type` = `this.defaultValue`): [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts)
Gets the currently active [DynamicComponentResolveFunction](../../../lib/core/services/dynamic-component-mapper.service.ts) for a field type. - _type:_ `string` - The type whose resolver you want - - _defaultValue:_ `Type<__type>` - Default type returned for types that are not yet mapped + - _defaultValue:_ `Type` - Default type returned for types that are not yet mapped - **Returns** [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts) - Resolver function - **register**(components: `Function`, override: `boolean` = `false`)
Register multiple components - _components:_ `Function` - - _override:_ `boolean` - -- **resolveComponentType**(model: [`DynamicComponentModel`](../../../lib/core/services/dynamic-component-mapper.service.ts), defaultValue: `Type<__type>` = `this.defaultValue`): `Type<__type>`
+- **resolveComponentType**(model: [`DynamicComponentModel`](../../../lib/core/services/dynamic-component-mapper.service.ts), defaultValue: `Type` = `this.defaultValue`): `Type`
Finds the component type that is needed to render a form field. - _model:_ [`DynamicComponentModel`](../../../lib/core/services/dynamic-component-mapper.service.ts) - [Form](../../../lib/process-services/src/lib/task-list/models/form.model.ts) field model for the field to render - - _defaultValue:_ `Type<__type>` - Default type returned for field types that are not yet mapped. - - **Returns** `Type<__type>` - Component type + - _defaultValue:_ `Type` - Default type returned for field types that are not yet mapped. + - **Returns** `Type` - Component type - **setComponentTypeResolver**(type: `string`, resolver: [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts), override: `boolean` = `true`)
Sets or optionally replaces a [DynamicComponentResolveFunction](../../../lib/core/services/dynamic-component-mapper.service.ts) for a field type. - _type:_ `string` - The type whose resolver you want to set @@ -66,25 +66,25 @@ formRenderingService.setComponentTypeResolver('text', customResolver, true); The [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) Rendering service is initialized with the mapping shown in the table below: -| Stencil name | Field type string | Component type | -| ------------ | ----------------- | -------------- | -| Amount | "amount" | [`AmountWidgetComponent`](../../../lib/core/form/components/widgets/amount/amount.widget.ts) | -| Attach | "upload" | AttachWidgetComponent or [`UploadWidgetComponent`](../../../lib/core/form/components/widgets/upload/upload.widget.ts) (based on metadata) | -| Checkbox | "boolean" | [`CheckboxWidgetComponent`](../../../lib/core/form/components/widgets/checkbox/checkbox.widget.ts) | -| Date | "date" | [`DateWidgetComponent`](../../../lib/core/form/components/widgets/date/date.widget.ts) | -| Display text | "readonly-text" | [`DisplayTextWidgetComponentComponent`](../../../lib/core/form/components/widgets/display-text/display-text.widget.ts) | -| Display value | "readonly" | DisplayValueWidgetComponent | -| Dropdown | "dropdown" | [`DropdownWidgetComponent`](../../../lib/core/form/components/widgets/dropdown/dropdown.widget.ts) | -| Dynamic table | "dynamic-table" | [`DynamicTableWidgetComponent`](../../../lib/core/form/components/widgets/dynamic-table/dynamic-table.widget.ts) | -| Group of people | "functional-group" | [`FunctionalGroupWidgetComponent`](../../../lib/core/form/components/widgets/functional-group/functional-group.widget.ts) | -| Header | "group" | [`ContainerWidgetComponent`](../../../lib/core/form/components/widgets/container/container.widget.ts) | -| Hyperlink | "hyperlink" | [`HyperlinkWidgetComponent`](../../../lib/core/form/components/widgets/hyperlink/hyperlink.widget.ts) | -| Multi-line text | "multi-line-text" | [`MultilineTextWidgetComponentComponent`](../../../lib/core/form/components/widgets/multiline-text/multiline-text.widget.ts) | -| Number | "integer" | [`NumberWidgetComponent`](../../../lib/core/form/components/widgets/number/number.widget.ts) | -| People | "people" | [`PeopleWidgetComponent`](../../../lib/core/form/components/widgets/people/people.widget.ts) | -| Radio buttons | "radio-buttons" | [`RadioButtonsWidgetComponent`](../../../lib/core/form/components/widgets/radio-buttons/radio-buttons.widget.ts) | -| Text | "text" | [`TextWidgetComponent`](../../../lib/core/form/components/widgets/text/text.widget.ts) | -| Typeahead | "typeahead" | [`TypeaheadWidgetComponent`](../../../lib/core/form/components/widgets/typeahead/typeahead.widget.ts) | +| Stencil name | Field type string | Component type | +| --------------- | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- | +| Amount | "amount" | [`AmountWidgetComponent`](../../../lib/core/form/components/widgets/amount/amount.widget.ts) | +| Attach | "upload" | AttachWidgetComponent or [`UploadWidgetComponent`](../../../lib/core/form/components/widgets/upload/upload.widget.ts) (based on metadata) | +| Checkbox | "boolean" | [`CheckboxWidgetComponent`](../../../lib/core/form/components/widgets/checkbox/checkbox.widget.ts) | +| Date | "date" | [`DateWidgetComponent`](../../../lib/core/form/components/widgets/date/date.widget.ts) | +| Display text | "readonly-text" | [`DisplayTextWidgetComponentComponent`](../../../lib/core/form/components/widgets/display-text/display-text.widget.ts) | +| Display value | "readonly" | DisplayValueWidgetComponent | +| Dropdown | "dropdown" | [`DropdownWidgetComponent`](../../../lib/core/form/components/widgets/dropdown/dropdown.widget.ts) | +| Dynamic table | "dynamic-table" | [`DynamicTableWidgetComponent`](../../../lib/core/form/components/widgets/dynamic-table/dynamic-table.widget.ts) | +| Group of people | "functional-group" | [`FunctionalGroupWidgetComponent`](../../../lib/core/form/components/widgets/functional-group/functional-group.widget.ts) | +| Header | "group" | [`ContainerWidgetComponent`](../../../lib/core/form/components/widgets/container/container.widget.ts) | +| Hyperlink | "hyperlink" | [`HyperlinkWidgetComponent`](../../../lib/core/form/components/widgets/hyperlink/hyperlink.widget.ts) | +| Multi-line text | "multi-line-text" | [`MultilineTextWidgetComponentComponent`](../../../lib/core/form/components/widgets/multiline-text/multiline-text.widget.ts) | +| Number | "integer" | [`NumberWidgetComponent`](../../../lib/core/form/components/widgets/number/number.widget.ts) | +| People | "people" | [`PeopleWidgetComponent`](../../../lib/core/form/components/widgets/people/people.widget.ts) | +| Radio buttons | "radio-buttons" | [`RadioButtonsWidgetComponent`](../../../lib/core/form/components/widgets/radio-buttons/radio-buttons.widget.ts) | +| Text | "text" | [`TextWidgetComponent`](../../../lib/core/form/components/widgets/text/text.widget.ts) | +| Typeahead | "typeahead" | [`TypeaheadWidgetComponent`](../../../lib/core/form/components/widgets/typeahead/typeahead.widget.ts) | You can add new items to the mapping or replace existing items in order to customize the way fields are rendered. diff --git a/docs/core/services/form.service.md b/docs/core/services/form.service.md index a1379ba751..dc94c3e709 100644 --- a/docs/core/services/form.service.md +++ b/docs/core/services/form.service.md @@ -37,18 +37,18 @@ class MyComponent { ### Events -| Name | Args Type | Description | -| ---- | --------- | ----------- | -| formLoaded | [`FormEvent`](../../../lib/core/form/events/form.event.ts) | Raised when form has been loaded or reloaded | -| formFieldValueChanged | [`FormFieldEvent`](../../../lib/core/form/events/form-field.event.ts) | Raised when input values change | -| taskCompleted | [`FormEvent`](../../../lib/core/form/events/form.event.ts) | Raised when a task is completed successfully | -| taskCompletedError | [`FormErrorEvent`](../../../lib/core/form/events/form-error.event.ts) | Raised when a task is completed unsuccessfully | -| taskSaved | [`FormEvent`](../../../lib/core/form/events/form.event.ts) | Raised when a task is saved successfully | -| taskSavedError | [`FormErrorEvent`](../../../lib/core/form/events/form-error.event.ts) | Raised when a task is saved unsuccessfully | -| executeOutcome | [`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts) | 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 | -| validateForm | [`ValidateFormEvent`](../../../lib/core/form/events/validate-form.event.ts) | Raised each time a form is validated. You can use it to provide custom validation or prevent default behaviour. | -| validateFormField | [`ValidateFormFieldEvent`](../../../lib/core/form/events/validate-form-field.event.ts) | Raised each time a form field is validated. You can use it to provide custom validation or prevent default behaviour. | +| Name | Args Type | Description | +| --------------------- | ------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| formLoaded | [`FormEvent`](../../../lib/core/form/events/form.event.ts) | Raised when form has been loaded or reloaded | +| formFieldValueChanged | [`FormFieldEvent`](../../../lib/core/form/events/form-field.event.ts) | Raised when input values change | +| taskCompleted | [`FormEvent`](../../../lib/core/form/events/form.event.ts) | Raised when a task is completed successfully | +| taskCompletedError | [`FormErrorEvent`](../../../lib/core/form/events/form-error.event.ts) | Raised when a task is completed unsuccessfully | +| taskSaved | [`FormEvent`](../../../lib/core/form/events/form.event.ts) | Raised when a task is saved successfully | +| taskSavedError | [`FormErrorEvent`](../../../lib/core/form/events/form-error.event.ts) | Raised when a task is saved unsuccessfully | +| executeOutcome | [`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts) | 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 | +| validateForm | [`ValidateFormEvent`](../../../lib/core/form/events/validate-form.event.ts) | Raised each time a form is validated. You can use it to provide custom validation or prevent default behaviour. | +| validateFormField | [`ValidateFormFieldEvent`](../../../lib/core/form/events/validate-form-field.event.ts) | Raised each time a form field is validated. You can use it to provide custom validation or prevent default behaviour. | ### Methods @@ -57,19 +57,24 @@ class MyComponent { - `json` - JSON to create the form - `data` - (Optional) Values for the form fields - `readOnly` - Should the form fields be read-only? + - `createFormFromANode(formName: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`` Create a [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) with a field for each metadata property. - `formName` - Name of the new form + - `createForm(formName: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`` Create a [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts). - `formName` - Name of the new form + - `saveForm(formId: string, formModel: FormDefinitionModel):`[`Observable`](http://reactivex.io/documentation/observable.html)`` Saves a form. - `formId` - ID of the form to save - `formModel` - Model data for the form + - `searchFrom(name: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`` Search for a form by name. - `name` - The form name to search for + - `getForms():`[`Observable`](http://reactivex.io/documentation/observable.html)`` Gets all the forms. @@ -79,77 +84,97 @@ class MyComponent { - `getProcessVariablesById(processInstanceId: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`` Get instance variables for a process. - `processInstanceId` - ID of the target process + - `getTasks():`[`Observable`](http://reactivex.io/documentation/observable.html)`` Gets all the tasks. - `getTask(taskId: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`` Gets a task. - `taskId` - Task Id + - `saveTaskForm(taskId: string, formValues: FormValues):`[`Observable`](http://reactivex.io/documentation/observable.html)`` Save Task [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts). - `taskId` - Task Id - `formValues` - [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) Values + - `completeTaskForm(taskId: string, formValues:`[`FormValues,`](../../../lib/core/form/components/widgets/core/form-values.ts)`outcome?: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`` Complete Task [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) - `taskId` - Task Id - `formValues` - [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) Values - `outcome` - (Optional) [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) Outcome + - `getTaskForm(taskId: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`` Get [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) related to a taskId - `taskId` - Task Id + - `getFormDefinitionById(formId: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`` - Get [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) [`Definition`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/definition.ts) + Get [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) [`Definition`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/definition.ts) - `formId` - [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) Id + - `getFormDefinitionByName(name: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`` Returns form definition with a given name. - `name` - The form name + - `getStartFormInstance(processId: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`` Get start form instance for a given processId - `processId` - Process definition ID + - `getProcessInstance(processId: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`` Gets a process instance. - `processId` - ID of the process to get + - `getStartFormDefinition(processId: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`` Get start form definition for a given process - `processId` - Process definition ID + - `getRestFieldValues(taskId: string, field: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`` Gets values of fields populated by a REST backend. - `taskId` - Task identifier - `field` - Field identifier + - `getRestFieldValuesByProcessId(processDefinitionId: string, field: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`` Gets values of fields populated by a REST backend using a process ID. - `processDefinitionId` - Process identifier - `field` - Field identifier + - `getRestFieldValuesColumnByProcessId(processDefinitionId: string, field: string, column?: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`` Gets column values of fields populated by a REST backend using a process ID. - `processDefinitionId` - Process identifier - `field` - Field identifier - `column` - (Optional) Column identifier + - `getRestFieldValuesColumn(taskId: string, field: string, column?: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`` Gets column values of fields populated by a REST backend. - `taskId` - Task identifier - `field` - Field identifier - `column` - (Optional) Column identifier + - `getUserProfileImageApi(userId: number): string` Returns a URL for the profile picture of a user. - `userId` - ID of the target user + - [`getWorkflowUsers(filter: string, groupId?: string): Observable`](../../core/models/user-process.model.md) Gets a list of workflow users. - `filter` - Filter to select specific users - `groupId` - (Optional) Group ID for the search + - [`getWorkflowGroups(filter: string, groupId?: string): Observable`](../../../lib/core/form/components/widgets/core/group.model.ts) Gets a list of groups in a workflow. - `filter` - Filter to select specific groups - `groupId` - (Optional) Group ID for the search + - `getFormId(res: any): string` Gets the ID of a form. - `res` - Object representing a form + - `toJson(res: any): any` Creates a JSON representation of form data. - `res` - Object representing form data + - `toJsonArray(res: any): any` Creates a JSON array representation of form data. - `res` - Object representing form data + - `handleError(error: any):`[`Observable`](http://reactivex.io/documentation/observable.html)`` Reports an error message. - `error` - Data object with optional \`message\` and \`status\` fields for the error diff --git a/docs/core/services/identity-group.service.md b/docs/core/services/identity-group.service.md index ba55d0d81b..0dd020bd92 100644 --- a/docs/core/services/identity-group.service.md +++ b/docs/core/services/identity-group.service.md @@ -13,6 +13,11 @@ Performs CRUD operations on identity groups. ### Methods +- **assignRoles**(groupId: `string`, roles: [`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ Assigns roles to the group + - _groupId:_ `string` - The ID of the group + - _roles:_ [`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]` - Array of roles to assign + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - - **checkGroupHasAnyClientAppRole**(groupId: `string`, clientId: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Check if a group has any of the client app roles in the supplied list. - _groupId:_ `string` - Id of the target group @@ -41,6 +46,10 @@ Performs CRUD operations on identity groups. Finds groups filtered by name. - _searchParams:_ [`IdentityGroupSearchParam`](../../../lib/core/models/identity-group.model.ts) - Object containing the name filter string - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`[]>` - List of group information +- **getAssignedRoles**(groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`
+ Gets assigned roles + - _groupId:_ `string` - Id of the group. + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>` - Array of available roles - **getAvailableRoles**(groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`
Gets available roles - _groupId:_ `string` - Id of the group. @@ -54,6 +63,10 @@ Performs CRUD operations on identity groups. - _groupId:_ `string` - Id of the target group - _clientId:_ `string` - Id of the client - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>` - List of roles +- **getEffectiveRoles**(groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`
+ Get effective roles + - _groupId:_ `string` - Id of the group + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>` - Array of effective roles - **getGroupRoles**(groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`
Gets details for a specified group. - _groupId:_ `string` - Id of the target group @@ -68,6 +81,11 @@ Performs CRUD operations on identity groups. Queries groups. - _requestQuery:_ [`IdentityGroupQueryCloudRequestModel`](../../../lib/core/models/identity-group.model.ts) - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupQueryResponse`](../../../lib/core/models/identity-group.model.ts)`>` - Array of user information objects +- **removeRoles**(groupId: `string`, roles: [`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ Removes roles from the group + - _groupId:_ `string` - The ID of the group + - _roles:_ [`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]` - Array of roles to remove + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - - **updateGroup**(groupId: `string`, updatedGroup: [`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
Updates group details. - _groupId:_ `string` - Id of the targeted group. diff --git a/docs/core/services/log.service.md b/docs/core/services/log.service.md index e20efac49a..3c1b8f3b4e 100644 --- a/docs/core/services/log.service.md +++ b/docs/core/services/log.service.md @@ -101,14 +101,14 @@ export class AppComponent { There are 6 levels of logs that you can use: -| Name | Level | -| ---- | ----- | -| TRACE | 5 | -| DEBUG | 4 | -| INFO | 3 | -| WARN | 2 | -| ERROR | 1 | -| SILENT | 0 | +| Name | Level | +| ------ | ----- | +| TRACE | 5 | +| DEBUG | 4 | +| INFO | 3 | +| WARN | 2 | +| ERROR | 1 | +| SILENT | 0 | You can set the default log level using the **_logLevel_** property in `app.config.json`. The factory setting for this property is `TRACE`. diff --git a/docs/core/services/node.service.md b/docs/core/services/node.service.md index 889734bbaf..6b591b8457 100644 --- a/docs/core/services/node.service.md +++ b/docs/core/services/node.service.md @@ -26,7 +26,7 @@ Gets Alfresco Repository node metadata and creates nodes with metadata. (**Deprecated:** in 3.8.0, use NodesApiService instead. Create a new Node from form metadata.) - _nodeType:_ `string` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) type - _nameSpace:_ `any` - Namespace for properties - - _data:_ `any` - [Property](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/property.ts) data to store in the node under namespace + - _data:_ `any` - [Property](../../../lib/content-services/src/lib/content-metadata/interfaces/property.interface.ts) data to store in the node under namespace - _path:_ `string` - Path to the node - _name:_ `string` - (Optional) [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) name - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - The created node diff --git a/docs/core/services/nodes-api.service.md b/docs/core/services/nodes-api.service.md index d3ccb49c5c..3f6b623201 100644 --- a/docs/core/services/nodes-api.service.md +++ b/docs/core/services/nodes-api.service.md @@ -47,7 +47,7 @@ Accesses and manipulates ACS document nodes using their node IDs. Create a new Node from form metadata. - _nodeType:_ `string` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) type - _nameSpace:_ `any` - Namespace for properties - - _data:_ `any` - [Property](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/property.ts) data to store in the node under namespace + - _data:_ `any` - [Property](../../../lib/content-services/src/lib/content-metadata/interfaces/property.interface.ts) data to store in the node under namespace - _path:_ `string` - Path to the node - _name:_ `string` - (Optional) [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) name - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - The created node diff --git a/docs/core/services/renditions.service.md b/docs/core/services/renditions.service.md index f3f4220c86..d301f78ab0 100644 --- a/docs/core/services/renditions.service.md +++ b/docs/core/services/renditions.service.md @@ -20,11 +20,11 @@ Manages prearranged conversions of content to different formats. - _pollingInterval:_ `number` - Time interval (in milliseconds) between checks for completion - _retries:_ `number` - Number of attempts to make before declaring failure - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RenditionEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/RenditionEntry.md)`>` - True if the rendition was created, false otherwise -- **createRendition**(nodeId: `string`, encoding: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<__type>`
+- **createRendition**(nodeId: `string`, encoding: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Creates a rendition for a node. - _nodeId:_ `string` - ID of the target node - _encoding:_ `string` - Name of the rendition encoding - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<__type>` - Null response to indicate completion + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null response to indicate completion - **generateRenditionForNode**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Generates a rendition for a node using the first available encoding. - _nodeId:_ `string` - ID of the target node diff --git a/docs/core/services/sites.service.md b/docs/core/services/sites.service.md index d4a939926b..c95d93de4b 100644 --- a/docs/core/services/sites.service.md +++ b/docs/core/services/sites.service.md @@ -48,24 +48,24 @@ Accesses and manipulates sites from a Content Services repository. - **getEcmCurrentLoggedUserName**(): `string`
Gets the username of the user currently logged into ACS. - **Returns** `string` - Username string -- **getSite**(siteId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`|__type>`
+- **getSite**(siteId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`|Function>`
Gets the details for a site. - _siteId:_ `string` - ID of the target site - _opts:_ `any` - (Optional) Options supported by JS-API - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`|__type>` - Information about the site -- **getSiteContent**(siteId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`|__type>`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`|Function>` - Information about the site +- **getSiteContent**(siteId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`|Function>`
Gets a site's content. - _siteId:_ `string` - ID of the target site - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`|__type>` - Site content + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`|Function>` - Site content - **getSiteGroupMembership**(siteId: `string`, groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteGroupEntry.md)`>`
Get information about site membership of group - _siteId:_ `string` - The identifier of a site. - _groupId:_ `string` - The authorityId of a group. - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteGroupEntry.md)`>` - [Observable](http://reactivex.io/documentation/observable.html)<SiteGroupEntry> -- **getSiteMembers**(siteId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`|__type>`
+- **getSiteMembers**(siteId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`|Function>`
Gets a list of all a site's members. - _siteId:_ `string` - ID of the target site - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`|__type>` - Site members + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`|Function>` - Site members - **getSiteMembershipRequests**(opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMembershipRequestWithPersonPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMembershipRequestWithPersonPaging.md)`>`
Gets a list of site membership requests. - _opts:_ `any` - (Optional) Options supported by JS-API @@ -78,11 +78,11 @@ Accesses and manipulates sites from a Content Services repository. Gets a list of all sites in the repository. - _opts:_ `any` - Options supported by JS-API - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SitePaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md)`>` - List of sites -- **listSiteGroups**(siteId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupPaging`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteGroupPaging.ts)`>`
+- **listSiteGroups**(siteId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteGroupPaging.ts)`>`
List group membership for site - _siteId:_ `string` - The identifier of a site. - _opts:_ `any` - (Optional) Options supported by JS-API - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupPaging`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteGroupPaging.ts)`>` - [Observable](http://reactivex.io/documentation/observable.html)<SiteGroupPaging> + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteGroupPaging.ts)`>` - [Observable](http://reactivex.io/documentation/observable.html)<SiteGroupPaging> - **listSiteMemberships**(siteId: `string`, opts: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMemberPaging.md)`>`
Gets a list of all a site's members. - _siteId:_ `string` - ID of the target site diff --git a/docs/core/services/thumbnail.service.md b/docs/core/services/thumbnail.service.md index 8b894cc639..0afae9895b 100644 --- a/docs/core/services/thumbnail.service.md +++ b/docs/core/services/thumbnail.service.md @@ -33,22 +33,22 @@ The service can locate a thumbnail icon (in SVG format) for either a document node or a MIME type. The default mapping between types and icons is shown in the table below: -| Document | Icon | Types | -| -------- | ---- | ----- | -| Compressed archive | ![Archive thumbnail](../../docassets/images/ft_ic_archive.png) | 'application/x-compressed', 'application/x-zip-compressed', 'application/zip' | -| Text | ![Text thumbnail](../../docassets/images/ft_ic_document.png) | 'text/plain', 'application/json', 'application/x-javascript', 'application/vnd.apple.pages' | -| Bitmap/raster image | ![Bitmap thumbnail](../../docassets/images/ft_ic_raster_image.png) | 'image/png', 'image/jpeg', 'image/gif' | -| MP4 video | ![MP4 thumbnail](../../docassets/images/ft_ic_video.png) | 'video/mp4' | -| SVG vector image | ![SVG thumbnail](../../docassets/images/ft_ic_vector_image.png) | 'image/svg+xml' | -| HTML file | ![HTML thumbnail](../../docassets/images/ft_ic_website.png) | 'text/html' | -| PDF file | ![PDF thumbnail](../../docassets/images/ft_ic_pdf.png) | 'application/pdf' | -| Folder | ![Folder thumbnail](../../docassets/images/ft_ic_folder.png) | | -| Disabled folder | ![Disabled folder thumbnail](../../docassets/images/ft_ic_folder_disable.png) | | -| Excel spreadsheet | ![Spreadsheet thumbnail](../../docassets/images/ft_ic_ms_excel.png) | 'application/vnd.ms-excel', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', 'application/vnd.openxmlformats-officedocument.spreadsheetml.template' | -| PowerPoint slideshow | ![PowerPoint thumbnail](../../docassets/images/ft_ic_ms_powerpoint.png) | 'application/vnd.ms-powerpoint', 'application/vnd.openxmlformats-officedocument.presentationml.presentation', 'application/vnd.openxmlformats-officedocument.presentationml.template', 'application/vnd.openxmlformats-officedocument.presentationml.slideshow' | -| Word document | ![Word thumbnail](../../docassets/images/ft_ic_ms_word.png) | 'application/msword', 'application/vnd.openxmlformats-officedocument.wordprocessingml.document', 'application/vnd.openxmlformats-officedocument.wordprocessingml.template' | -| Keynote presentation | ![Keynote thumbnail](../../docassets/images/ft_ic_presentation.png) | 'application/vnd.apple.keynote' | -| Numbers spreadsheet | ![Numbers thumbnail](../../docassets/images/ft_ic_spreadsheet.png) | 'application/vnd.apple.numbers' | +| Document | Icon | Types | +| -------------------- | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Compressed archive | ![Archive thumbnail](../../docassets/images/ft_ic_archive.png) | 'application/x-compressed', 'application/x-zip-compressed', 'application/zip' | +| Text | ![Text thumbnail](../../docassets/images/ft_ic_document.png) | 'text/plain', 'application/json', 'application/x-javascript', 'application/vnd.apple.pages' | +| Bitmap/raster image | ![Bitmap thumbnail](../../docassets/images/ft_ic_raster_image.png) | 'image/png', 'image/jpeg', 'image/gif' | +| MP4 video | ![MP4 thumbnail](../../docassets/images/ft_ic_video.png) | 'video/mp4' | +| SVG vector image | ![SVG thumbnail](../../docassets/images/ft_ic_vector_image.png) | 'image/svg+xml' | +| HTML file | ![HTML thumbnail](../../docassets/images/ft_ic_website.png) | 'text/html' | +| PDF file | ![PDF thumbnail](../../docassets/images/ft_ic_pdf.png) | 'application/pdf' | +| Folder | ![Folder thumbnail](../../docassets/images/ft_ic_folder.png) | | +| Disabled folder | ![Disabled folder thumbnail](../../docassets/images/ft_ic_folder_disable.png) | | +| Excel spreadsheet | ![Spreadsheet thumbnail](../../docassets/images/ft_ic_ms_excel.png) | 'application/vnd.ms-excel', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', 'application/vnd.openxmlformats-officedocument.spreadsheetml.template' | +| PowerPoint slideshow | ![PowerPoint thumbnail](../../docassets/images/ft_ic_ms_powerpoint.png) | 'application/vnd.ms-powerpoint', 'application/vnd.openxmlformats-officedocument.presentationml.presentation', 'application/vnd.openxmlformats-officedocument.presentationml.template', 'application/vnd.openxmlformats-officedocument.presentationml.slideshow' | +| Word document | ![Word thumbnail](../../docassets/images/ft_ic_ms_word.png) | 'application/msword', 'application/vnd.openxmlformats-officedocument.wordprocessingml.document', 'application/vnd.openxmlformats-officedocument.wordprocessingml.template' | +| Keynote presentation | ![Keynote thumbnail](../../docassets/images/ft_ic_presentation.png) | 'application/vnd.apple.keynote' | +| Numbers spreadsheet | ![Numbers thumbnail](../../docassets/images/ft_ic_spreadsheet.png) | 'application/vnd.apple.numbers' | ### Mat-icon diff --git a/docs/core/services/upload.service.md b/docs/core/services/upload.service.md index 0a73a47d59..d6cbc8ba24 100644 --- a/docs/core/services/upload.service.md +++ b/docs/core/services/upload.service.md @@ -38,18 +38,18 @@ Provides access to various APIs related to file upload features. ## Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| queueChanged | [`FileModel`](../../../lib/core/models/file.model.ts)\[] | Emitted when the file queue changes. | -| fileUpload | [`FileUploadEvent`](../../../lib/core/events/file.event.ts) | Emitted when a [File model](../../../lib/core/models/file.model.ts) changes its state. | -| fileUploadStarting | [`FileUploadEvent`](../../../lib/core/events/file.event.ts) | Emitted when an upload starts. | -| fileUploadCancelled | [`FileUploadEvent`](../../../lib/core/events/file.event.ts) | Emitted when an upload gets cancelled by the user. | -| fileUploadProgress | [`FileUploadEvent`](../../../lib/core/events/file.event.ts) | Emitted during the file upload process and contains the current progress for a particular [File model](../../../lib/core/models/file.model.ts). | -| fileUploadAborted | [`FileUploadEvent`](../../../lib/core/events/file.event.ts) | Emitted when a file upload gets aborted by the server. | -| fileUploadError | [`FileUploadEvent`](../../../lib/core/events/file.event.ts) | Emitted when an error occurs during a file upload. | -| fileUploadComplete | [`FileUploadCompleteEvent`](../../../lib/core/events/file.event.ts) | Emitted when a file upload is complete. | -| fileUploadDelete | [`FileUploadDeleteEvent`](../../../lib/core/events/file.event.ts) | Emitted when an uploaded file is removed from server. | -| fileDeleted | string | This can be invoked when a file is deleted from an external source to upload the file dialog status. | +| Name | Type | Description | +| ------------------- | ------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | +| queueChanged | [`FileModel`](../../../lib/core/models/file.model.ts)\[] | Emitted when the file queue changes. | +| fileUpload | [`FileUploadEvent`](../../../lib/core/events/file.event.ts) | Emitted when a [File model](../../../lib/core/models/file.model.ts) changes its state. | +| fileUploadStarting | [`FileUploadEvent`](../../../lib/core/events/file.event.ts) | Emitted when an upload starts. | +| fileUploadCancelled | [`FileUploadEvent`](../../../lib/core/events/file.event.ts) | Emitted when an upload gets cancelled by the user. | +| fileUploadProgress | [`FileUploadEvent`](../../../lib/core/events/file.event.ts) | Emitted during the file upload process and contains the current progress for a particular [File model](../../../lib/core/models/file.model.ts). | +| fileUploadAborted | [`FileUploadEvent`](../../../lib/core/events/file.event.ts) | Emitted when a file upload gets aborted by the server. | +| fileUploadError | [`FileUploadEvent`](../../../lib/core/events/file.event.ts) | Emitted when an error occurs during a file upload. | +| fileUploadComplete | [`FileUploadCompleteEvent`](../../../lib/core/events/file.event.ts) | Emitted when a file upload is complete. | +| fileUploadDelete | [`FileUploadDeleteEvent`](../../../lib/core/events/file.event.ts) | Emitted when an uploaded file is removed from server. | +| fileDeleted | string | This can be invoked when a file is deleted from an external source to upload the file dialog status. | ## Details diff --git a/docs/core/services/user-preferences.service.md b/docs/core/services/user-preferences.service.md index 27d1095ac5..e4f4026656 100644 --- a/docs/core/services/user-preferences.service.md +++ b/docs/core/services/user-preferences.service.md @@ -24,7 +24,7 @@ Stores preferences for the app and for individual components. - **getPropertyKey**(property: `string`): `string`
Gets the full property key with prefix. - _property:_ `string` - The property name - - **Returns** `string` - [Property](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/property.ts) key + - **Returns** `string` - [Property](../../../lib/content-services/src/lib/content-metadata/interfaces/property.interface.ts) key - **getStoragePrefix**(): `string`
Gets the active storage prefix for preferences. - **Returns** `string` - Storage prefix @@ -92,12 +92,12 @@ class AppComponent { The service also provides quick access to a set of the "known" properties used across ADF components: -| Name | Type | Description | -| ---- | ---- | ----------- | -| authType | `string` | Authorization type (can be "ECM", "BPM" or "ALL"). | -| disableCSRF | `boolean` | Prevents the CSRF Token from being submitted if true. Only valid for Process Services. | -| paginationSize | `number` | [`Pagination`](../../../lib/content-services/document-list/models/document-library.model.ts) size. | -| locale | `string` | Current locale setting. | +| Name | Type | Description | +| -------------- | --------- | -------------------------------------------------------------------------------------------------- | +| authType | `string` | Authorization type (can be "ECM", "BPM" or "ALL"). | +| disableCSRF | `boolean` | Prevents the CSRF Token from being submitted if true. Only valid for Process Services. | +| paginationSize | `number` | [`Pagination`](../../../lib/content-services/document-list/models/document-library.model.ts) size. | +| locale | `string` | Current locale setting. | ## User Preference onChange Stream diff --git a/docs/core/widgets/content.widget.md b/docs/core/widgets/content.widget.md index 30ad07c64d..f00cd495d0 100644 --- a/docs/core/widgets/content.widget.md +++ b/docs/core/widgets/content.widget.md @@ -20,16 +20,16 @@ Shows the content preview. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| id | `string` | | The content id to show. | -| showDocumentContent | `boolean` | true | Toggles showing document content. | +| Name | Type | Default value | Description | +| ------------------- | --------- | ------------- | --------------------------------- | +| id | `string` | | The content id to show. | +| showDocumentContent | `boolean` | true | Toggles showing document content. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| contentClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the content is clicked. | -| contentLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the content has loaded. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| Name | Type | Description | +| --------------- | ----------------------------------------------------------------- | -------------------------------------- | +| contentClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the content is clicked. | +| contentLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the content has loaded. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | | thumbnailLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the thumbnail has loaded. | diff --git a/docs/extensions/components/dynamic.component.md b/docs/extensions/components/dynamic.component.md index af4ad4f28a..ff37d9d7c7 100644 --- a/docs/extensions/components/dynamic.component.md +++ b/docs/extensions/components/dynamic.component.md @@ -13,10 +13,10 @@ Displays dynamically-loaded extension components. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| data | `any` | | Data for the dynamically-loaded component instance. | -| id | `string` | | Unique ID string for the component to show. | +| Name | Type | Default value | Description | +| ---- | -------- | ------------- | --------------------------------------------------- | +| data | `any` | | Data for the dynamically-loaded component instance. | +| id | `string` | | Unique ID string for the component to show. | ## Details diff --git a/docs/extensions/components/preview-extension.component.md b/docs/extensions/components/preview-extension.component.md index 6352f94c72..148d53c1a8 100644 --- a/docs/extensions/components/preview-extension.component.md +++ b/docs/extensions/components/preview-extension.component.md @@ -16,12 +16,12 @@ an example of a real working viewer extension project. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| extension | `string` | | File extension (.jpg, .png, etc) for the viewer. | -| id | `string` | | ID string of the component to preview. | -| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) containing the content to display. | -| url | `string` | | URL of the content in the repository. | +| Name | Type | Default value | Description | +| --------- | -------------------------------------------------------------------------------------------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | +| extension | `string` | | File extension (.jpg, .png, etc) for the viewer. | +| id | `string` | | ID string of the component to preview. | +| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) containing the content to display. | +| url | `string` | | URL of the content in the repository. | ## Details diff --git a/docs/extensions/services/extension.service.md b/docs/extensions/services/extension.service.md index c8c5836a8b..618961b623 100644 --- a/docs/extensions/services/extension.service.md +++ b/docs/extensions/services/extension.service.md @@ -22,10 +22,10 @@ Manages and runs basic extension functionality. Retrieves an action using its ID value. - _id:_ `string` - The ID value to look for - **Returns** [`ActionRef`](../../../lib/extensions/src/lib/config/action.extensions.ts) - Action or null if not found -- **getAuthGuards**(ids: `string[]`): `Array>`
+- **getAuthGuards**(ids: `string[]`): `Array>`
Retrieves one or more auth guards using an array of ID values. - _ids:_ `string[]` - Array of ID value to look for - - **Returns** `Array>` - Array of auth guards or empty array if none were found + - **Returns** `Array>` - Array of auth guards or empty array if none were found - **getComponentById**(id: `string`): `Type<>`
Retrieves a registered [extension component](../../../lib/extensions/src/lib/services/component-register.service.ts) using its ID value. - _id:_ `string` - The ID value to look for @@ -35,7 +35,6 @@ Manages and runs basic extension functionality. - _key:_ `string` - - _fallback:_ `Array<>` - - **Returns** `Array<>` - - - **getEvaluator**(key: `string`): [`RuleEvaluator`](../../../lib/extensions/src/lib/config/rule.extensions.ts)
Retrieves a [RuleEvaluator](../../../lib/extensions/src/lib/config/rule.extensions.ts) function using its key name. - _key:_ `string` - Key name to look for @@ -55,9 +54,9 @@ Manages and runs basic extension functionality. - **load**(): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`ExtensionConfig`](../../../lib/extensions/src/lib/config/extension.config.ts)`>`
Loads and registers an extension config file and plugins (specified by path properties). - **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`ExtensionConfig`](../../../lib/extensions/src/lib/config/extension.config.ts)`>` - The loaded config data -- **runExpression**(value: `string|__type`, context?: `any`): `Function`
+- **runExpression**(value: `string|Function`, context?: `any`): `Function`
Runs a lightweight expression stored in a string. - - _value:_ `string|__type` - String containing the expression or literal value + - _value:_ `string|Function` - String containing the expression or literal value - _context:_ `any` - (Optional) Parameter object for the expression with details of app state - **Returns** `Function` - Result of evaluated expression, if found, or the literal value otherwise - **setAuthGuards**(values: `Function`)
diff --git a/docs/insights/components/analytics-generator.component.md b/docs/insights/components/analytics-generator.component.md index 45ccbcfb63..cf92b9f8c9 100644 --- a/docs/insights/components/analytics-generator.component.md +++ b/docs/insights/components/analytics-generator.component.md @@ -21,14 +21,14 @@ Generates and shows charts ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| reportId | `number` | | reportId. | -| reportParamQuery | [`ReportQuery`](../../../lib/insights/src/lib/diagram/models/report/report-query.model.ts) | undefined | reportParamQuery. | +| Name | Type | Default value | Description | +| ---------------- | ------------------------------------------------------------------------------------------ | ------------- | ----------------- | +| reportId | `number` | | reportId. | +| reportParamQuery | [`ReportQuery`](../../../lib/insights/src/lib/diagram/models/report/report-query.model.ts) | undefined | reportParamQuery. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | error. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | success. | +| Name | Type | Description | +| ------- | ----------------------------------------------------------------- | ----------- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | error. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | success. | diff --git a/docs/insights/components/analytics-report-list.component.md b/docs/insights/components/analytics-report-list.component.md index 98e96f47cb..24bb4c1903 100644 --- a/docs/insights/components/analytics-report-list.component.md +++ b/docs/insights/components/analytics-report-list.component.md @@ -20,16 +20,16 @@ Shows a list of all available reports ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| appId | `number` | | appId ID of the target app. | -| layoutType | `string` | | layout Type LIST or GRID. | -| selectFirst | `boolean` | false | selectFirst. | +| Name | Type | Default value | Description | +| ----------- | --------- | ------------- | --------------------------- | +| appId | `number` | | appId ID of the target app. | +| layoutType | `string` | | layout Type LIST or GRID. | +| selectFirst | `boolean` | false | selectFirst. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | error. | +| Name | Type | Description | +| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | error. | | reportClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ReportParametersModel`](../../../lib/insights/src/lib/diagram/models/report/report-parameters.model.ts)`>` | report Click. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | success. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | success. | diff --git a/docs/insights/components/analytics.component.md b/docs/insights/components/analytics.component.md index c26bc6b67b..be89e87690 100644 --- a/docs/insights/components/analytics.component.md +++ b/docs/insights/components/analytics.component.md @@ -23,16 +23,16 @@ Shows the charts related to the reportId passed as input ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| appId | `number` | | appId ID of the target app. | -| hideParameters | `boolean` | false | hideParameters. | -| reportId | `number` | | reportId. | +| Name | Type | Default value | Description | +| -------------- | --------- | ------------- | --------------------------- | +| appId | `number` | | appId ID of the target app. | +| hideParameters | `boolean` | false | hideParameters. | +| reportId | `number` | | reportId. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| editReport | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | emitted when editReport. | +| Name | Type | Description | +| ------------- | ----------------------------------------------------------------- | --------------------------- | +| editReport | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | emitted when editReport. | | reportDeleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | emitted when reportDeleted. | -| reportSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | emitted when reportSaved. | +| reportSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | emitted when reportSaved. | diff --git a/docs/insights/components/diagram.component.md b/docs/insights/components/diagram.component.md index 3d16e8917b..ef24c82af2 100644 --- a/docs/insights/components/diagram.component.md +++ b/docs/insights/components/diagram.component.md @@ -30,19 +30,19 @@ The below component shows the diagram of a running process instance with the act ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| height | `number` | 500 | height. | -| metricColor | `any` | | metricColor. | -| metricPercentages | `any` | | metricPercentages. | -| metricType | `string` | "" | metricType. | -| processDefinitionId | `any` | | processDefinitionId. | -| processInstanceId | `any` | | processInstanceId. | -| width | `number` | 1000 | width. | +| Name | Type | Default value | Description | +| ------------------- | -------- | ------------- | -------------------- | +| height | `number` | 500 | height. | +| metricColor | `any` | | metricColor. | +| metricPercentages | `any` | | metricPercentages. | +| metricType | `string` | "" | metricType. | +| processDefinitionId | `any` | | processDefinitionId. | +| processInstanceId | `any` | | processInstanceId. | +| width | `number` | 1000 | width. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | error. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | success. | +| Name | Type | Description | +| ------- | ----------------------------------------------------------------- | ----------- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | error. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | success. | diff --git a/docs/insights/components/widget.component.md b/docs/insights/components/widget.component.md index 10e9d712d3..b2f19bc972 100644 --- a/docs/insights/components/widget.component.md +++ b/docs/insights/components/widget.component.md @@ -28,14 +28,14 @@ export class CustomEditorComponent extends WidgetComponent {} ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| field | `any` | | field. | +| Name | Type | Default value | Description | +| ----- | ----- | ------------- | ----------- | +| field | `any` | | field. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| ------------ | ----------------------------------------------------------------- | ------------- | | fieldChanged | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | fieldChanged. | ## Details diff --git a/docs/license-info/README.md b/docs/license-info/README.md index 987313c642..4a24150991 100644 --- a/docs/license-info/README.md +++ b/docs/license-info/README.md @@ -7,6 +7,7 @@ Github only: true The pages linked below contain the licenses for all third party dependencies of ADF. +- [ADF v4.1](license-info-4.1.0.md) - [ADF v4.0](license-info-4.0.0.md) - [ADF v3.9](license-info-3.9.0.md) - [ADF v3.8](license-info-3.8.0.md) diff --git a/docs/license-info/license-info-4.1.0.md b/docs/license-info/license-info-4.1.0.md new file mode 100644 index 0000000000..bd62b3d32d --- /dev/null +++ b/docs/license-info/license-info-4.1.0.md @@ -0,0 +1,497 @@ +--- +Title: License info, alfresco-ng2-components 4.1.0 +--- + +# License information for alfresco-ng2-components 4.1.0 + +This page lists all third party libraries the project depends on. + +## Libraries + +| Name | Version | License | +| --- | --- | --- | +| [@alfresco/js-api](https://github.com/Alfresco/alfresco-js-api) | 4.1.0 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [@angular/animations](https://github.com/angular/angular) | 10.0.12 | [MIT](http://www.opensource.org/licenses/MIT) | +| [@angular/cdk](https://github.com/angular/components) | 10.1.3 | [MIT](http://www.opensource.org/licenses/MIT) | +| [@angular/common](https://github.com/angular/angular) | 10.0.12 | [MIT](http://www.opensource.org/licenses/MIT) | +| [@angular/compiler](https://github.com/angular/angular) | 10.0.12 | [MIT](http://www.opensource.org/licenses/MIT) | +| [@angular/compiler](https://github.com/angular/angular) | 9.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [@angular/core](https://github.com/angular/angular) | 10.0.12 | [MIT](http://www.opensource.org/licenses/MIT) | +| [@angular/core](https://github.com/angular/angular) | 9.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [@angular/flex-layout](https://github.com/angular/flex-layout) | 10.0.0-beta.32 | [MIT](http://www.opensource.org/licenses/MIT) | +| [@angular/forms](https://github.com/angular/angular) | 10.0.12 | [MIT](http://www.opensource.org/licenses/MIT) | +| [@angular/material-moment-adapter](https://github.com/angular/components) | 10.1.3 | [MIT](http://www.opensource.org/licenses/MIT) | +| [@angular/material](https://github.com/angular/components) | 10.1.3 | [MIT](http://www.opensource.org/licenses/MIT) | +| [@angular/platform-browser-dynamic](https://github.com/angular/angular) | 10.0.12 | [MIT](http://www.opensource.org/licenses/MIT) | +| [@angular/platform-browser](https://github.com/angular/angular) | 10.0.12 | [MIT](http://www.opensource.org/licenses/MIT) | +| [@angular/router](https://github.com/angular/angular) | 10.0.12 | [MIT](http://www.opensource.org/licenses/MIT) | +| [@babel/code-frame](https://github.com/babel/babel) | 7.10.4 | [MIT](http://www.opensource.org/licenses/MIT) | +| [@babel/helper-validator-identifier](https://github.com/babel/babel) | 7.10.4 | [MIT](http://www.opensource.org/licenses/MIT) | +| [@babel/highlight](https://github.com/babel/babel) | 7.10.4 | [MIT](http://www.opensource.org/licenses/MIT) | +| [@mat-datetimepicker/core](https://github.com/kuhnroyal/mat-datetimepicker) | 5.0.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [@mat-datetimepicker/moment](https://github.com/kuhnroyal/mat-datetimepicker) | 5.0.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [@ngx-translate/core](https://github.com/ngx-translate/core) | 13.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [@sindresorhus/is](https://github.com/sindresorhus/is) | 0.14.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [@sindresorhus/is](https://github.com/sindresorhus/is) | 2.1.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [@snyk/cli-interface](https://github.com/snyk/snyk-cli-interface) | 2.9.1 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [@snyk/cli-interface](https://github.com/snyk/snyk-cli-interface) | 2.9.2 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [@snyk/cocoapods-lockfile-parser](https://github.com/snyk/cocoapods-lockfile-parser) | 3.5.2 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [@snyk/composer-lockfile-parser](https://github.com/snyk/composer-lockfile-parser) | 1.4.1 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [@snyk/dep-graph](https://github.com/snyk/dep-graph) | 1.19.4 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [@snyk/docker-registry-v2-client](https://github.com/snyk/docker-registry-v2-client) | 1.13.5 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [@snyk/gemfile](https://github.com/snyk/gemfile) | 1.2.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [@snyk/java-call-graph-builder](https://github.com/snyk/java-call-graph-builder) | 1.13.2 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [@snyk/rpm-parser](https://github.com/snyk/rpm-parser) | 2.0.0 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [@snyk/snyk-cocoapods-plugin](https://github.com/snyk/snyk-cocoapods-plugin) | 2.5.1 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [@snyk/snyk-docker-pull](https://github.com/snyk/docker-pull) | 3.2.0 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [@szmarczak/http-timer](https://github.com/szmarczak/http-timer) | 1.1.2 | [MIT](http://www.opensource.org/licenses/MIT) | +| [@szmarczak/http-timer](https://github.com/szmarczak/http-timer) | 4.0.5 | [MIT](http://www.opensource.org/licenses/MIT) | +| [@types/cacheable-request](https://github.com/DefinitelyTyped/DefinitelyTyped) | 6.0.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [@types/chart.js](https://github.com/DefinitelyTyped/DefinitelyTyped) | 2.9.24 | [MIT](http://www.opensource.org/licenses/MIT) | +| [@types/color-name](https://github.com/DefinitelyTyped/DefinitelyTyped) | 1.1.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [@types/debug](https://github.com/DefinitelyTyped/DefinitelyTyped) | 4.1.5 | [MIT](http://www.opensource.org/licenses/MIT) | +| [@types/graphlib](https://github.com/DefinitelyTyped/DefinitelyTyped) | 2.1.7 | [MIT](http://www.opensource.org/licenses/MIT) | +| [@types/hosted-git-info](https://github.com/DefinitelyTyped/DefinitelyTyped) | 2.7.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [@types/http-cache-semantics](https://github.com/DefinitelyTyped/DefinitelyTyped) | 4.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [@types/js-yaml](https://github.com/DefinitelyTyped/DefinitelyTyped) | 3.12.5 | [MIT](http://www.opensource.org/licenses/MIT) | +| [@types/keyv](https://github.com/DefinitelyTyped/DefinitelyTyped) | 3.1.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped) | 14.11.2 | [MIT](http://www.opensource.org/licenses/MIT) | +| [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped) | 6.14.12 | [MIT](http://www.opensource.org/licenses/MIT) | +| [@types/responselike](https://github.com/DefinitelyTyped/DefinitelyTyped) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [@types/semver](https://github.com/DefinitelyTyped/DefinitelyTyped) | 5.5.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [@yarnpkg/lockfile](https://github.com/yarnpkg/yarn/blob/master/packages/lockfile) | 1.1.0 | [BSD-2-Clause](http://www.opensource.org/licenses/BSD-2-Clause) | +| [abbrev](https://github.com/isaacs/abbrev-js) | 1.1.1 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [adf-tslint-rules](https://github.com/Alfresco/alfresco-ng2-components) | 0.0.7 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [agent-base](https://github.com/TooTallNate/node-agent-base) | 4.2.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [agent-base](https://github.com/TooTallNate/node-agent-base) | 4.3.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [alfresco-ng2-components](https://github.com/Alfresco/alfresco-ng2-components) | 4.0.0 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [ansi-align](https://github.com/nexdrew/ansi-align) | 3.0.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [ansi-escapes](https://github.com/sindresorhus/ansi-escapes) | 3.2.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [ansi-escapes](https://github.com/sindresorhus/ansi-escapes) | 4.3.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [ansi-regex](https://github.com/chalk/ansi-regex) | 2.1.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [ansi-regex](https://github.com/chalk/ansi-regex) | 4.1.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [ansi-regex](https://github.com/chalk/ansi-regex) | 5.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [ansi-styles](https://github.com/chalk/ansi-styles) | 3.2.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [ansi-styles](https://github.com/chalk/ansi-styles) | 4.2.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [ansicolors](https://github.com/thlorenz/ansicolors) | 0.3.2 | [MIT](http://www.opensource.org/licenses/MIT) | +| [app-root-path](https://github.com/inxilpro/node-app-root-path) | 2.0.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [app-root-path](https://github.com/inxilpro/node-app-root-path) | 3.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [archy](https://github.com/substack/node-archy) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [argparse](https://github.com/nodeca/argparse) | 1.0.10 | [MIT](http://www.opensource.org/licenses/MIT) | +| [aria-query](https://github.com/A11yance/aria-query) | 3.0.0 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [asap](https://github.com/kriskowal/asap) | 2.0.6 | [MIT](http://www.opensource.org/licenses/MIT) | +| [asn1](https://github.com/joyent/node-asn1) | 0.2.4 | [MIT](http://www.opensource.org/licenses/MIT) | +| [ast-types-flow](https://github.com/kyldvs/ast-types-flow) | 0.0.7 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [ast-types](https://github.com/benjamn/ast-types) | 0.14.2 | [MIT](http://www.opensource.org/licenses/MIT) | +| [async](https://github.com/caolan/async) | 1.5.2 | [MIT](http://www.opensource.org/licenses/MIT) | +| [asynckit](https://github.com/alexindigo/asynckit) | 0.4.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [axobject-query](https://github.com/A11yance/axobject-query) | 2.0.2 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [balanced-match](https://github.com/juliangruber/balanced-match) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [base64-js](https://github.com/beatgammit/base64-js) | 1.3.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [bcrypt-pbkdf](https://github.com/joyent/node-bcrypt-pbkdf) | 1.0.2 | [BSD-3-Clause](http://www.opensource.org/licenses/BSD-3-Clause) | +| [bl](https://github.com/rvagg/bl) | 4.0.3 | [MIT](http://www.opensource.org/licenses/MIT) | +| [boxen](https://github.com/sindresorhus/boxen) | 4.2.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [brace-expansion](https://github.com/juliangruber/brace-expansion) | 1.1.11 | [MIT](http://www.opensource.org/licenses/MIT) | +| [browserify-zlib](https://github.com/devongovett/browserify-zlib) | 0.1.4 | [MIT](http://www.opensource.org/licenses/MIT) | +| [buffer-from](https://github.com/LinusU/buffer-from) | 1.1.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [buffer](https://github.com/feross/buffer) | 5.6.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [builtin-modules](https://github.com/sindresorhus/builtin-modules) | 1.1.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [bytes](https://github.com/visionmedia/bytes.js) | 3.1.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [cacheable-lookup](https://github.com/szmarczak/cacheable-lookup) | 5.0.3 | [MIT](http://www.opensource.org/licenses/MIT) | +| [cacheable-request](https://github.com/lukechilds/cacheable-request) | 6.1.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [cacheable-request](https://github.com/lukechilds/cacheable-request) | 7.0.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [camelcase](https://github.com/sindresorhus/camelcase) | 2.1.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [camelcase](https://github.com/sindresorhus/camelcase) | 5.3.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [chalk](https://github.com/chalk/chalk) | 2.4.2 | [MIT](http://www.opensource.org/licenses/MIT) | +| [chalk](https://github.com/chalk/chalk) | 3.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [chalk](https://github.com/chalk/chalk) | 4.1.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [chardet](https://github.com/runk/node-chardet) | 0.7.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [chart.js](https://github.com/chartjs/Chart.js) | 2.9.3 | [MIT](http://www.opensource.org/licenses/MIT) | +| [chartjs-color-string](https://github.com/chartjs/chartjs-color-string) | 0.6.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [chartjs-color](https://github.com/chartjs/chartjs-color) | 2.4.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [child-process](https://github.com/npm/security-holder) | 1.0.2 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [ci-info](https://github.com/watson/ci-info) | 2.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [classlist.js](https://github.com/eligrey/classList.js) | 1.1.20150312 | Public Domain | +| [cli-boxes](https://github.com/sindresorhus/cli-boxes) | 2.2.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [cli-cursor](https://github.com/sindresorhus/cli-cursor) | 3.1.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [cli-spinner](https://github.com/helloIAmPau/node-spinner) | 0.2.10 | [MIT](http://www.opensource.org/licenses/MIT) | +| [cli-width](https://github.com/knownasilya/cli-width) | 3.0.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [cliui](https://github.com/yargs/cliui) | 3.2.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [clone-response](https://github.com/lukechilds/clone-response) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) | +| [co](https://github.com/tj/co) | 4.6.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [code-point-at](https://github.com/sindresorhus/code-point-at) | 1.1.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [codelyzer](https://github.com/mgechev/codelyzer) | 6.0.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [color-convert](https://github.com/Qix-/color-convert) | 1.9.3 | [MIT](http://www.opensource.org/licenses/MIT) | +| [color-convert](https://github.com/Qix-/color-convert) | 2.0.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [color-name](https://github.com/dfcreative/color-name) | 1.1.3 | [MIT](http://www.opensource.org/licenses/MIT) | +| [color-name](https://github.com/colorjs/color-name) | 1.1.4 | [MIT](http://www.opensource.org/licenses/MIT) | +| [combined-stream](https://github.com/felixge/node-combined-stream) | 1.0.8 | [MIT](http://www.opensource.org/licenses/MIT) | +| [commander](https://github.com/tj/commander.js) | 2.20.3 | [MIT](http://www.opensource.org/licenses/MIT) | +| [component-emitter](https://github.com/component/emitter) | 1.3.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [concat-map](https://github.com/substack/node-concat-map) | 0.0.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [configstore](https://github.com/yeoman/configstore) | 5.0.1 | [BSD-2-Clause](http://www.opensource.org/licenses/BSD-2-Clause) | +| [cookiejar](https://github.com/bmeck/node-cookiejar) | 2.1.2 | [MIT](http://www.opensource.org/licenses/MIT) | +| [core-util-is](https://github.com/isaacs/core-util-is) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) | +| [cross-spawn](https://github.com/moxystudio/node-cross-spawn) | 6.0.5 | [MIT](http://www.opensource.org/licenses/MIT) | +| [crypto-random-string](https://github.com/sindresorhus/crypto-random-string) | 2.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [css-selector-tokenizer](https://github.com/css-modules/css-selector-tokenizer) | 0.7.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [css-selector-tokenizer](https://github.com/css-modules/css-selector-tokenizer) | 0.7.3 | [MIT](http://www.opensource.org/licenses/MIT) | +| [cssauron](https://github.com/chrisdickinson/cssauron) | 1.4.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [cssesc](https://github.com/mathiasbynens/cssesc) | 0.1.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [cssesc](https://github.com/mathiasbynens/cssesc) | 3.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [custom-event-polyfill](https://github.com/kumarharsh/custom-event-polyfill) | 1.0.7 | [MIT](http://www.opensource.org/licenses/MIT) | +| [d](https://github.com/medikoo/d) | 1.0.1 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [damerau-levenshtein](https://github.com/tad-lispy/node-damerau-levenshtein) | 1.0.6 | [BSD-2-Clause](http://www.opensource.org/licenses/BSD-2-Clause) | +| [data-uri-to-buffer](https://github.com/TooTallNate/node-data-uri-to-buffer) | 1.2.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [debug](https://github.com/visionmedia/debug) | 2.6.9 | [MIT](http://www.opensource.org/licenses/MIT) | +| [debug](https://github.com/visionmedia/debug) | 3.1.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [debug](https://github.com/visionmedia/debug) | 3.2.6 | [MIT](http://www.opensource.org/licenses/MIT) | +| [debug](https://github.com/visionmedia/debug) | 4.1.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [decamelize](https://github.com/sindresorhus/decamelize) | 1.2.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [decompress-response](https://github.com/sindresorhus/decompress-response) | 3.3.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [decompress-response](https://github.com/sindresorhus/decompress-response) | 6.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [deep-extend](https://github.com/unclechu/node-deep-extend) | 0.6.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [deep-is](https://github.com/thlorenz/deep-is) | 0.1.3 | [MIT](http://www.opensource.org/licenses/MIT) | +| [defer-to-connect](https://github.com/szmarczak/defer-to-connect) | 1.1.3 | [MIT](http://www.opensource.org/licenses/MIT) | +| [defer-to-connect](https://github.com/szmarczak/defer-to-connect) | 2.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [degenerator](https://github.com/TooTallNate/node-degenerator) | 1.0.4 | [MIT](http://www.opensource.org/licenses/MIT) | +| [delayed-stream](https://github.com/felixge/node-delayed-stream) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [depd](https://github.com/dougwilson/nodejs-depd) | 1.1.2 | [MIT](http://www.opensource.org/licenses/MIT) | +| [diff](https://github.com/kpdecker/jsdiff) | 4.0.2 | [BSD-3-Clause](http://www.opensource.org/licenses/BSD-3-Clause) | +| [docker-modem](https://github.com/apocas/docker-modem) | 2.1.3 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [dockerfile-ast](https://github.com/rcjsuen/dockerfile-ast) | 0.0.30 | [MIT](http://www.opensource.org/licenses/MIT) | +| [dot-prop](https://github.com/sindresorhus/dot-prop) | 5.2.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [dotnet-deps-parser](https://github.com/snyk/dotnet-deps-parser) | 5.0.0 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [duplexer3](https://github.com/floatdrop/duplexer3) | 0.1.4 | [BSD-3-Clause](http://www.opensource.org/licenses/BSD-3-Clause) | +| [duplexify](https://github.com/mafintosh/duplexify) | 3.7.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [email-validator](https://github.com/manishsaraan/email-validator) | 2.0.4 | [MIT](http://www.opensource.org/licenses/MIT) | +| [emoji-regex](https://github.com/mathiasbynens/emoji-regex) | 7.0.3 | [MIT](http://www.opensource.org/licenses/MIT) | +| [emoji-regex](https://github.com/mathiasbynens/emoji-regex) | 8.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [end-of-stream](https://github.com/mafintosh/end-of-stream) | 1.4.4 | [MIT](http://www.opensource.org/licenses/MIT) | +| [es5-ext](https://github.com/medikoo/es5-ext) | 0.10.53 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [es6-iterator](https://github.com/medikoo/es6-iterator) | 2.0.3 | [MIT](http://www.opensource.org/licenses/MIT) | +| [es6-promise](https://github.com/stefanpenner/es6-promise) | 4.2.8 | [MIT](http://www.opensource.org/licenses/MIT) | +| [es6-promisify](https://github.com/digitaldesignlabs/es6-promisify) | 5.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [es6-symbol](https://github.com/medikoo/es6-symbol) | 3.1.3 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [escape-goat](https://github.com/sindresorhus/escape-goat) | 2.1.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [escape-string-regexp](https://github.com/sindresorhus/escape-string-regexp) | 1.0.5 | [MIT](http://www.opensource.org/licenses/MIT) | +| [escodegen](https://github.com/estools/escodegen) | 1.14.3 | [BSD-2-Clause](http://www.opensource.org/licenses/BSD-2-Clause) | +| [esprima](https://github.com/jquery/esprima) | 3.1.3 | [BSD-2-Clause](http://www.opensource.org/licenses/BSD-2-Clause) | +| [esprima](https://github.com/jquery/esprima) | 4.0.1 | [BSD-2-Clause](http://www.opensource.org/licenses/BSD-2-Clause) | +| [estraverse](https://github.com/estools/estraverse) | 4.3.0 | [BSD-2-Clause](http://www.opensource.org/licenses/BSD-2-Clause) | +| [esutils](https://github.com/estools/esutils) | 2.0.3 | [BSD-2-Clause](http://www.opensource.org/licenses/BSD-2-Clause) | +| [eve-raphael](https://github.com/tomasAlabes/eve) | 0.5.0 | [Apache](http://www.apache.org/licenses/LICENSE-2.0) | +| [event-emitter](https://github.com/medikoo/event-emitter) | 0.3.5 | [MIT](http://www.opensource.org/licenses/MIT) | +| [event-loop-spinner](https://github.com/snyk/eventloop-spinner) | 2.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [execa](https://github.com/sindresorhus/execa) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [ext](https://github.com/medikoo/es5-ext/tree/ext) | 1.4.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [extend](https://github.com/justmoon/node-extend) | 3.0.2 | [MIT](http://www.opensource.org/licenses/MIT) | +| [external-editor](https://github.com/mrkmg/node-external-editor) | 3.1.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [fast-levenshtein](https://github.com/hiddentao/fast-levenshtein) | 2.0.6 | [MIT](http://www.opensource.org/licenses/MIT) | +| [fast-safe-stringify](https://github.com/davidmarkclements/fast-safe-stringify) | 2.0.7 | [MIT](http://www.opensource.org/licenses/MIT) | +| [fastparse](https://github.com/webpack/fastparse) | 1.1.2 | [MIT](http://www.opensource.org/licenses/MIT) | +| [figures](https://github.com/sindresorhus/figures) | 3.2.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [file-uri-to-path](https://github.com/TooTallNate/file-uri-to-path) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [form-data](https://github.com/form-data/form-data) | 3.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [formidable](https://github.com/node-formidable/formidable) | 1.2.2 | [MIT](http://www.opensource.org/licenses/MIT) | +| [fs-constants](https://github.com/mafintosh/fs-constants) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [fs.realpath](https://github.com/isaacs/fs.realpath) | 1.0.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [ftp](https://github.com/mscdex/node-ftp) | 0.3.10 | [MIT](http://www.opensource.org/licenses/MIT) | +| [get-stream](https://github.com/sindresorhus/get-stream) | 4.1.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [get-stream](https://github.com/sindresorhus/get-stream) | 5.2.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [get-uri](https://github.com/TooTallNate/node-get-uri) | 2.0.4 | [MIT](http://www.opensource.org/licenses/MIT) | +| [glob](https://github.com/isaacs/node-glob) | 7.1.6 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [global-dirs](https://github.com/sindresorhus/global-dirs) | 2.0.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [got](https://github.com/sindresorhus/got) | 11.4.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [got](https://github.com/sindresorhus/got) | 9.6.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [graceful-fs](https://github.com/isaacs/node-graceful-fs) | 4.2.4 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [graphlib](https://github.com/dagrejs/graphlib) | 2.1.8 | [MIT](http://www.opensource.org/licenses/MIT) | +| [gunzip-maybe](https://github.com/mafintosh/gunzip-maybe) | 1.4.2 | [MIT](http://www.opensource.org/licenses/MIT) | +| [has-flag](https://github.com/sindresorhus/has-flag) | 3.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [has-flag](https://github.com/sindresorhus/has-flag) | 4.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [has-yarn](https://github.com/sindresorhus/has-yarn) | 2.1.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [hosted-git-info](https://github.com/npm/hosted-git-info) | 2.8.8 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [hosted-git-info](https://github.com/npm/hosted-git-info) | 3.0.5 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [http-cache-semantics](https://github.com/kornelski/http-cache-semantics) | 4.1.0 | [BSD-2-Clause](http://www.opensource.org/licenses/BSD-2-Clause) | +| [http-errors](https://github.com/jshttp/http-errors) | 1.7.3 | [MIT](http://www.opensource.org/licenses/MIT) | +| [http-proxy-agent](https://github.com/TooTallNate/node-http-proxy-agent) | 2.1.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [http2-wrapper](https://github.com/szmarczak/http2-wrapper) | 1.0.0-beta.5.2 | [MIT](http://www.opensource.org/licenses/MIT) | +| [https-proxy-agent](https://github.com/TooTallNate/node-https-proxy-agent) | 3.0.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [iconv-lite](https://github.com/ashtuchkin/iconv-lite) | 0.4.24 | [MIT](http://www.opensource.org/licenses/MIT) | +| [ieee754](https://github.com/feross/ieee754) | 1.1.13 | [BSD-3-Clause](http://www.opensource.org/licenses/BSD-3-Clause) | +| [immediate](https://github.com/calvinmetcalf/immediate) | 3.0.6 | [MIT](http://www.opensource.org/licenses/MIT) | +| [import-lazy](https://github.com/sindresorhus/import-lazy) | 2.1.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [imurmurhash](https://github.com/jensyt/imurmurhash-js) | 0.1.4 | [MIT](http://www.opensource.org/licenses/MIT) | +| [inflight](https://github.com/npm/inflight) | 1.0.6 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [inherits](https://github.com/isaacs/inherits) | 2.0.4 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [ini](https://github.com/isaacs/ini) | 1.3.5 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [inquirer](https://github.com/SBoudrias/Inquirer.js) | 7.3.3 | [MIT](http://www.opensource.org/licenses/MIT) | +| [invert-kv](https://github.com/sindresorhus/invert-kv) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [ip](https://github.com/indutny/node-ip) | 1.1.5 | [MIT](http://www.opensource.org/licenses/MIT) | +| [is-ci](https://github.com/watson/is-ci) | 2.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [is-deflate](https://github.com/watson/is-deflate) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [is-docker](https://github.com/sindresorhus/is-docker) | 2.1.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [is-fullwidth-code-point](https://github.com/sindresorhus/is-fullwidth-code-point) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [is-fullwidth-code-point](https://github.com/sindresorhus/is-fullwidth-code-point) | 2.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [is-fullwidth-code-point](https://github.com/sindresorhus/is-fullwidth-code-point) | 3.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [is-gzip](https://github.com/kevva/is-gzip) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [is-installed-globally](https://github.com/sindresorhus/is-installed-globally) | 0.3.2 | [MIT](http://www.opensource.org/licenses/MIT) | +| [is-npm](https://github.com/sindresorhus/is-npm) | 4.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [is-obj](https://github.com/sindresorhus/is-obj) | 2.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [is-path-inside](https://github.com/sindresorhus/is-path-inside) | 3.0.2 | [MIT](http://www.opensource.org/licenses/MIT) | +| [is-stream](https://github.com/sindresorhus/is-stream) | 1.1.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [is-typedarray](https://github.com/hughsk/is-typedarray) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [is-wsl](https://github.com/sindresorhus/is-wsl) | 2.2.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [is-yarn-global](https://github.com/LitoMore/is-yarn-global) | 0.3.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [isarray](https://github.com/juliangruber/isarray) | 0.0.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [isarray](https://github.com/juliangruber/isarray) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [isexe](https://github.com/isaacs/isexe) | 2.0.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [js-tokens](https://github.com/lydell/js-tokens) | 4.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [js-yaml](https://github.com/nodeca/js-yaml) | 3.14.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [jsesc](https://github.com/mathiasbynens/jsesc) | 0.5.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [json-buffer](https://github.com/dominictarr/json-buffer) | 3.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [json-buffer](https://github.com/dominictarr/json-buffer) | 3.0.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [jszip](https://github.com/Stuk/jszip) | 3.4.0 | ([MIT](http://www.opensource.org/licenses/MIT) OR [GPL-3.0](http://www.gnu.org/licenses/gpl-3.0-standalone.html)) | +| [jszip](https://github.com/Stuk/jszip) | 3.5.0 | ([MIT](http://www.opensource.org/licenses/MIT) OR [GPL-3.0](http://www.gnu.org/licenses/gpl-3.0-standalone.html)) | +| [keyv](https://github.com/lukechilds/keyv) | 3.1.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [keyv](https://github.com/lukechilds/keyv) | 4.0.3 | [MIT](http://www.opensource.org/licenses/MIT) | +| [latest-version](https://github.com/sindresorhus/latest-version) | 5.1.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [lcid](https://github.com/sindresorhus/lcid) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [levn](https://github.com/gkz/levn) | 0.3.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [lie](https://github.com/calvinmetcalf/lie) | 3.3.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [lodash-es](https://github.com/lodash/lodash) | 4.17.15 | [MIT](http://www.opensource.org/licenses/MIT) | +| [lodash.assign](https://github.com/lodash/lodash) | 4.2.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [lodash.assignin](https://github.com/lodash/lodash) | 4.2.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [lodash.clone](https://github.com/lodash/lodash) | 4.5.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [lodash.clonedeep](https://github.com/lodash/lodash) | 4.5.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [lodash.findkey](https://github.com/lodash/lodash) | 4.6.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [lodash.flatmap](https://github.com/lodash/lodash) | 4.5.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [lodash.flatten](https://github.com/lodash/lodash) | 4.4.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [lodash.get](https://github.com/lodash/lodash) | 4.4.2 | [MIT](http://www.opensource.org/licenses/MIT) | +| [lodash.invert](https://github.com/lodash/lodash) | 4.3.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [lodash.isempty](https://github.com/lodash/lodash) | 4.4.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [lodash.isequal](https://github.com/lodash/lodash) | 4.5.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [lodash.merge](https://github.com/lodash/lodash) | 4.6.2 | [MIT](http://www.opensource.org/licenses/MIT) | +| [lodash.set](https://github.com/lodash/lodash) | 4.3.2 | [MIT](http://www.opensource.org/licenses/MIT) | +| [lodash.topairs](https://github.com/lodash/lodash) | 4.3.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [lodash.uniq](https://github.com/lodash/lodash) | 4.5.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [lodash](https://github.com/lodash/lodash) | 4.17.20 | [MIT](http://www.opensource.org/licenses/MIT) | +| [lowercase-keys](https://github.com/sindresorhus/lowercase-keys) | 1.0.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [lowercase-keys](https://github.com/sindresorhus/lowercase-keys) | 2.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [lru-cache](https://github.com/isaacs/node-lru-cache) | 4.1.5 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [lru-cache](https://github.com/isaacs/node-lru-cache) | 5.1.1 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [lru-cache](https://github.com/isaacs/node-lru-cache) | 6.0.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [macos-release](https://github.com/sindresorhus/macos-release) | 2.4.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [make-dir](https://github.com/sindresorhus/make-dir) | 3.1.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [methods](https://github.com/jshttp/methods) | 1.1.2 | [MIT](http://www.opensource.org/licenses/MIT) | +| [mime-db](https://github.com/jshttp/mime-db) | 1.44.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [mime-types](https://github.com/jshttp/mime-types) | 2.1.27 | [MIT](http://www.opensource.org/licenses/MIT) | +| [mime](https://github.com/broofa/mime) | 2.4.6 | [MIT](http://www.opensource.org/licenses/MIT) | +| [mimic-fn](https://github.com/sindresorhus/mimic-fn) | 2.1.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [mimic-response](https://github.com/sindresorhus/mimic-response) | 1.0.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [mimic-response](https://github.com/sindresorhus/mimic-response) | 3.1.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [minimatch-browser](https://github.com/isaacs/minimatch) | 1.0.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [minimatch](https://github.com/isaacs/minimatch) | 3.0.4 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [minimist](https://github.com/substack/minimist) | 1.2.5 | [MIT](http://www.opensource.org/licenses/MIT) | +| [mkdirp](https://github.com/substack/node-mkdirp) | 0.5.5 | [MIT](http://www.opensource.org/licenses/MIT) | +| [mkdirp](https://github.com/isaacs/node-mkdirp) | 1.0.4 | [MIT](http://www.opensource.org/licenses/MIT) | +| [moment-es6](https://github.com/Agamnentzar/moment-es6) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [moment](https://github.com/moment/moment) | 2.29.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [ms](https://github.com/zeit/ms) | 2.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [ms](https://github.com/zeit/ms) | 2.1.2 | [MIT](http://www.opensource.org/licenses/MIT) | +| [mute-stream](https://github.com/isaacs/mute-stream) | 0.0.8 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [nconf](https://github.com/flatiron/nconf) | 0.10.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [needle](https://github.com/tomas/needle) | 2.5.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [netmask](https://github.com/rs/node-netmask) | 1.0.6 | [MIT](http://www.opensource.org/licenses/MIT) | +| [next-tick](https://github.com/medikoo/next-tick) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [ng2-charts](https://github.com/valor-software/ng2-charts) | 2.3.3 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [ngx-monaco-editor](https://github.com/atularen/ngx-monaco-editor) | 8.1.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [nice-try](https://github.com/electerious/nice-try) | 1.0.5 | [MIT](http://www.opensource.org/licenses/MIT) | +| [normalize-url](https://github.com/sindresorhus/normalize-url) | 4.5.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [npm-run-path](https://github.com/sindresorhus/npm-run-path) | 2.0.2 | [MIT](http://www.opensource.org/licenses/MIT) | +| [number-is-nan](https://github.com/sindresorhus/number-is-nan) | 1.0.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [object-hash](https://github.com/puleos/object-hash) | 2.0.3 | [MIT](http://www.opensource.org/licenses/MIT) | +| [once](https://github.com/isaacs/once) | 1.4.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [onetime](https://github.com/sindresorhus/onetime) | 5.1.2 | [MIT](http://www.opensource.org/licenses/MIT) | +| [open](https://github.com/sindresorhus/open) | 7.2.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [optionator](https://github.com/gkz/optionator) | 0.8.3 | [MIT](http://www.opensource.org/licenses/MIT) | +| [os-locale](https://github.com/sindresorhus/os-locale) | 1.4.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [os-name](https://github.com/sindresorhus/os-name) | 3.1.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [os-tmpdir](https://github.com/sindresorhus/os-tmpdir) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) | +| [p-cancelable](https://github.com/sindresorhus/p-cancelable) | 1.1.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [p-cancelable](https://github.com/sindresorhus/p-cancelable) | 2.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [p-finally](https://github.com/sindresorhus/p-finally) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [p-map](https://github.com/sindresorhus/p-map) | 2.1.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [pac-proxy-agent](https://github.com/TooTallNate/node-pac-proxy-agent) | 3.0.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [pac-resolver](https://github.com/TooTallNate/node-pac-resolver) | 3.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [package-json](https://github.com/sindresorhus/package-json) | 6.5.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [pako](https://github.com/nodeca/pako) | 0.2.9 | [MIT](http://www.opensource.org/licenses/MIT) | +| [pako](https://github.com/nodeca/pako) | 1.0.11 | ([MIT](http://www.opensource.org/licenses/MIT) AND [Zlib](http://www.zlib.net/zlib_license.html)) | +| [parse-link-header](https://github.com/thlorenz/parse-link-header) | 1.0.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [parse5](https://github.com/inikulin/parse5) | 5.1.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [path-is-absolute](https://github.com/sindresorhus/path-is-absolute) | 1.0.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [path-key](https://github.com/sindresorhus/path-key) | 2.0.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [path-parse](https://github.com/jbgutierrez/path-parse) | 1.0.6 | [MIT](http://www.opensource.org/licenses/MIT) | +| [pdfjs-dist](https://github.com/mozilla/pdfjs-dist) | 2.5.207 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [peek-stream](https://github.com/mafintosh/peek-stream) | 1.1.3 | [MIT](http://www.opensource.org/licenses/MIT) | +| [prelude-ls](https://github.com/gkz/prelude-ls) | 1.1.2 | [MIT](http://www.opensource.org/licenses/MIT) | +| [prepend-http](https://github.com/sindresorhus/prepend-http) | 2.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [process-nextick-args](https://github.com/calvinmetcalf/process-nextick-args) | 2.0.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [progress](https://github.com/visionmedia/node-progress) | 2.0.3 | [MIT](http://www.opensource.org/licenses/MIT) | +| [promise](https://github.com/then/promise) | 7.3.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [proxy-agent](https://github.com/TooTallNate/node-proxy-agent) | 3.1.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [proxy-from-env](https://github.com/Rob--W/proxy-from-env) | 1.1.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [pseudomap](https://github.com/isaacs/pseudomap) | 1.0.2 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [pump](https://github.com/mafintosh/pump) | 2.0.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [pump](https://github.com/mafintosh/pump) | 3.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [pumpify](https://github.com/mafintosh/pumpify) | 1.5.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [pupa](https://github.com/sindresorhus/pupa) | 2.0.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [qs](https://github.com/ljharb/qs) | 6.9.4 | [BSD-3-Clause](http://www.opensource.org/licenses/BSD-3-Clause) | +| [quick-lru](https://github.com/sindresorhus/quick-lru) | 5.1.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [raphael](https://github.com/DmitryBaranovskiy/raphael) | 2.3.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [raw-body](https://github.com/stream-utils/raw-body) | 2.4.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [rc](https://github.com/dominictarr/rc) | 1.2.8 | ([BSD-2-Clause](http://www.opensource.org/licenses/BSD-2-Clause) OR [MIT](http://www.opensource.org/licenses/MIT) OR [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0)) | +| [readable-stream](https://github.com/isaacs/readable-stream) | 1.1.14 | [MIT](http://www.opensource.org/licenses/MIT) | +| [readable-stream](https://github.com/nodejs/readable-stream) | 2.3.7 | [MIT](http://www.opensource.org/licenses/MIT) | +| [readable-stream](https://github.com/nodejs/readable-stream) | 3.6.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [regenerate](https://github.com/mathiasbynens/regenerate) | 1.4.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [regexpu-core](https://github.com/mathiasbynens/regexpu-core) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [registry-auth-token](https://github.com/rexxars/registry-auth-token) | 4.2.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [registry-url](https://github.com/sindresorhus/registry-url) | 5.1.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [regjsgen](https://github.com/d10/regjsgen) | 0.2.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [regjsparser](https://github.com/jviereck/regjsparser) | 0.1.5 | [BSD](http://www.opensource.org/licenses/BSD-2-Clause) | +| [resolve-alpn](https://github.com/szmarczak/resolve-alpn) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [resolve](https://github.com/browserify/resolve) | 1.17.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [responselike](https://github.com/lukechilds/responselike) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) | +| [responselike](https://github.com/lukechilds/responselike) | 2.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [restore-cursor](https://github.com/sindresorhus/restore-cursor) | 3.1.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [rimraf](https://github.com/isaacs/rimraf) | 2.7.1 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [rimraf](https://github.com/isaacs/rimraf) | 3.0.2 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [run-async](https://github.com/SBoudrias/run-async) | 2.4.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [rxjs](https://github.com/reactivex/rxjs) | 6.6.2 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [safe-buffer](https://github.com/feross/safe-buffer) | 5.1.2 | [MIT](http://www.opensource.org/licenses/MIT) | +| [safe-buffer](https://github.com/feross/safe-buffer) | 5.2.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [safer-buffer](https://github.com/ChALkeR/safer-buffer) | 2.1.2 | [MIT](http://www.opensource.org/licenses/MIT) | +| [sax](https://github.com/isaacs/sax-js) | 1.2.4 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| secure-keys | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [semver-diff](https://github.com/sindresorhus/semver-diff) | 3.1.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [semver-dsl](https://github.com/mgechev/semver-dsl) | 1.0.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [semver](https://github.com/npm/node-semver) | 5.7.1 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [semver](https://github.com/npm/node-semver) | 6.3.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [semver](https://github.com/npm/node-semver) | 7.3.2 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [set-immediate-shim](https://github.com/sindresorhus/set-immediate-shim) | 1.0.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [setprototypeof](https://github.com/wesleytodd/setprototypeof) | 1.1.1 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [shebang-command](https://github.com/kevva/shebang-command) | 1.2.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [shebang-regex](https://github.com/sindresorhus/shebang-regex) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [signal-exit](https://github.com/tapjs/signal-exit) | 3.0.3 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [smart-buffer](https://github.com/JoshGlazebrook/smart-buffer) | 4.1.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [snyk-config](https://github.com/snyk/config) | 3.1.1 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [snyk-cpp-plugin](https://github.com/snyk/snyk-cpp-plugin) | 2.0.0 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [snyk-docker-plugin](https://github.com/snyk/snyk-docker-plugin) | 3.24.0 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [snyk-go-parser](https://github.com/snyk/snyk-go-parser) | 1.4.1 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [snyk-go-plugin](https://github.com/snyk/snyk-go-plugin) | 1.16.2 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [snyk-gradle-plugin](https://github.com/snyk/snyk-gradle-plugin) | 3.6.3 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [snyk-module](https://github.com/snyk/module) | 1.9.1 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [snyk-module](https://github.com/snyk/module) | 2.1.0 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [snyk-module](https://github.com/snyk/module) | 3.1.0 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [snyk-mvn-plugin](https://github.com/snyk/snyk-mvn-plugin) | 2.19.4 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [snyk-nodejs-lockfile-parser](https://github.com/snyk/nodejs-lockfile-parser) | 1.28.1 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [snyk-nodejs-lockfile-parser](https://github.com/snyk/nodejs-lockfile-parser) | 1.29.0 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [snyk-nuget-plugin](https://github.com/snyk/snyk-nuget-plugin) | 1.19.3 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [snyk-paket-parser](https://github.com/snyk/snyk-paket-parser) | 1.6.0 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [snyk-php-plugin](https://github.com/snyk/snyk-php-plugin) | 1.9.2 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [snyk-policy](https://github.com/snyk/policy) | 1.14.1 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [snyk-python-plugin](https://github.com/snyk/snyk-python-plugin) | 1.17.1 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [snyk-resolve-deps](https://github.com/Snyk/resolve-deps) | 4.4.0 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [snyk-resolve](https://github.com/Snyk/resolve-package) | 1.0.1 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [snyk-sbt-plugin](https://github.com/snyk/snyk-sbt-plugin) | 2.11.0 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [snyk-tree](https://github.com/Snyk/tree) | 1.0.0 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [snyk-try-require](https://github.com/Snyk/try-require) | 1.3.1 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [snyk](https://github.com/snyk/snyk) | 1.404.0 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [socks-proxy-agent](https://github.com/TooTallNate/node-socks-proxy-agent) | 4.0.2 | [MIT](http://www.opensource.org/licenses/MIT) | +| [socks](https://github.com/JoshGlazebrook/socks) | 2.3.3 | [MIT](http://www.opensource.org/licenses/MIT) | +| [source-map-support](https://github.com/evanw/node-source-map-support) | 0.5.19 | [MIT](http://www.opensource.org/licenses/MIT) | +| [source-map](https://github.com/mozilla/source-map) | 0.5.6 | [BSD-3-Clause](http://www.opensource.org/licenses/BSD-3-Clause) | +| [source-map](https://github.com/mozilla/source-map) | 0.5.7 | [BSD-3-Clause](http://www.opensource.org/licenses/BSD-3-Clause) | +| [source-map](https://github.com/mozilla/source-map) | 0.6.1 | [BSD-3-Clause](http://www.opensource.org/licenses/BSD-3-Clause) | +| [split-ca](https://github.com/bushong1/split-ca) | 1.0.1 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [sprintf-js](https://github.com/alexei/sprintf.js) | 1.0.3 | [BSD-3-Clause](http://www.opensource.org/licenses/BSD-3-Clause) | +| [sprintf-js](https://github.com/alexei/sprintf.js) | 1.1.2 | [BSD-3-Clause](http://www.opensource.org/licenses/BSD-3-Clause) | +| [ssh2-streams](https://github.com/mscdex/ssh2-streams) | 0.4.10 | [MIT](http://www.opensource.org/licenses/MIT) | +| [ssh2](https://github.com/mscdex/ssh2) | 0.8.9 | [MIT](http://www.opensource.org/licenses/MIT) | +| [statuses](https://github.com/jshttp/statuses) | 1.5.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [stream-shift](https://github.com/mafintosh/stream-shift) | 1.0.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [streamsearch](https://github.com/mscdex/streamsearch) | 0.1.2 | [MIT](http://www.opensource.org/licenses/MIT) | +| [string-width](https://github.com/sindresorhus/string-width) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) | +| [string-width](https://github.com/sindresorhus/string-width) | 3.1.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [string-width](https://github.com/sindresorhus/string-width) | 4.2.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [string_decoder](https://github.com/rvagg/string_decoder) | 0.10.31 | [MIT](http://www.opensource.org/licenses/MIT) | +| [string_decoder](https://github.com/nodejs/string_decoder) | 1.1.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [string_decoder](https://github.com/nodejs/string_decoder) | 1.3.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [strip-ansi](https://github.com/chalk/strip-ansi) | 3.0.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [strip-ansi](https://github.com/chalk/strip-ansi) | 5.2.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [strip-ansi](https://github.com/chalk/strip-ansi) | 6.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [strip-eof](https://github.com/sindresorhus/strip-eof) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [strip-json-comments](https://github.com/sindresorhus/strip-json-comments) | 2.0.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [superagent](https://github.com/visionmedia/superagent) | 6.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [supports-color](https://github.com/chalk/supports-color) | 5.5.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [supports-color](https://github.com/chalk/supports-color) | 7.2.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [tar-stream](https://github.com/mafintosh/tar-stream) | 2.1.4 | [MIT](http://www.opensource.org/licenses/MIT) | +| [temp-dir](https://github.com/sindresorhus/temp-dir) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [temp-dir](https://github.com/sindresorhus/temp-dir) | 2.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [tempfile](https://github.com/sindresorhus/tempfile) | 2.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [term-size](https://github.com/sindresorhus/term-size) | 2.2.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [then-fs](https://github.com/then/fs) | 2.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [through2](https://github.com/rvagg/through2) | 2.0.5 | [MIT](http://www.opensource.org/licenses/MIT) | +| [through](https://github.com/dominictarr/through) | 2.3.8 | [MIT](http://www.opensource.org/licenses/MIT) | +| [thunkify](https://github.com/visionmedia/node-thunkify) | 2.1.2 | [MIT](http://www.opensource.org/licenses/MIT) | +| [tmp](https://github.com/raszi/node-tmp) | 0.0.33 | [MIT](http://www.opensource.org/licenses/MIT) | +| [tmp](https://github.com/raszi/node-tmp) | 0.1.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [tmp](https://github.com/raszi/node-tmp) | 0.2.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [to-readable-stream](https://github.com/sindresorhus/to-readable-stream) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [toidentifier](https://github.com/component/toidentifier) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [toml](https://github.com/BinaryMuse/toml-node) | 3.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [tree-kill](https://github.com/pkrumins/node-tree-kill) | 1.2.2 | [MIT](http://www.opensource.org/licenses/MIT) | +| [tslib](https://github.com/Microsoft/tslib) | 1.11.1 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [tslib](https://github.com/Microsoft/tslib) | 1.13.0 | [0BSD](http://landley.net/toybox/license.html) | +| [tslib](https://github.com/Microsoft/tslib) | 2.0.1 | [0BSD](http://landley.net/toybox/license.html) | +| [tslint](https://github.com/palantir/tslint) | 6.1.3 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [tsutils](https://github.com/ajafff/tsutils) | 2.29.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [tweetnacl](https://github.com/dchest/tweetnacl-js) | 0.14.5 | [Unlicense](http://unlicense.org/) | +| [type-check](https://github.com/gkz/type-check) | 0.3.2 | [MIT](http://www.opensource.org/licenses/MIT) | +| [type-fest](https://github.com/sindresorhus/type-fest) | 0.11.0 | ([MIT](http://www.opensource.org/licenses/MIT) OR [CC0-1.0](http://creativecommons.org/publicdomain/zero/1.0/legalcode)) | +| [type-fest](https://github.com/sindresorhus/type-fest) | 0.8.1 | ([MIT](http://www.opensource.org/licenses/MIT) OR [CC0-1.0](http://creativecommons.org/publicdomain/zero/1.0/legalcode)) | +| [type](https://github.com/medikoo/type) | 1.2.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [type](https://github.com/medikoo/type) | 2.1.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [typedarray-to-buffer](https://github.com/feross/typedarray-to-buffer) | 3.1.5 | [MIT](http://www.opensource.org/licenses/MIT) | +| [typescript](https://github.com/Microsoft/TypeScript) | 3.9.7 | [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) | +| [unique-string](https://github.com/sindresorhus/unique-string) | 2.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [unpipe](https://github.com/stream-utils/unpipe) | 1.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [update-notifier](https://github.com/yeoman/update-notifier) | 4.1.3 | [BSD-2-Clause](http://www.opensource.org/licenses/BSD-2-Clause) | +| [url-parse-lax](https://github.com/sindresorhus/url-parse-lax) | 3.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [util-deprecate](https://github.com/TooTallNate/util-deprecate) | 1.0.2 | [MIT](http://www.opensource.org/licenses/MIT) | +| [uuid](https://github.com/uuidjs/uuid) | 3.4.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [uuid](https://github.com/uuidjs/uuid) | 8.3.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [vscode-languageserver-types](https://github.com/Microsoft/vscode-languageserver-node) | 3.15.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [which](https://github.com/isaacs/node-which) | 1.3.1 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [widest-line](https://github.com/sindresorhus/widest-line) | 3.1.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [window-size](https://github.com/jonschlinkert/window-size) | 0.1.4 | [MIT](http://www.opensource.org/licenses/MIT) | +| [windows-release](https://github.com/sindresorhus/windows-release) | 3.3.3 | [MIT](http://www.opensource.org/licenses/MIT) | +| [word-wrap](https://github.com/jonschlinkert/word-wrap) | 1.2.3 | [MIT](http://www.opensource.org/licenses/MIT) | +| [wrap-ansi](https://github.com/chalk/wrap-ansi) | 2.1.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [wrap-ansi](https://github.com/chalk/wrap-ansi) | 5.1.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [wrappy](https://github.com/npm/wrappy) | 1.0.2 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [write-file-atomic](https://github.com/npm/write-file-atomic) | 3.0.3 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [xdg-basedir](https://github.com/sindresorhus/xdg-basedir) | 4.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [xml2js](https://github.com/Leonidas-from-XIV/node-xml2js) | 0.4.23 | [MIT](http://www.opensource.org/licenses/MIT) | +| [xmlbuilder](https://github.com/oozcitak/xmlbuilder-js) | 11.0.1 | [MIT](http://www.opensource.org/licenses/MIT) | +| [xregexp](https://github.com/slevithan/XRegExp) | 2.0.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [xtend](https://github.com/Raynos/xtend) | 4.0.2 | [MIT](http://www.opensource.org/licenses/MIT) | +| [y18n](https://github.com/yargs/y18n) | 3.2.1 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [yallist](https://github.com/isaacs/yallist) | 2.1.2 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [yallist](https://github.com/isaacs/yallist) | 3.1.1 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [yallist](https://github.com/isaacs/yallist) | 4.0.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [yaml](https://github.com/eemeli/yaml) | 1.10.0 | [ISC](https://www.isc.org/downloads/software-support-policy/isc-license/) | +| [yargs](https://github.com/bcoe/yargs) | 3.32.0 | [MIT](http://www.opensource.org/licenses/MIT) | +| [zone.js](https://github.com/angular/angular) | 0.10.3 | [MIT](http://www.opensource.org/licenses/MIT) | + diff --git a/docs/process-services-cloud/components/app-list-cloud.component.md b/docs/process-services-cloud/components/app-list-cloud.component.md index 490ae0f84d..885b5860eb 100644 --- a/docs/process-services-cloud/components/app-list-cloud.component.md +++ b/docs/process-services-cloud/components/app-list-cloud.component.md @@ -45,12 +45,12 @@ For example : ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| layoutType | `string` | | (**required**) Defines the layout of the apps. There are two possible values, "GRID" and "LIST". | +| Name | Type | Default value | Description | +| ---------- | -------- | ------------- | ------------------------------------------------------------------------------------------------ | +| layoutType | `string` | | (**required**) Defines the layout of the apps. There are two possible values, "GRID" and "LIST". | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | | appClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ApplicationInstanceModel`](../../../lib/process-services-cloud/src/lib/app/models/application-instance.model.ts)`>` | Emitted when an app entry is clicked. | diff --git a/docs/process-services-cloud/components/edit-process-filter-cloud.component.md b/docs/process-services-cloud/components/edit-process-filter-cloud.component.md index 2ee1d99f5c..fc6bc14a5f 100644 --- a/docs/process-services-cloud/components/edit-process-filter-cloud.component.md +++ b/docs/process-services-cloud/components/edit-process-filter-cloud.component.md @@ -41,24 +41,24 @@ Shows/edits process filter details. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| actions | `string[]` | | List of sort actions. | -| appName | `string` | "" | The name of the application. | -| filterProperties | `string[]` | | List of process filter properties to display | -| id | `string` | | Id of the process instance filter. | -| role | `string` | "" | roles to filter the apps | -| showFilterActions | `boolean` | true | Toggles editing of process filter actions. | -| showProcessFilterName | `boolean` | true | Toggles the appearance of the process filter name . | -| showTitle | `boolean` | true | Toggles editing of the process filter title. | -| sortProperties | `string[]` | | List of sort properties to display. | +| Name | Type | Default value | Description | +| --------------------- | ---------- | ------------- | --------------------------------------------------- | +| actions | `string[]` | | List of sort actions. | +| appName | `string` | "" | The name of the application. | +| filterProperties | `string[]` | | List of process filter properties to display | +| id | `string` | | Id of the process instance filter. | +| role | `string` | "" | roles to filter the apps | +| showFilterActions | `boolean` | true | Toggles editing of process filter actions. | +| showProcessFilterName | `boolean` | true | Toggles the appearance of the process filter name . | +| showTitle | `boolean` | true | Toggles editing of the process filter title. | +| sortProperties | `string[]` | | List of sort properties to display. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| action | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessFilterAction`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`>` | Emitted when a filter action occurs i.e Save, SaveAs, Delete. | -| filterChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`>` | Emitted when a process instance filter property changes. | +| Name | Type | Description | +| ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- | +| action | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessFilterAction`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`>` | Emitted when a filter action occurs i.e Save, SaveAs, Delete. | +| filterChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`>` | Emitted when a process instance filter property changes. | ## Details @@ -79,18 +79,18 @@ You can supply various _filter properties_ to edit. These will determine which processes are found by a filter. The full set of properties is given below: -| Name | Description | -| ---- | ----------- | -| **_appName_** | Name of the app | -| **_id_** | Process instance ID | -| **_name_** | Process name. | -| **_initiator_** | ID of the user who initiated the process | -| **_status_** | Execution status of the process. | -| **_processDefinitionId_** | Process definition ID | -| **_processDefinitionKey_** | Process definition key | -| **_lastModified_** | Date the process was last modified. If lastModified defined the component will show the range **_lastModifiedTo_**, **_lastModifiedFrom_** | -| **_sort_** | Field on which the filter results will be sorted. Can be "id", "name", "status", "startDate". | -| **_order_** | Sort ordering of the filter results (this doesn't participate in the filtering itself) | +| Name | Description | +| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | +| **_appName_** | Name of the app | +| **_id_** | Process instance ID | +| **_name_** | Process name. | +| **_initiator_** | ID of the user who initiated the process | +| **_status_** | Execution status of the process. | +| **_processDefinitionId_** | Process definition ID | +| **_processDefinitionKey_** | Process definition key | +| **_lastModified_** | Date the process was last modified. If lastModified defined the component will show the range **_lastModifiedTo_**, **_lastModifiedFrom_** | +| **_sort_** | Field on which the filter results will be sorted. Can be "id", "name", "status", "startDate". | +| **_order_** | Sort ordering of the filter results (this doesn't participate in the filtering itself) | By default, the **_status_**, **_sort_** and **_order_** properties are displayed in the editor. However, you can also choose which properties @@ -168,11 +168,11 @@ With this configuration, only the two listed sort properties will be shown. You can supply various _actions_ to apply on process filter. -| Name | Description | -| ---- | ----------- | -| **_save_** | Save process filter. | +| Name | Description | +| ------------ | ----------------------------- | +| **_save_** | Save process filter. | | **_saveAs_** | Creates a new process filter. | -| **_delete_** | Delete process filter. | +| **_delete_** | Delete process filter. | By default, the **_save_**, **_saveAs_** and **_delete_** actions are displayed in the editor. However, you can also choose which actions to diff --git a/docs/process-services-cloud/components/edit-task-filter-cloud.component.md b/docs/process-services-cloud/components/edit-task-filter-cloud.component.md index 9397688b9b..ab0cc4438f 100644 --- a/docs/process-services-cloud/components/edit-task-filter-cloud.component.md +++ b/docs/process-services-cloud/components/edit-task-filter-cloud.component.md @@ -5,7 +5,7 @@ Status: Experimental Last reviewed: 2019-03-27 --- -# [Edit Task Filter Cloud component](../../../lib/process-services-cloud/src/lib/task/task-filters/components/edit-task-filter-cloud.component.ts "Defined in edit-task-filter-cloud.component.ts") +# [Edit Task Filter Cloud component](../../../lib/process-services-cloud/src/lib/task/task-filters/components/edit-task-filters/edit-task-filter-cloud.component.ts "Defined in edit-task-filter-cloud.component.ts") Edits task filter details. @@ -41,24 +41,24 @@ Edits task filter details. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| actions | `string[]` | | List of task filter actions. | -| appName | `string` | "" | (required) Name of the app. | -| filterProperties | `string[]` | | List of task filter properties to display. | -| id | `string` | | (required) ID of the task filter. | -| role | `string` | "" | user role. | -| showFilterActions | `boolean` | true | Toggles the filter actions. | -| showTaskFilterName | `boolean` | true | Toggles display of task filter name | -| showTitle | `boolean` | true | Toggles the title. | -| sortProperties | `string[]` | | List of sort properties to display. | +| Name | Type | Default value | Description | +| ------------------ | ---------- | ------------- | ------------------------------------------ | +| actions | `string[]` | | List of task filter actions. | +| appName | `string` | "" | (required) Name of the app. | +| filterProperties | `string[]` | \[] | List of task filter properties to display. | +| id | `string` | | (required) ID of the task filter. | +| role | `string` | "" | user role. | +| showFilterActions | `boolean` | true | Toggles the filter actions. | +| showTaskFilterName | `boolean` | true | Toggles display of task filter name | +| showTitle | `boolean` | true | Toggles the title. | +| sortProperties | `string[]` | \[] | List of sort properties to display. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| action | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskFilterAction`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`>` | Emitted when a filter action occurs (i.e Save, Save As, Delete). | -| filterChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`>` | Emitted when a task filter property changes. | +| Name | Type | Description | +| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------- | +| action | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskFilterAction`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`>` | Emitted when a filter action occurs (i.e Save, Save As, Delete). | +| filterChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`>` | Emitted when a task filter property changes. | ## Details @@ -79,23 +79,23 @@ You can supply various _filter properties_ to edit that will determine which tasks are found by a filter. The full set of properties is given below: -| Name | Description | -| ---- | ----------- | -| **_appName_** | Name of the app | -| **_status_** | Execution state of the task. | -| **_assignee_** | [`User`](../../../lib/core/pipes/user-initial.pipe.ts) the task is assigned to | -| **_taskName_** | Name of the task | -| **_taskId_** | ID of the task | -| **_parentTaskId_** | ID of the task's parent task | -| **_priority_** | Task priority | -| **_createdDate_** | Date the task was created | -| **_standalone_** | Standalone status of the task | -| **_owner_** | [`User`](../../../lib/core/pipes/user-initial.pipe.ts) ID of the task's owner | -| **_processDefinitionId_** | Process definition ID | -| **_processInstanceId_** | Process instance ID | -| **_lastModified_** | Date the task was last modified. If lastModified defined the component will show the range **_lastModifiedFrom_**, **_lastModifiedTo_** | -| **_sort_** | Field on which the filter results will be sorted (doesn't participate in the filtering itself). Can be "id", "name", "createdDate", "priority", "processDefinitionId". | -| **_order_** | Sort ordering of the filter results it can be ASC or DESC (doesn't participate in the filtering itself). | +| Name | Description | +| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **_appName_** | Name of the app | +| **_status_** | Execution state of the task. | +| **_assignee_** | [`User`](../../../lib/core/pipes/user-initial.pipe.ts) the task is assigned to | +| **_taskName_** | Name of the task | +| **_taskId_** | ID of the task | +| **_parentTaskId_** | ID of the task's parent task | +| **_priority_** | Task priority | +| **_createdDate_** | Date the task was created | +| **_standalone_** | Standalone status of the task | +| **_owner_** | [`User`](../../../lib/core/pipes/user-initial.pipe.ts) ID of the task's owner | +| **_processDefinitionId_** | Process definition ID | +| **_processInstanceId_** | Process instance ID | +| **_lastModified_** | Date the task was last modified. If lastModified defined the component will show the range **_lastModifiedFrom_**, **_lastModifiedTo_** | +| **_sort_** | Field on which the filter results will be sorted (doesn't participate in the filtering itself). Can be "id", "name", "createdDate", "priority", "processDefinitionId". | +| **_order_** | Sort ordering of the filter results it can be ASC or DESC (doesn't participate in the filtering itself). | By default, the **_status_**, **_assignee_**, **_sort_** and **_order_** properties are displayed in the editor. However, you can also choose which properties @@ -168,11 +168,11 @@ With this configuration, only the three listed sort properties will be shown. You can supply various _actions_ to apply on task filter. -| Name | Description | -| ---- | ----------- | -| **_save_** | Save task filter. | +| Name | Description | +| ------------ | -------------------------- | +| **_save_** | Save task filter. | | **_saveAs_** | Creates a new task filter. | -| **_delete_** | Delete task filter. | +| **_delete_** | Delete task filter. | By default, the **_save_**, **_saveAs_** and **_delete_** actions are displayed in the editor. However, you can also choose which actions to diff --git a/docs/process-services-cloud/components/form-cloud.component.md b/docs/process-services-cloud/components/form-cloud.component.md index 4dd752877b..a720bc3de8 100644 --- a/docs/process-services-cloud/components/form-cloud.component.md +++ b/docs/process-services-cloud/components/form-cloud.component.md @@ -74,40 +74,40 @@ The template defined inside `empty-form` will be shown when no form definition i ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| appName | `string` | "" | App name to fetch corresponding form and values. | -| appVersion | `number` | | The application version to use when fetching data | -| 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 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)`[]` | | [FormFieldValidator](../../../lib/core/form/components/widgets/core/form-field-validator.ts) allow to override the form field validators provided. | -| 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 | `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. | -| showSaveButton | `boolean` | true | Toggle rendering of the `Save` outcome button. | -| 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. | +| Name | Type | Default value | Description | +| ------------------------- | --------------------------------------------------------------------------------------------------------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | +| appName | `string` | "" | App name to fetch corresponding form and values. | +| appVersion | `number` | | The application version to use when fetching data | +| 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 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)`[]` | | [FormFieldValidator](../../../lib/core/form/components/widgets/core/form-field-validator.ts) allow to override the form field validators provided. | +| 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 | `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. | +| showSaveButton | `boolean` | true | Toggle rendering of the `Save` outcome button. | +| 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. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when any error occurs. | -| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. | -| formCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. | -| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when form content is clicked. | -| formDataRefreshed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when form values are refreshed due to a data property change. | -| formError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormFieldModel`](../../core/models/form-field.model.md)`[]>` | Emitted when the supplied form values have a validation error. | -| formLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is loaded or reloaded. | -| formSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Save` or custom outcomes. | +| Name | Type | Description | +| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when any error occurs. | +| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. | +| formCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. | +| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when form content is clicked. | +| formDataRefreshed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when form values are refreshed due to a data property change. | +| formError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormFieldModel`](../../core/models/form-field.model.md)`[]>` | Emitted when the supplied form values have a validation error. | +| formLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is loaded or reloaded. | +| formSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Save` or custom outcomes. | ## Details 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 aa8fbf1573..050e262389 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 @@ -21,12 +21,12 @@ Allows one form to be selected from a dropdown list. For forms to be displayed i ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| appName | `string` | "" | Name of the application. If specified, this shows the users who have access to the app. | +| Name | Type | Default value | Description | +| ------- | -------- | ------------- | --------------------------------------------------------------------------------------- | +| appName | `string` | "" | Name of the application. If specified, this shows the users who have access to the app. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| ---------- | -------------------------------------------------------------------- | -------------------------------- | | selectForm | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a form is selected. | diff --git a/docs/process-services-cloud/components/group-cloud.component.md b/docs/process-services-cloud/components/group-cloud.component.md index d0e468eb36..aba1998f7e 100644 --- a/docs/process-services-cloud/components/group-cloud.component.md +++ b/docs/process-services-cloud/components/group-cloud.component.md @@ -35,26 +35,26 @@ Searches Groups. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| appName | `string` | | Name of the application. If specified this shows the groups who have access to the app. | -| groupChipsCtrl | `FormControl` | | FormControl to list of group | -| mode | [`ComponentSelectionMode`](../../../lib/process-services-cloud/src/lib/types.ts) | "single" | Group selection mode (single/multiple). | -| preSelectGroups | [`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`[]` | \[] | Array of groups to be pre-selected. This pre-selects all groups in multi selection mode and only the first group of the array in single selection mode. | -| readOnly | `boolean` | false | Show the info in readonly mode | -| roles | `string[]` | \[] | Role names of the groups to be listed. | -| searchGroupsControl | `FormControl` | | FormControl to search the group | -| title | `string` | | Title of the field | -| validate | `Boolean` | false | This flag enables the validation on the preSelectGroups passed as input. In case the flag is true the components call the [identity service](../../../lib/testing/src/lib/core/actions/identity/identity.service.ts) to verify the validity of the information passed as input. Otherwise, no check will be done. | +| Name | Type | Default value | Description | +| ------------------- | -------------------------------------------------------------------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| appName | `string` | | Name of the application. If specified this shows the groups who have access to the app. | +| groupChipsCtrl | `FormControl` | | FormControl to list of group | +| mode | [`ComponentSelectionMode`](../../../lib/process-services-cloud/src/lib/types.ts) | "single" | Group selection mode (single/multiple). | +| preSelectGroups | [`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`[]` | \[] | Array of groups to be pre-selected. This pre-selects all groups in multi selection mode and only the first group of the array in single selection mode. | +| readOnly | `boolean` | false | Show the info in readonly mode | +| roles | `string[]` | \[] | Role names of the groups to be listed. | +| searchGroupsControl | `FormControl` | | FormControl to search the group | +| title | `string` | | Title of the field | +| validate | `Boolean` | false | This flag enables the validation on the preSelectGroups passed as input. In case the flag is true the components call the [identity service](../../../lib/testing/src/lib/core/actions/identity/identity.service.ts) to verify the validity of the information passed as input. Otherwise, no check will be done. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------- | | changedGroups | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`[]>` | Emitted when a group selection change. | -| removeGroup | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`>` | Emitted when a group is removed. | -| selectGroup | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`>` | Emitted when a group is selected. | -| warning | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an warning occurs. | +| removeGroup | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`>` | Emitted when a group is removed. | +| selectGroup | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`>` | Emitted when a group is selected. | +| warning | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an warning occurs. | ## Details diff --git a/docs/process-services-cloud/components/people-cloud.component.md b/docs/process-services-cloud/components/people-cloud.component.md index e53bc70125..874021cb87 100644 --- a/docs/process-services-cloud/components/people-cloud.component.md +++ b/docs/process-services-cloud/components/people-cloud.component.md @@ -22,26 +22,26 @@ Allows one or more users to be selected (with auto-suggestion) based on the inpu ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| appName | `string` | | Name of the application. If specified, this shows the users who have access to the app. | -| mode | [`ComponentSelectionMode`](../../../lib/process-services-cloud/src/lib/types.ts) | "single" | [User](../../../lib/core/pipes/user-initial.pipe.ts) selection mode (single/multiple). | -| preSelectUsers | [`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]` | \[] | Array of users to be pre-selected. All users in the array are pre-selected in multi selection mode, but only the first user is pre-selected in single selection mode. Mandatory properties are: id, email, username | -| readOnly | `boolean` | false | Show the info in readonly mode | -| roles | `string[]` | | Role names of the users to be listed. | -| searchUserCtrl | `FormControl` | | FormControl to search the user | -| title | `string` | | Placeholder translation key | -| userChipsCtrl | `FormControl` | | FormControl to list of users | -| validate | `boolean` | false | This flag enables the validation on the preSelectUsers passed as input. In case the flag is true the components call the [identity service](../../../lib/testing/src/lib/core/actions/identity/identity.service.ts) to verify the validity of the information passed as input. Otherwise, no check will be done. | +| Name | Type | Default value | Description | +| -------------- | -------------------------------------------------------------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| appName | `string` | | Name of the application. If specified, this shows the users who have access to the app. | +| mode | [`ComponentSelectionMode`](../../../lib/process-services-cloud/src/lib/types.ts) | "single" | [User](../../../lib/core/pipes/user-initial.pipe.ts) selection mode (single/multiple). | +| preSelectUsers | [`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]` | \[] | Array of users to be pre-selected. All users in the array are pre-selected in multi selection mode, but only the first user is pre-selected in single selection mode. Mandatory properties are: id, email, username | +| readOnly | `boolean` | false | Show the info in readonly mode | +| roles | `string[]` | | Role names of the users to be listed. | +| searchUserCtrl | `FormControl` | | FormControl to search the user | +| title | `string` | | Placeholder translation key | +| userChipsCtrl | `FormControl` | | FormControl to list of users | +| validate | `boolean` | false | This flag enables the validation on the preSelectUsers passed as input. In case the flag is true the components call the [identity service](../../../lib/testing/src/lib/core/actions/identity/identity.service.ts) to verify the validity of the information passed as input. Otherwise, no check will be done. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| changedUsers | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>` | Emitted when a user selection change. | -| removeUser | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`>` | Emitted when a selected user is removed in multi selection mode. | -| selectUser | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`>` | Emitted when a user is selected. | -| warning | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an warning occurs. | +| Name | Type | Description | +| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | +| changedUsers | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>` | Emitted when a user selection change. | +| removeUser | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`>` | Emitted when a selected user is removed in multi selection mode. | +| selectUser | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`>` | Emitted when a user is selected. | +| warning | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an warning occurs. | ## Details diff --git a/docs/process-services-cloud/components/process-filters-cloud.component.md b/docs/process-services-cloud/components/process-filters-cloud.component.md index 4c32e6e13b..efb731a308 100644 --- a/docs/process-services-cloud/components/process-filters-cloud.component.md +++ b/docs/process-services-cloud/components/process-filters-cloud.component.md @@ -22,19 +22,19 @@ Lists all available process filters and allows to select a filter. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| appName | `string` | "" | (required) The application name | -| filterParam | [`FilterParamsModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) | | (optional) The filter to be selected by default | -| showIcons | `boolean` | false | (optional) Toggles showing an icon by the side of each filter | +| Name | Type | Default value | Description | +| ----------- | --------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------- | +| appName | `string` | "" | (required) The application name | +| filterParam | [`FilterParamsModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) | | (optional) The filter to be selected by default | +| showIcons | `boolean` | false | (optional) Toggles showing an icon by the side of each filter | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when any error occurs while loading the filters | -| filterClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`>` | Emitted when a filter is selected/clicked | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when filters are loaded successfully | +| Name | Type | Description | +| ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when any error occurs while loading the filters | +| filterClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`>` | Emitted when a filter is selected/clicked | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when filters are loaded successfully | ## See also diff --git a/docs/process-services-cloud/components/process-header-cloud.component.md b/docs/process-services-cloud/components/process-header-cloud.component.md index dd761d040d..553c455af9 100644 --- a/docs/process-services-cloud/components/process-header-cloud.component.md +++ b/docs/process-services-cloud/components/process-header-cloud.component.md @@ -24,10 +24,10 @@ Shows all the information related to a process instance. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| appName | `string` | "" | (Required) The name of the application. | -| processInstanceId | `string` | | (Required) The id of the process instance. | +| Name | Type | Default value | Description | +| ----------------- | -------- | ------------- | ------------------------------------------ | +| appName | `string` | "" | (Required) The name of the application. | +| processInstanceId | `string` | | (Required) The id of the process instance. | ## Details diff --git a/docs/process-services-cloud/components/process-list-cloud.component.md b/docs/process-services-cloud/components/process-list-cloud.component.md index 0df4b90ccc..e859743e74 100644 --- a/docs/process-services-cloud/components/process-list-cloud.component.md +++ b/docs/process-services-cloud/components/process-list-cloud.component.md @@ -54,6 +54,9 @@ when the process list is empty: | appName | `string` | "" | The name of the application. | | appVersion | `number` | | The release version of the application. | | businessKey | `string` | "" | Filter the processes to display only the ones with this businessKey value. | +| completedDate | `string` | "" | Filter the processes. Display only process with completedDate equal to the supplied date. | +| completedFrom | `string` | "" | Filter the processes. Display only process with completedFrom equal to the supplied date. | +| completedTo | `string` | "" | Filter the processes. Display only process with completedTo equal to the supplied date. | | id | `string` | "" | Filter the processes to display only the ones with this ID. | | initiator | `string` | "" | Name of the initiator of the process. | | lastModifiedFrom | `string` | "" | Filter the processes. Display only process with lastModifiedTo equal to the supplied date. | @@ -68,6 +71,8 @@ when the process list is empty: | showActions | `boolean` | false | Toggles the data actions column. | | showContextMenu | `boolean` | false | Toggles custom context menu for the component. | | sorting | [`ProcessListCloudSortingModel`](../../../lib/process-services-cloud/src/lib/process/process-list/models/process-list-sorting.model.ts)`[]` | | Array of objects specifying the sort order and direction for the list. The sort parameters are for BE sorting. | +| startFrom | `string` | "" | Filter the processes. Display only process with startedDate greater then the supplied date. | +| startTo | `string` | "" | Filter the processes. Display only process with startedDate less than the supplied date. | | status | `string` | "" | Filter the processes to display only the ones with this status. | | stickyHeader | `boolean` | false | Toggles the sticky header mode. | 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 c709b33eb1..c02e2f6ee1 100644 --- a/docs/process-services-cloud/components/start-process-cloud.component.md +++ b/docs/process-services-cloud/components/start-process-cloud.component.md @@ -34,25 +34,25 @@ Starts a process. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| appName | `string` | "" | (required) Name of the app. | -| maxNameLength | `number` | | Maximum length of the process name. | -| name | `string` | "" | Name of the process. | -| processDefinitionName | `string` | | Name of the process definition. | -| showSelectProcessDropdown | `boolean` | true | Show/hide the process dropdown list. | -| 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. | +| Name | Type | Default value | Description | +| ------------------------- | --------------------------------------------------------------------------------------------------------------- | ------------- | --------------------------------------------------------------------------- | +| appName | `string` | "" | (required) Name of the app. | +| maxNameLength | `number` | | Maximum length of the process name. | +| name | `string` | "" | Name of the process. | +| processDefinitionName | `string` | | Name of the process definition. | +| showSelectProcessDropdown | `boolean` | true | Show/hide the process dropdown list. | +| 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 | `Function` | | Variables to attach to the payload. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` | Emitted when the starting process is cancelled | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` | Emitted when an error occurs. | -| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when form content is clicked. | -| processDefinitionSelection | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/models/process-definition-cloud.model.ts)`>` | Emitted when process definition selection changes. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` | Emitted when the process is successfully started. | +| Name | Type | Description | +| -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | +| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` | Emitted when the starting process is cancelled | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` | Emitted when an error occurs. | +| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when form content is clicked. | +| processDefinitionSelection | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/models/process-definition-cloud.model.ts)`>` | Emitted when process definition selection changes. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` | Emitted when the process is successfully started. | ## Details diff --git a/docs/process-services-cloud/components/start-task-cloud.component.md b/docs/process-services-cloud/components/start-task-cloud.component.md index ba2c013821..2a09146999 100644 --- a/docs/process-services-cloud/components/start-task-cloud.component.md +++ b/docs/process-services-cloud/components/start-task-cloud.component.md @@ -23,16 +23,16 @@ Creates/starts a new task for the specified app. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| appName | `string` | "" | (required) Name of the app. | -| maxNameLength | `number` | | Maximum length of the task name. | -| name | `string` | "" | Name of the task. | +| Name | Type | Default value | Description | +| ------------- | -------- | ------------- | -------------------------------- | +| appName | `string` | "" | (required) Name of the app. | +| maxNameLength | `number` | | Maximum length of the task name. | +| name | `string` | "" | Name of the task. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the cancel button is clicked by the user. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is successfully created. | +| Name | Type | Description | +| ------- | ------------------------------------------------------------------ | ------------------------------------------------------ | +| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the cancel button is clicked by the user. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is successfully created. | diff --git a/docs/process-services-cloud/components/task-filters-cloud.component.md b/docs/process-services-cloud/components/task-filters-cloud.component.md index 99bcefb9a4..b0916aecfb 100644 --- a/docs/process-services-cloud/components/task-filters-cloud.component.md +++ b/docs/process-services-cloud/components/task-filters-cloud.component.md @@ -19,19 +19,19 @@ Shows all available filters. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| appName | `string` | "" | Display filters available to the current user for the application with the specified name. | -| filterParam | [`FilterParamsModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) | | Parameters to use for the task filter cloud. If there is no match then the default filter (the first one in the list) is selected. | -| showIcons | `boolean` | false | Toggles display of the filter's icons. | +| Name | Type | Default value | Description | +| ----------- | --------------------------------------------------------------------------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| appName | `string` | "" | Display filters available to the current user for the application with the specified name. | +| filterParam | [`FilterParamsModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) | | Parameters to use for the task filter cloud. If there is no match then the default filter (the first one in the list) is selected. | +| showIcons | `boolean` | false | Toggles display of the filter's icons. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs during loading. | +| Name | Type | Description | +| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs during loading. | | filterClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`>` | Emitted when a filter in the list is clicked. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the list is loaded. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the list is loaded. | ## Details @@ -48,11 +48,11 @@ Use the `filterParam` property to restrict the range of filters that are shown: You can use properties from [`FilterParamsModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) as the value of `filterParam` as shown in the table below: -| Name | Type | Description | -| ---- | ---- | ----------- | -| id | string | The id of the task filter | -| name | string | The name of the task filter, lowercase is checked | -| key | string | The key of the task filter | +| Name | Type | Description | +| ----- | ------ | --------------------------------------------------- | +| id | string | The id of the task filter | +| name | string | The name of the task filter, lowercase is checked | +| key | string | The key of the task filter | | index | string | The zero-based position of the filter in the array. | ## See also diff --git a/docs/process-services-cloud/components/task-form-cloud.component.md b/docs/process-services-cloud/components/task-form-cloud.component.md index 1765f73942..086b04ed2f 100644 --- a/docs/process-services-cloud/components/task-form-cloud.component.md +++ b/docs/process-services-cloud/components/task-form-cloud.component.md @@ -33,28 +33,28 @@ Save and Complete buttons get disabled when at least one of the form's inputs ar ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| appName | `string` | "" | App id to fetch corresponding form and values. | -| readOnly | `boolean` | false | Toggle readonly state of the task. | -| showCancelButton | `boolean` | true | Toggle rendering of the `Cancel` button. | -| showCompleteButton | `boolean` | true | Toggle rendering of the `Complete` button. | -| showRefreshButton | `boolean` | false | Toggle rendering of the `Refresh` button. | -| showValidationIcon | `boolean` | true | Toggle rendering of the `Validation` icon. | -| taskId | `string` | | Task id to fetch corresponding form and values. | +| Name | Type | Default value | Description | +| ------------------ | --------- | ------------- | ----------------------------------------------- | +| appName | `string` | "" | App id to fetch corresponding form and values. | +| readOnly | `boolean` | false | Toggle readonly state of the task. | +| showCancelButton | `boolean` | true | Toggle rendering of the `Cancel` button. | +| showCompleteButton | `boolean` | true | Toggle rendering of the `Complete` button. | +| showRefreshButton | `boolean` | false | Toggle rendering of the `Refresh` button. | +| showValidationIcon | `boolean` | true | Toggle rendering of the `Validation` icon. | +| taskId | `string` | | Task id to fetch corresponding form and values. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| cancelClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the cancel button is clicked. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when any error occurs. | -| formCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. | -| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when form content is clicked. | -| formSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is saved. | -| taskClaimed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is claimed. | -| taskCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is completed. | -| taskUnclaimed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is unclaimed. | +| Name | Type | Description | +| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | +| cancelClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the cancel button is clicked. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when any error occurs. | +| formCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. | +| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when form content is clicked. | +| formSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is saved. | +| taskClaimed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is claimed. | +| taskCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is completed. | +| taskUnclaimed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is unclaimed. | ## See also diff --git a/docs/process-services-cloud/components/task-header-cloud.component.md b/docs/process-services-cloud/components/task-header-cloud.component.md index 86ce975c9b..7148a56a6c 100644 --- a/docs/process-services-cloud/components/task-header-cloud.component.md +++ b/docs/process-services-cloud/components/task-header-cloud.component.md @@ -24,18 +24,18 @@ Shows all the information related to a task. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| appName | `string` | "" | (Required) The name of the application. | -| showTitle | `boolean` | true | Show/Hide the task title | -| taskId | `string` | | (Required) The id of the task. | +| Name | Type | Default value | Description | +| --------- | --------- | ------------- | --------------------------------------- | +| appName | `string` | "" | (Required) The name of the application. | +| showTitle | `boolean` | true | Show/Hide the task title | +| taskId | `string` | | (Required) The id of the task. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| claim | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is claimed. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the given task has errors. | +| Name | Type | Description | +| ------- | ----------------------------------------------------------------- | -------------------------------------------------- | +| claim | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is claimed. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the given task has errors. | | unclaim | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is unclaimed (ie, requeued). | ## Details diff --git a/docs/process-services-cloud/components/task-list-cloud.component.md b/docs/process-services-cloud/components/task-list-cloud.component.md index c591ff2c01..bebb6ac38c 100644 --- a/docs/process-services-cloud/components/task-list-cloud.component.md +++ b/docs/process-services-cloud/components/task-list-cloud.component.md @@ -49,33 +49,38 @@ when the task list is empty: ### Properties -| Name | Type | Default value | Description | -| ------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| actionsPosition | `string` | "right" | Position of the actions dropdown menu. Can be "left" or "right". | -| appName | `string` | "" | The name of the application. | -| assignee | `string` | "" | The assignee of the process. Possible values are: "assignee" (the current user is the assignee), "candidate" (the current user is a task candidate", "group_x" (the task is assigned to a group where the current user is a member, no value (the current user is involved). | -| createdDate | `string` | "" | Filter the tasks. Display only tasks created on the supplied date. | -| dueDate | `string` | "" | Filter the tasks. Display only tasks with dueDate equal to the supplied date. | -| dueDateFrom | `string` | "" | Filter the tasks. Display only tasks with dueDate greater or equal than the supplied date. | -| dueDateTo | `string` | "" | Filter the tasks. Display only tasks with dueDate less or equal to the supplied date. | -| id | `string` | "" | Filter the tasks. Display only tasks with id equal to the supplied value. | -| lastModifiedFrom | `string` | "" | Filter the tasks. Display only tasks with lastModifiedFrom equal to the supplied date. | -| lastModifiedTo | `string` | "" | Filter the tasks. Display only tasks with lastModifiedTo equal to the supplied date. | -| multiselect | `boolean` | false | Toggles multiple row selection, rendering a checkbox at the beginning of each row. | -| name | `string` | "" | Filter the tasks. Display only tasks with the supplied name. | -| owner | `string` | "" | Filter the tasks. Display only tasks with owner equal to the supplied value. | -| parentTaskId | `string` | "" | Filter the tasks. Display only tasks with parentTaskId equal to the supplied value. | -| presetColumn | `string` | | Custom preset column schema in JSON format. | -| priority | `number` | | Filter the tasks. Display only tasks with priority equal to the supplied value. | -| processDefinitionId | `string` | "" | Filter the tasks. Display only tasks with processDefinitionId equal to the supplied value. | -| processInstanceId | `string` | "" | Filter the tasks. Display only tasks with processInstanceId equal to the supplied value. | -| selectionMode | `string` | "single" | Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode, you can use the Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. | -| showActions | `boolean` | false | Toggles the data actions column. | -| showContextMenu | `boolean` | false | Toggles custom context menu for the component. | -| sorting | [`TaskListCloudSortingModel`](../../../lib/process-services-cloud/src/lib/task/task-list/models/task-list-sorting.model.ts)`[]` | | Specifies how the table should be sorted. The parameters are for BE sorting. | -| standalone | `boolean` | false | Filter the tasks. Display only the tasks that belong to a process in case is false or tasks that doesn't belong to a process in case of true. | -| status | `string` | "" | Filter the tasks. Display only tasks with status equal to the supplied value. | -| stickyHeader | `boolean` | false | Toggles the sticky header mode. | +| Name | Type | Default value | Description | +| --------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| actionsPosition | `string` | "right" | Position of the actions dropdown menu. Can be "left" or "right". | +| appName | `string` | "" | The name of the application. | +| assignee | `string` | "" | The assignee of the process. Possible values are: "assignee" (the current user is the assignee), "candidate" (the current user is a task candidate", "group_x" (the task is assigned to a group where the current user is a member, no value (the current user is involved). | +| completedBy | `number` | | Filter the tasks. Display only tasks with createdBy equal to the supplied value. | +| completedDate | `string` | "" | Filter the tasks. Display only tasks with completedDate equal to the supplied date. | +| completedFrom | `string` | "" | Filter the tasks. Display only tasks with completedFrom equal to the supplied date. | +| completedTo | `string` | "" | Filter the tasks. Display only tasks with completedTo equal to the supplied date. | +| createdDate | `string` | "" | Filter the tasks. Display only tasks created on the supplied date. | +| dueDate | `string` | "" | Filter the tasks. Display only tasks with dueDate equal to the supplied date. | +| dueDateFrom | `string` | "" | Filter the tasks. Display only tasks with dueDate greater or equal than the supplied date. | +| dueDateTo | `string` | "" | Filter the tasks. Display only tasks with dueDate less or equal to the supplied date. | +| id | `string` | "" | Filter the tasks. Display only tasks with id equal to the supplied value. | +| lastModifiedFrom | `string` | "" | Filter the tasks. Display only tasks with lastModifiedFrom equal to the supplied date. | +| lastModifiedTo | `string` | "" | Filter the tasks. Display only tasks with lastModifiedTo equal to the supplied date. | +| multiselect | `boolean` | false | Toggles multiple row selection, rendering a checkbox at the beginning of each row. | +| name | `string` | "" | Filter the tasks. Display only tasks with the supplied name. | +| owner | `string` | "" | Filter the tasks. Display only tasks with owner equal to the supplied value. | +| parentTaskId | `string` | "" | Filter the tasks. Display only tasks with parentTaskId equal to the supplied value. | +| presetColumn | `string` | | Custom preset column schema in JSON format. | +| priority | `number` | | Filter the tasks. Display only tasks with priority equal to the supplied value. | +| processDefinitionId | `string` | "" | Filter the tasks. Display only tasks with processDefinitionId equal to the supplied value. | +| processDefinitionName | `string` | "" | Filter the tasks. Display only tasks with processDefinitionName equal to the supplied value. | +| processInstanceId | `string` | "" | Filter the tasks. Display only tasks with processInstanceId equal to the supplied value. | +| selectionMode | `string` | "single" | Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode, you can use the Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. | +| showActions | `boolean` | false | Toggles the data actions column. | +| showContextMenu | `boolean` | false | Toggles custom context menu for the component. | +| sorting | [`TaskListCloudSortingModel`](../../../lib/process-services-cloud/src/lib/task/task-list/models/task-list-sorting.model.ts)`[]` | | Specifies how the table should be sorted. The parameters are for BE sorting. | +| standalone | `boolean` | false | Filter the tasks. Display only the tasks that belong to a process in case is false or tasks that doesn't belong to a process in case of true. | +| status | `string` | "" | Filter the tasks. Display only tasks with status equal to the supplied value. | +| stickyHeader | `boolean` | false | Toggles the sticky header mode. | ### Events diff --git a/docs/process-services-cloud/directives/claim-task-cloud.directive.md b/docs/process-services-cloud/directives/claim-task-cloud.directive.md index a53863da05..00c6c60013 100644 --- a/docs/process-services-cloud/directives/claim-task-cloud.directive.md +++ b/docs/process-services-cloud/directives/claim-task-cloud.directive.md @@ -19,14 +19,14 @@ Claims a task ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| appName | `string` | "" | (Required) The name of the application. | -| taskId | `string` | | (Required) The id of the task. | +| Name | Type | Default value | Description | +| ------- | -------- | ------------- | --------------------------------------- | +| appName | `string` | "" | (Required) The name of the application. | +| taskId | `string` | | (Required) The id of the task. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task cannot be completed. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is completed. | +| Name | Type | Description | +| ------- | ----------------------------------------------------------------- | ------------------------------------------ | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task cannot be completed. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is completed. | diff --git a/docs/process-services-cloud/directives/complete-task.directive.md b/docs/process-services-cloud/directives/complete-task.directive.md index bc7587b2a7..c955450c37 100644 --- a/docs/process-services-cloud/directives/complete-task.directive.md +++ b/docs/process-services-cloud/directives/complete-task.directive.md @@ -19,14 +19,14 @@ Completes a task. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| appName | `string` | "" | (Required) The name of the application. | -| taskId | `string` | | (Required) The id of the task. | +| Name | Type | Default value | Description | +| ------- | -------- | ------------- | --------------------------------------- | +| appName | `string` | "" | (Required) The name of the application. | +| taskId | `string` | | (Required) The id of the task. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task cannot be completed. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is completed. | +| Name | Type | Description | +| ------- | ----------------------------------------------------------------- | ------------------------------------------ | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task cannot be completed. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is completed. | diff --git a/docs/process-services-cloud/services/apps-process-cloud.service.md b/docs/process-services-cloud/services/apps-process-cloud.service.md index e6755d0439..8fbbf688c8 100644 --- a/docs/process-services-cloud/services/apps-process-cloud.service.md +++ b/docs/process-services-cloud/services/apps-process-cloud.service.md @@ -21,7 +21,6 @@ Gets details of deployed apps for the current user. - **hasDeployedApps**(): `boolean`
- **Returns** `boolean` - - - **loadApps**()
## Details diff --git a/docs/process-services-cloud/services/form-cloud.service.md b/docs/process-services-cloud/services/form-cloud.service.md index 9694adba45..89bf95a1fa 100644 --- a/docs/process-services-cloud/services/form-cloud.service.md +++ b/docs/process-services-cloud/services/form-cloud.service.md @@ -42,12 +42,10 @@ class MyComponent { - _nodeId:_ `string` - - _contentHost:_ `string` - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - - - **getBasePath**(appName: `string`): `string`
- _appName:_ `string` - - **Returns** `string` - - - **getDropDownJsonData**(url: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Parses JSON data to create a corresponding form. - _url:_ `string` - String data to make the request diff --git a/docs/process-services-cloud/services/local-preference-cloud.service.md b/docs/process-services-cloud/services/local-preference-cloud.service.md index 8db91da97c..fb1b3227c0 100644 --- a/docs/process-services-cloud/services/local-preference-cloud.service.md +++ b/docs/process-services-cloud/services/local-preference-cloud.service.md @@ -38,7 +38,6 @@ Manages Local Storage preferences. - _key:_ `string` - - **Returns** `any` - - - **updatePreference**(\_: `string`, key: `string`, updatedPreference: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Updates local preference. - _\_:_ `string` - Name of the target app diff --git a/docs/process-services-cloud/services/process-cloud.service.md b/docs/process-services-cloud/services/process-cloud.service.md index c8076e143b..9e2197efe1 100644 --- a/docs/process-services-cloud/services/process-cloud.service.md +++ b/docs/process-services-cloud/services/process-cloud.service.md @@ -22,7 +22,6 @@ Manages cloud process instances. - _appName:_ `string` - - **Returns** `string` - - - **getProcessDefinitions**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/models/process-definition-cloud.model.ts)`[]>`
Gets the process definitions associated with an app. - _appName:_ `string` - Name of the target app diff --git a/docs/process-services-cloud/services/process-list-cloud.service.md b/docs/process-services-cloud/services/process-list-cloud.service.md index 30d836300b..e14da06598 100644 --- a/docs/process-services-cloud/services/process-list-cloud.service.md +++ b/docs/process-services-cloud/services/process-list-cloud.service.md @@ -17,7 +17,6 @@ Searches processes. - _appName:_ `string` - - **Returns** `string` - - - **getProcessByRequest**(requestNode: [`ProcessQueryCloudRequestModel`](../../../lib/process-services-cloud/src/lib/process/process-list/models/process-cloud-query-request.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
Finds a process using an object with optional query properties. - _requestNode:_ [`ProcessQueryCloudRequestModel`](../../../lib/process-services-cloud/src/lib/process/process-list/models/process-cloud-query-request.model.ts) - Query object diff --git a/docs/process-services-cloud/services/task-cloud.service.md b/docs/process-services-cloud/services/task-cloud.service.md index 14bd33147f..d46db51767 100644 --- a/docs/process-services-cloud/services/task-cloud.service.md +++ b/docs/process-services-cloud/services/task-cloud.service.md @@ -13,6 +13,12 @@ Manages task cloud. ### Methods +- **assign**(appName: `string`, taskId: `string`, assignee: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
+ Updates the task assignee. + - _appName:_ `string` - Name of the app + - _taskId:_ `string` - ID of the task to update assignee + - _assignee:_ `string` - assignee to update current user task assignee + - **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 with new assignee - **canClaimTask**(taskDetails: [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)): `boolean`
Validate if a task can be claimed. - _taskDetails:_ [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) - task details object @@ -64,6 +70,12 @@ Manages task cloud. - _appName:_ `string` - Name of the app - _taskId:_ `string` - ID of the task whose details you want - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Task details +- **isAssigneePropertyClickable**(taskDetails: [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts), candidateUsers: [`CardViewArrayItem`](../../../lib/core/card-view/models/card-view-arrayitem.model.ts)`[]`, candidateGroups: [`CardViewArrayItem`](../../../lib/core/card-view/models/card-view-arrayitem.model.ts)`[]`): `boolean`
+ + - _taskDetails:_ [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) - + - _candidateUsers:_ [`CardViewArrayItem`](../../../lib/core/card-view/models/card-view-arrayitem.model.ts)`[]` - + - _candidateGroups:_ [`CardViewArrayItem`](../../../lib/core/card-view/models/card-view-arrayitem.model.ts)`[]` - + - **Returns** `boolean` - - **isTaskEditable**(taskDetails: [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)): `boolean`
Validate if a task is editable. - _taskDetails:_ [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) - task details object @@ -79,12 +91,6 @@ Manages task cloud. - _taskId:_ `string` - ID of the task to update - _payload:_ `any` - Data to update the task - **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 -- **assign**(appName: `string`, taskId: `string`, assignee: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
- Changes assignee of the user task. - - _appName:_ `string` - Name of the app - - _taskId:_ `string` - ID of the task to update assignee - - _assignee:_ `string` - assignee to update current user task assignee - - **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 ## Details diff --git a/docs/process-services-cloud/services/task-filter-cloud.service.md b/docs/process-services-cloud/services/task-filter-cloud.service.md index 3aeb24911d..ede7437fac 100644 --- a/docs/process-services-cloud/services/task-filter-cloud.service.md +++ b/docs/process-services-cloud/services/task-filter-cloud.service.md @@ -30,9 +30,6 @@ Manages task filters. Gets all task filters for a task app. - _appName:_ `string` - (Optional) Name of the target app - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`[]>` - Observable of task filter details -- **getUsername**(): `string`
- Gets the username field from the access token. - - **Returns** `string` - Username string - **isDefaultFilter**(filterName: `string`): `boolean`
Checks if given filter is a default filter - _filterName:_ `string` - Name of the target task filter diff --git a/docs/process-services-cloud/services/task-list-cloud.service.md b/docs/process-services-cloud/services/task-list-cloud.service.md index 9151185ceb..b250f8b361 100644 --- a/docs/process-services-cloud/services/task-list-cloud.service.md +++ b/docs/process-services-cloud/services/task-list-cloud.service.md @@ -17,7 +17,6 @@ Searches tasks. - _appName:_ `string` - - **Returns** `string` - - - **getTaskByRequest**(requestNode: [`TaskQueryCloudRequestModel`](../../../lib/process-services-cloud/src/lib/task/task-list/models/filter-cloud-model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
Finds a task using an object with optional query properties. - _requestNode:_ [`TaskQueryCloudRequestModel`](../../../lib/process-services-cloud/src/lib/task/task-list/models/filter-cloud-model.ts) - Query object diff --git a/docs/process-services-cloud/services/user-preference-cloud.service.md b/docs/process-services-cloud/services/user-preference-cloud.service.md index fe379975e3..ed27c84334 100644 --- a/docs/process-services-cloud/services/user-preference-cloud.service.md +++ b/docs/process-services-cloud/services/user-preference-cloud.service.md @@ -28,7 +28,6 @@ Manages user preferences. - _appName:_ `string` - - **Returns** `string` - - - **getPreferenceByKey**(appName: `string`, key: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets user preference. - _appName:_ `string` - Name of the target app diff --git a/docs/process-services/components/apps-list.component.md b/docs/process-services/components/apps-list.component.md index 3412cd629e..75a8a10740 100644 --- a/docs/process-services/components/apps-list.component.md +++ b/docs/process-services/components/apps-list.component.md @@ -37,17 +37,17 @@ You can show custom content when there are no apps available by supplying an ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| filtersAppId | `any[]` | | Provides a way to filter the apps to show. | -| layoutType | `string` | | (**required**) Defines the layout of the apps. There are two possible values, "GRID" and "LIST". | +| Name | Type | Default value | Description | +| ------------ | -------- | ------------- | ------------------------------------------------------------------------------------------------ | +| filtersAppId | `any[]` | | Provides a way to filter the apps to show. | +| layoutType | `string` | | (**required**) Defines the layout of the apps. There are two possible values, "GRID" and "LIST". | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | | appClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`AppDefinitionRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`>` | Emitted when an app entry is clicked. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | ## Details diff --git a/docs/process-services/components/attach-form.component.md b/docs/process-services/components/attach-form.component.md index b78b686065..fa2562a2e5 100644 --- a/docs/process-services/components/attach-form.component.md +++ b/docs/process-services/components/attach-form.component.md @@ -21,15 +21,15 @@ This component can be used when there is no form attached to a task and you want ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| formKey | `any` | | Identifier of the form to attach. | -| taskId | `any` | | Id of the task. | +| Name | Type | Default value | Description | +| ------- | ----- | ------------- | --------------------------------- | +| formKey | `any` | | Identifier of the form to attach. | +| taskId | `any` | | Id of the task. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| cancelAttachForm | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "Cancel" button is clicked. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the form is attached successfully. | +| Name | Type | Description | +| ---------------- | ------------------------------------------------------------------ | ----------------------------------------------- | +| cancelAttachForm | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "Cancel" button is clicked. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the form is attached successfully. | diff --git a/docs/process-services/components/checklist.component.md b/docs/process-services/components/checklist.component.md index a40e3249d3..4b636a7c6f 100644 --- a/docs/process-services/components/checklist.component.md +++ b/docs/process-services/components/checklist.component.md @@ -23,16 +23,16 @@ Shows the checklist task functionality. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| assignee | `string` | | (required) The assignee id that the subtasks are assigned to. | -| readOnly | `boolean` | false | Toggle readonly state of the form. All form widgets will render as readonly if enabled. | -| taskId | `string` | | (required) The id of the parent task to which subtasks are attached. | +| Name | Type | Default value | Description | +| -------- | --------- | ------------- | --------------------------------------------------------------------------------------- | +| assignee | `string` | | (required) The assignee id that the subtasks are assigned to. | +| readOnly | `boolean` | false | Toggle readonly state of the form. All form widgets will render as readonly if enabled. | +| taskId | `string` | | (required) The id of the parent task to which subtasks are attached. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------- | | checklistTaskCreated | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>` | Emitted when a new checklist task is created. | -| checklistTaskDeleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a checklist task is deleted. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| checklistTaskDeleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a checklist task is deleted. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | diff --git a/docs/process-services/components/create-process-attachment.component.md b/docs/process-services/components/create-process-attachment.component.md index 9524cedfbc..0cdc245272 100644 --- a/docs/process-services/components/create-process-attachment.component.md +++ b/docs/process-services/components/create-process-attachment.component.md @@ -25,13 +25,13 @@ Displays an Upload Component (Drag and Click) to upload the attachment to a spec ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| processInstanceId | `string` | | (required) The ID of the process instance to display. | +| Name | Type | Default value | Description | +| ----------------- | -------- | ------------- | ----------------------------------------------------- | +| processInstanceId | `string` | | (required) The ID of the process instance to display. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs while creating or uploading an attachment from the user within the component. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an attachment is successfully created or uploaded from within the component. | +| Name | Type | Description | +| ------- | ----------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs while creating or uploading an attachment from the user within the component. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an attachment is successfully created or uploaded from within the component. | diff --git a/docs/process-services/components/create-task-attachment.component.md b/docs/process-services/components/create-task-attachment.component.md index 4ca054a808..fdac3ec614 100644 --- a/docs/process-services/components/create-task-attachment.component.md +++ b/docs/process-services/components/create-task-attachment.component.md @@ -25,13 +25,13 @@ Displays an Upload Component (Drag and Click) to upload the attachment to a spec ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| taskId | `string` | | (required) The numeric ID of the task to display. | +| Name | Type | Default value | Description | +| ------ | -------- | ------------- | ------------------------------------------------- | +| taskId | `string` | | (required) The numeric ID of the task to display. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs while creating or uploading an attachment from the user within the component. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an attachment is created or uploaded successfully from within the component. | +| Name | Type | Description | +| ------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs while creating or uploading an attachment from the user within the component. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an attachment is created or uploaded successfully from within the component. | diff --git a/docs/process-services/components/form.component.md b/docs/process-services/components/form.component.md index 636cb5d4e0..a35695e338 100644 --- a/docs/process-services/components/form.component.md +++ b/docs/process-services/components/form.component.md @@ -52,41 +52,41 @@ Any content in the body of `` will be shown when no form definition is ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| 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. | -| 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. | -| nameNode | `string` | | Name to assign to the new node where the metadata are stored. | -| nodeId | `string` | | Content Services node ID for the form metadata. | -| path | `string` | | Path of the folder where the metadata will be stored. | -| readOnly | `boolean` | false | Toggle readonly state of the form. Forces all form widgets to render as readonly if enabled. | -| saveMetadata | `boolean` | false | Toggle saving of form metadata. | -| showCompleteButton | `boolean` | true | Toggle rendering of the `Complete` outcome button. | -| showRefreshButton | `boolean` | true | Toggle rendering of the `Refresh` button. | -| showSaveButton | `boolean` | true | Toggle rendering of the `Save` outcome button. | -| showTitle | `boolean` | true | Toggle rendering of the form title. | -| showValidationIcon | `boolean` | true | Toggle rendering of the validation icon next to the form title. | -| taskId | `string` | | Task id to fetch corresponding form and values. | -| enableFixedSpacedForm | `boolean` | true | The form will set a prefixed space for invisible fields | +| Name | Type | Default value | Description | +| ------------------------- | -------------------------------------------------------------------------------------------------- | ------------- | ----------------------------------------------------------------------------------------------- | +| 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. | +| enableFixedSpacedForm | `boolean` | true | The form will set a prefixed space for invisible fields. | +| 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. | +| nameNode | `string` | | Name to assign to the new node where the metadata are stored. | +| nodeId | `string` | | Content Services node ID for the form metadata. | +| path | `string` | | Path of the folder where the metadata will be stored. | +| readOnly | `boolean` | false | Toggle readonly state of the form. Forces all form widgets to render as readonly if enabled. | +| saveMetadata | `boolean` | false | Toggle saving of form metadata. | +| showCompleteButton | `boolean` | true | Toggle rendering of the `Complete` outcome button. | +| showRefreshButton | `boolean` | true | Toggle rendering of the `Refresh` button. | +| showSaveButton | `boolean` | true | Toggle rendering of the `Save` outcome button. | +| showTitle | `boolean` | true | Toggle rendering of the form title. | +| showValidationIcon | `boolean` | true | Toggle rendering of the validation icon next to the form title. | +| taskId | `string` | | Task id to fetch corresponding form and values. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when any error occurs. | -| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. | -| formCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. | -| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when form content is clicked. | -| formDataRefreshed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when form values are refreshed due to a data property change. | -| formError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormFieldModel`](../../core/models/form-field.model.md)`[]>` | Emitted when the supplied form values have a validation error. | -| formLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is loaded or reloaded. | -| formSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Save` or custom outcomes. | +| Name | Type | Description | +| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when any error occurs. | +| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. | +| formCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. | +| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when form content is clicked. | +| formDataRefreshed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when form values are refreshed due to a data property change. | +| formError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormFieldModel`](../../core/models/form-field.model.md)`[]>` | Emitted when the supplied form values have a validation error. | +| formLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is loaded or reloaded. | +| formSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Save` or custom outcomes. | ## Details diff --git a/docs/process-services/components/people-list.component.md b/docs/process-services/components/people-list.component.md index f0ad4ef0ba..259b1ce3ba 100644 --- a/docs/process-services/components/people-list.component.md +++ b/docs/process-services/components/people-list.component.md @@ -76,14 +76,14 @@ You can use column templates with the [people list component](people-list.compon ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| actions | `boolean` | false | Toggles whether or not actions should be visible, i.e. the 'Three-Dots' menu. | -| users | [`UserProcessModel`](../../core/models/user-process.model.md)`[]` | | The array of user data used to populate the people list. | +| Name | Type | Default value | Description | +| ------- | ----------------------------------------------------------------- | ------------- | ----------------------------------------------------------------------------- | +| actions | `boolean` | false | Toggles whether or not actions should be visible, i.e. the 'Three-Dots' menu. | +| users | [`UserProcessModel`](../../core/models/user-process.model.md)`[]` | | The array of user data used to populate the people list. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | | clickAction | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UserEventModel`](../../../lib/process-services/src/lib/task-list/models/user-event.model.ts)`>` | Emitted when the user clicks in the 'Three Dots' drop down menu for a row. | -| clickRow | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UserProcessModel`](../../core/models/user-process.model.md)`>` | Emitted when the user clicks a row in the people list. | +| clickRow | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UserProcessModel`](../../core/models/user-process.model.md)`>` | Emitted when the user clicks a row in the people list. | diff --git a/docs/process-services/components/people-search.component.md b/docs/process-services/components/people-search.component.md index f55fcaaa68..8218c8c4b4 100644 --- a/docs/process-services/components/people-search.component.md +++ b/docs/process-services/components/people-search.component.md @@ -31,17 +31,17 @@ special sub-components in the body of the `` element: ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| results | [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserProcessModel`](../../core/models/user-process.model.md)`[]>` | | Parameters for displaying the list. | +| Name | Type | Default value | Description | +| ------- | -------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ----------------------------------- | +| results | [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserProcessModel`](../../core/models/user-process.model.md)`[]>` | | Parameters for displaying the list. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| closeSearch | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "close" button is clicked. | -| searchPeople | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a search is performed with a new keyword. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UserProcessModel`](../../core/models/user-process.model.md)`>` | Emitted when a user is selected and the action button is clicked. | +| Name | Type | Description | +| ------------ | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | +| closeSearch | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "close" button is clicked. | +| searchPeople | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a search is performed with a new keyword. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UserProcessModel`](../../core/models/user-process.model.md)`>` | Emitted when a user is selected and the action button is clicked. | ## Details diff --git a/docs/process-services/components/people.component.md b/docs/process-services/components/people.component.md index 5195727009..c5b7317736 100644 --- a/docs/process-services/components/people.component.md +++ b/docs/process-services/components/people.component.md @@ -37,11 +37,11 @@ Displays users involved with a specified task ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| people | [`UserProcessModel`](../../core/models/user-process.model.md)`[]` | \[] | The array of [User](../../../lib/core/pipes/user-initial.pipe.ts) objects to display. | -| readOnly | `boolean` | false | Should the data be read-only? | -| taskId | `string` | "" | The numeric ID of the task. | +| Name | Type | Default value | Description | +| -------- | ----------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------- | +| people | [`UserProcessModel`](../../core/models/user-process.model.md)`[]` | \[] | The array of [User](../../../lib/core/pipes/user-initial.pipe.ts) objects to display. | +| readOnly | `boolean` | false | Should the data be read-only? | +| taskId | `string` | "" | The numeric ID of the task. | ## Details diff --git a/docs/process-services/components/process-attachment-list.component.md b/docs/process-services/components/process-attachment-list.component.md index 41a0da993f..5f62b129ed 100644 --- a/docs/process-services/components/process-attachment-list.component.md +++ b/docs/process-services/components/process-attachment-list.component.md @@ -58,18 +58,18 @@ A default template will be used if you don't supply a custom one to override it: ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| disabled | `boolean` | false | Disable/Enable read-only mode for attachment list. | -| processInstanceId | `string` | | (**required**) The ID of the process instance to display. | +| Name | Type | Default value | Description | +| ----------------- | --------- | ------------- | --------------------------------------------------------- | +| disabled | `boolean` | false | Disable/Enable read-only mode for attachment list. | +| processInstanceId | `string` | | (**required**) The ID of the process instance to display. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| --------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | attachmentClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the attachment is double-clicked or the view option is selected from the context menu by the user from within the component. Returns a [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) representing the object that was clicked. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the attachment list is not able to fetch the attachments (eg, following a network error). | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the attachment list is not able to fetch the attachments (eg, following a network error). | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. | ## Details diff --git a/docs/process-services/components/process-comments.component.md b/docs/process-services/components/process-comments.component.md index 7bb82fdb60..e6d4df5b1e 100644 --- a/docs/process-services/components/process-comments.component.md +++ b/docs/process-services/components/process-comments.component.md @@ -20,13 +20,13 @@ Displays comments associated with a particular process instance and allows the u ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| processInstanceId | `string` | | (**required**) The numeric ID of the process instance to display comments for. | -| readOnly | `boolean` | true | Should the comments be read-only? | +| Name | Type | Default value | Description | +| ----------------- | --------- | ------------- | ------------------------------------------------------------------------------ | +| processInstanceId | `string` | | (**required**) The numeric ID of the process instance to display comments for. | +| readOnly | `boolean` | true | Should the comments be read-only? | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| ----- | ----------------------------------------------------------------- | ----------------------------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | diff --git a/docs/process-services/components/process-filters.component.md b/docs/process-services/components/process-filters.component.md index 36b2a89dba..37a762ba37 100644 --- a/docs/process-services/components/process-filters.component.md +++ b/docs/process-services/components/process-filters.component.md @@ -32,21 +32,21 @@ Collection of criteria used to filter process instances, which may be customized ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| appId | `number` | | Display filters available to the current user for the application with the specified ID. | -| appName | `string` | | Display filters available to the current user for the application with the specified name. | -| filterParam | [`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts) | | The parameters to filter the task filter. If there is no match then the default one (ie, the first filter in the list) is selected. | -| showIcon | `boolean` | true | Toggle to show or hide the filter's icon. | +| Name | Type | Default value | Description | +| ----------- | ----------------------------------------------------------------------------------------------------------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------- | +| appId | `number` | | Display filters available to the current user for the application with the specified ID. | +| appName | `string` | | Display filters available to the current user for the application with the specified name. | +| filterParam | [`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts) | | The parameters to filter the task filter. If there is no match then the default one (ie, the first filter in the list) is selected. | +| showIcon | `boolean` | true | Toggle to show or hide the filter's icon. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| filterClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UserProcessInstanceFilterRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/UserProcessInstanceFilterRepresentation.md)`>` | Emitted when the user selects a filter from the list. | -| filterSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceFilterRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/ProcessInstanceFilterRepresentation.md)`>` | Emitted when a process filter is selected. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceFilterRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/ProcessInstanceFilterRepresentation.md)`[]>` | Emitted when the list of filters has been successfully loaded from the server. | +| Name | Type | Description | +| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| filterClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UserProcessInstanceFilterRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/UserProcessInstanceFilterRepresentation.md)`>` | Emitted when the user selects a filter from the list. | +| filterSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceFilterRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/ProcessInstanceFilterRepresentation.md)`>` | Emitted when a process filter is selected. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceFilterRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/ProcessInstanceFilterRepresentation.md)`[]>` | Emitted when the list of filters has been successfully loaded from the server. | ## Details @@ -78,11 +78,11 @@ You can use inside the filterParam one of the properties defined by [`FilterPara } ``` -| Name | Type | Description | -| ---- | ---- | ----------- | -| id | string | The id of the task filter. | -| name | string | The name of the task filter, lowercase is checked. | -| index | number | Zero-based position of the filter in the array. | +| Name | Type | Description | +| ----- | ------ | -------------------------------------------------- | +| id | string | The id of the task filter. | +| name | string | The name of the task filter, lowercase is checked. | +| index | number | Zero-based position of the filter in the array. | ## See also diff --git a/docs/process-services/components/process-instance-details.component.md b/docs/process-services/components/process-instance-details.component.md index bd96498023..72f42740b9 100644 --- a/docs/process-services/components/process-instance-details.component.md +++ b/docs/process-services/components/process-instance-details.component.md @@ -21,17 +21,17 @@ Displays detailed information about a specified process instance ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| processInstanceId | `string` | | (required) The numeric ID of the process instance to display. | -| showRefreshButton | `boolean` | true | Toggles whether to show or hide the refresh button. | -| showTitle | `boolean` | true | Toggles whether to show or hide the title. | +| Name | Type | Default value | Description | +| ----------------- | --------- | ------------- | ------------------------------------------------------------- | +| processInstanceId | `string` | | (required) The numeric ID of the process instance to display. | +| showRefreshButton | `boolean` | true | Toggles whether to show or hide the refresh button. | +| showTitle | `boolean` | true | Toggles whether to show or hide the title. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| processCancelled | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the current process is cancelled by the user from within the component. | -| showProcessDiagram | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "show diagram" button is clicked. | -| taskClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskDetailsEvent`](../../../lib/process-services/src/lib/task-list/models/task-details.event.ts)`>` | Emitted when a task is clicked. | +| Name | Type | Description | +| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| processCancelled | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the current process is cancelled by the user from within the component. | +| showProcessDiagram | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "show diagram" button is clicked. | +| taskClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskDetailsEvent`](../../../lib/process-services/src/lib/task-list/models/task-details.event.ts)`>` | Emitted when a task is clicked. | diff --git a/docs/process-services/components/process-instance-header.component.md b/docs/process-services/components/process-instance-header.component.md index 18d383d1cc..1a505d6d66 100644 --- a/docs/process-services/components/process-instance-header.component.md +++ b/docs/process-services/components/process-instance-header.component.md @@ -23,9 +23,9 @@ Sub-component of the process details component, which renders some general infor ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| processInstance | [`ProcessInstance`](../../../lib/process-services/src/lib/process-list/models/process-instance.model.ts) | | (**required**) Full details of the process instance to display information about. | +| Name | Type | Default value | Description | +| --------------- | -------------------------------------------------------------------------------------------------------- | ------------- | --------------------------------------------------------------------------------- | +| processInstance | [`ProcessInstance`](../../../lib/process-services/src/lib/process-list/models/process-instance.model.ts) | | (**required**) Full details of the process instance to display information about. | ## Details diff --git a/docs/process-services/components/process-instance-tasks.component.md b/docs/process-services/components/process-instance-tasks.component.md index 80b30122f3..b2c2fba086 100644 --- a/docs/process-services/components/process-instance-tasks.component.md +++ b/docs/process-services/components/process-instance-tasks.component.md @@ -22,14 +22,14 @@ Lists both the active and completed tasks associated with a particular process i ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| processInstanceDetails | [`ProcessInstance`](../../../lib/process-services/src/lib/process-list/models/process-instance.model.ts) | | (**required**) The ID of the process instance to display tasks for. | -| showRefreshButton | `boolean` | true | Toggles whether to show a refresh button next to the list of tasks to allow it to be updated from the server. | +| Name | Type | Default value | Description | +| ---------------------- | -------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------- | +| processInstanceDetails | [`ProcessInstance`](../../../lib/process-services/src/lib/process-list/models/process-instance.model.ts) | | (**required**) The ID of the process instance to display tasks for. | +| showRefreshButton | `boolean` | true | Toggles whether to show a refresh button next to the list of tasks to allow it to be updated from the server. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| Name | Type | Description | +| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | | taskClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskDetailsEvent`](../../../lib/process-services/src/lib/task-list/models/task-details.event.ts)`>` | Emitted when a task is clicked. | diff --git a/docs/process-services/components/process-list.component.md b/docs/process-services/components/process-list.component.md index eeb82c6e7b..7d94f26756 100644 --- a/docs/process-services/components/process-list.component.md +++ b/docs/process-services/components/process-list.component.md @@ -49,32 +49,32 @@ when the process list is empty: ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| appId | `number` | | The id of the app. | -| data | [`DataTableAdapter`](../../../lib/core/datatable/data/datatable-adapter.ts) | | Data source to define the datatable. | -| multiselect | `boolean` | false | Toggles multiple row selection, which renders checkboxes at the beginning of each row | -| page | `number` | 0 | The page number of the processes to fetch. | -| presetColumn | `string` | | Custom preset column schema in JSON format. | -| processDefinitionId | `string` | | The [Definition](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/definition.ts) Id of the process. | -| processInstanceId | `number \| string` | | The id of the process instance. | -| resolverFn | `Function` | null | Resolver function is used to show dynamic complex column objects see the docs to learn how to configure a resolverFn. | -| selectFirstRow | `boolean` | true | Toggles default selection of the first row | -| selectionMode | `string` | "single" | Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. | -| showContextMenu | `boolean` | false | Toggles custom context menu for the component. | -| size | `number` | | The number of processes to fetch in each page. | -| sort | `string` | | Defines the sort ordering of the list. Possible values are `created-desc`, `created-asc`, `ended-desc`, `ended-asc`. | -| state | `string` | | Defines the state of the processes. Possible values are `running`, `completed` and `all` | -| stickyHeader | `boolean` | false | Toggles the sticky header mode. | +| Name | Type | Default value | Description | +| ------------------- | --------------------------------------------------------------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| appId | `number` | | The id of the app. | +| data | [`DataTableAdapter`](../../../lib/core/datatable/data/datatable-adapter.ts) | | Data source to define the datatable. | +| multiselect | `boolean` | false | Toggles multiple row selection, which renders checkboxes at the beginning of each row | +| page | `number` | 0 | The page number of the processes to fetch. | +| presetColumn | `string` | | Custom preset column schema in JSON format. | +| processDefinitionId | `string` | | The [Definition](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/definition.ts) Id of the process. | +| processInstanceId | `number \| string` | | The id of the process instance. | +| resolverFn | `Function` | null | Resolver function is used to show dynamic complex column objects see the docs to learn how to configure a resolverFn. | +| selectFirstRow | `boolean` | true | Toggles default selection of the first row | +| selectionMode | `string` | "single" | Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. | +| showContextMenu | `boolean` | false | Toggles custom context menu for the component. | +| size | `number` | | The number of processes to fetch in each page. | +| sort | `string` | | Defines the sort ordering of the list. Possible values are `created-desc`, `created-asc`, `ended-desc`, `ended-asc`. | +| state | `string` | | Defines the state of the processes. Possible values are `running`, `completed` and `all` | +| stickyHeader | `boolean` | false | Toggles the sticky header mode. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs while loading the list of process instances from the server. | -| rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a row in the process list is clicked. | -| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessListModel`](../../../lib/process-services/src/lib/process-list/models/process-list.model.ts)`>` | Emitted when the list of process instances has been loaded successfully from the server. | +| Name | Type | Description | +| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs while loading the list of process instances from the server. | +| rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a row in the process list is clicked. | +| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessListModel`](../../../lib/process-services/src/lib/process-list/models/process-list.model.ts)`>` | Emitted when the list of process instances has been loaded successfully from the server. | ## Details diff --git a/docs/process-services/components/start-process.component.md b/docs/process-services/components/start-process.component.md index 194ce4ab87..7a4464dfb6 100644 --- a/docs/process-services/components/start-process.component.md +++ b/docs/process-services/components/start-process.component.md @@ -38,27 +38,27 @@ Starts a process. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| appId | `number` | | (optional) Limit the list of processes that can be started to those contained in the specified app. | -| name | `string` | "" | (optional) Name to assign to the current process. | -| processDefinitionName | `string` | | (optional) [Definition](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/definition.ts) name of the process to start. | -| processFilterSelector | `boolean` | true | (optional) Parameter to enable selection of process when filtering. | -| showSelectApplicationDropdown | `boolean` | false | (optional) Hide or show application selection dropdown. | -| showSelectProcessDropdown | `boolean` | true | Hide or show the process selection dropdown. | -| title | `string` | | (optional) Define the header of the component. | -| values | [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.ts) | | Parameter to pass form field values in the start form if one is associated. | -| variables | [`ProcessInstanceVariable`](../../../lib/process-services/src/lib/process-list/models/process-instance-variable.model.ts)`[]` | | Variables in the input to the process [`RestVariable`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/RestVariable.md). | +| Name | Type | Default value | Description | +| ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| appId | `number` | | (optional) Limit the list of processes that can be started to those contained in the specified app. | +| name | `string` | "" | (optional) Name to assign to the current process. | +| processDefinitionName | `string` | | (optional) [Definition](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/definition.ts) name of the process to start. | +| processFilterSelector | `boolean` | true | (optional) Parameter to enable selection of process when filtering. | +| showSelectApplicationDropdown | `boolean` | false | (optional) Hide or show application selection dropdown. | +| showSelectProcessDropdown | `boolean` | true | Hide or show the process selection dropdown. | +| title | `string` | | (optional) Define the header of the component. | +| values | [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.ts) | | Parameter to pass form field values in the start form if one is associated. | +| variables | [`ProcessInstanceVariable`](../../../lib/process-services/src/lib/process-list/models/process-instance-variable.model.ts)`[]` | | Variables in the input to the process [`RestVariable`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/RestVariable.md). | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| applicationSelection | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`AppDefinitionRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`>` | Emitted when application selection changes. | -| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the process is canceled. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| Name | Type | Description | +| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | +| applicationSelection | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`AppDefinitionRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`>` | Emitted when application selection changes. | +| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the process is canceled. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | | processDefinitionSelection | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/ProcessDefinitionRepresentation.md)`>` | Emitted when process definition selection changes. | -| start | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstance`](../../../lib/process-services/src/lib/process-list/models/process-instance.model.ts)`>` | Emitted when the process starts. | +| start | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstance`](../../../lib/process-services/src/lib/process-list/models/process-instance.model.ts)`>` | Emitted when the process starts. | ## Details diff --git a/docs/process-services/components/start-task.component.md b/docs/process-services/components/start-task.component.md index faad37c266..70669d4698 100644 --- a/docs/process-services/components/start-task.component.md +++ b/docs/process-services/components/start-task.component.md @@ -24,15 +24,15 @@ Creates/Starts a new task for the specified app. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| appId | `number` | | (required) The id of the app. | -| name | `string` | "" | Default Task Name. | +| Name | Type | Default value | Description | +| ----- | -------- | ------------- | ----------------------------- | +| appId | `number` | | (required) The id of the app. | +| name | `string` | "" | Default Task Name. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the cancel button is clicked by the user. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is successfully created. | +| Name | Type | Description | +| ------- | ------------------------------------------------------------------ | ------------------------------------------------------ | +| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the cancel button is clicked by the user. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is successfully created. | diff --git a/docs/process-services/components/task-attachment-list.component.md b/docs/process-services/components/task-attachment-list.component.md index ca05b42ebb..08471c6846 100644 --- a/docs/process-services/components/task-attachment-list.component.md +++ b/docs/process-services/components/task-attachment-list.component.md @@ -52,18 +52,18 @@ A default "no content" template is displayed if you don't supply one to override ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| disabled | `boolean` | false | Disable/Enable read only mode for attachment list. | -| taskId | `string` | | (**required**) The ID of the task to display. | +| Name | Type | Default value | Description | +| -------- | --------- | ------------- | -------------------------------------------------- | +| disabled | `boolean` | false | Disable/Enable read only mode for attachment list. | +| taskId | `string` | | (**required**) The ID of the task to display. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| --------------- | ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | attachmentClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the attachment is double-clicked or a view option is selected from the context menu by the user from within the component. Returns a [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) representing the clicked object. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs while fetching the attachments. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs while fetching the attachments. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. | ## Details diff --git a/docs/process-services/components/task-details.component.md b/docs/process-services/components/task-details.component.md index 81ba9d5134..f7d58911a6 100644 --- a/docs/process-services/components/task-details.component.md +++ b/docs/process-services/components/task-details.component.md @@ -21,38 +21,38 @@ Shows the details of the task ID passed in as input. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| debugMode | `boolean` | false | Toggles debug mode. | -| fieldValidators | [`FormFieldValidator`](../../../lib/core/form/components/widgets/core/form-field-validator.ts)`[]` | \[] | Field validators for use with the form. | -| readOnlyForm | `boolean` | false | Toggles read-only state of the form. All form widgets render as read-only if enabled. | -| showChecklist | `boolean` | true | Toggles `Checklist` feature for the Header component. | -| showComments | `boolean` | true | Toggles `Comments` feature for the Header component. | -| showFormCompleteButton | `boolean` | true | Toggles rendering of the `Complete` outcome button. | -| showFormRefreshButton | `boolean` | true | Toggles rendering of the `Refresh` button. | -| showFormSaveButton | `boolean` | true | Toggles rendering of the `Save` outcome button. | -| showFormTitle | `boolean` | false | Toggles rendering of the form title. | -| showHeader | `boolean` | true | Toggles task details Header component. | -| showHeaderContent | `boolean` | true | Toggles collapsed/expanded state of the Header component. | -| showInvolvePeople | `boolean` | true | Toggles `Involve People` feature for the Header component. | -| showNextTask | `boolean` | true | Automatically renders the next task when the current one is completed. | -| taskId | `string` | | (**required**) The id of the task whose details we are asking for. | +| Name | Type | Default value | Description | +| ---------------------- | -------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------- | +| debugMode | `boolean` | false | Toggles debug mode. | +| fieldValidators | [`FormFieldValidator`](../../../lib/core/form/components/widgets/core/form-field-validator.ts)`[]` | \[] | Field validators for use with the form. | +| readOnlyForm | `boolean` | false | Toggles read-only state of the form. All form widgets render as read-only if enabled. | +| showChecklist | `boolean` | true | Toggles `Checklist` feature for the Header component. | +| showComments | `boolean` | true | Toggles `Comments` feature for the Header component. | +| showFormCompleteButton | `boolean` | true | Toggles rendering of the `Complete` outcome button. | +| showFormRefreshButton | `boolean` | true | Toggles rendering of the `Refresh` button. | +| showFormSaveButton | `boolean` | true | Toggles rendering of the `Save` outcome button. | +| showFormTitle | `boolean` | false | Toggles rendering of the form title. | +| showHeader | `boolean` | true | Toggles task details Header component. | +| showHeaderContent | `boolean` | true | Toggles collapsed/expanded state of the Header component. | +| showInvolvePeople | `boolean` | true | Toggles `Involve People` feature for the Header component. | +| showNextTask | `boolean` | true | Automatically renders the next task when the current one is completed. | +| taskId | `string` | | (**required**) The id of the task whose details we are asking for. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| assignTask | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a task is assigned. | -| claimedTask | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a task is claimed. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. | -| formCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. | -| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when the form field content is clicked. | -| formLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is loaded or reloaded. | -| formSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Save` or custom outcomes. | -| taskCreated | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>` | Emitted when a checklist task is created. | -| taskDeleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a checklist task is deleted. | -| unClaimedTask | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a task is unclaimed. | +| Name | Type | Description | +| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | +| assignTask | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a task is assigned. | +| claimedTask | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a task is claimed. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. | +| formCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. | +| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when the form field content is clicked. | +| formLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is loaded or reloaded. | +| formSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Save` or custom outcomes. | +| taskCreated | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>` | Emitted when a checklist task is created. | +| taskDeleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a checklist task is deleted. | +| unClaimedTask | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a task is unclaimed. | ## Details diff --git a/docs/process-services/components/task-filters.component.md b/docs/process-services/components/task-filters.component.md index cbd04e7998..e17801e302 100644 --- a/docs/process-services/components/task-filters.component.md +++ b/docs/process-services/components/task-filters.component.md @@ -19,20 +19,20 @@ Shows all available filters. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| appId | `number` | | Display filters available to the current user for the application with the specified ID. | -| appName | `string` | | Display filters available to the current user for the application with the specified name. | -| filterParam | [`FilterParamsModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) | | Parameters to use for the task filter. If there is no match then the default filter (the first one the list) is selected. | -| showIcon | `boolean` | | Toggles display of the filter's icon. | +| Name | Type | Default value | Description | +| ----------- | --------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------- | +| appId | `number` | | Display filters available to the current user for the application with the specified ID. | +| appName | `string` | | Display filters available to the current user for the application with the specified name. | +| filterParam | [`FilterParamsModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) | | Parameters to use for the task filter. If there is no match then the default filter (the first one the list) is selected. | +| showIcon | `boolean` | | Toggles display of the filter's icon. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs during loading. | +| Name | Type | Description | +| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs during loading. | | filterClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`>` | Emitted when a filter in the list is clicked. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the list is loaded. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the list is loaded. | ## Details @@ -49,8 +49,8 @@ Use the `filterParam` property to restrict the range of filters that are shown: You can use properties from [`FilterParamsModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) as the value of `filterParam` as shown in the table below: -| Name | Type | Description | -| ---- | ---- | ----------- | -| id | string | The id of the task filter | -| name | string | The name of the task filter, lowercase is checked | +| Name | Type | Description | +| ----- | ------ | --------------------------------------------------- | +| id | string | The id of the task filter | +| name | string | The name of the task filter, lowercase is checked | | index | string | The zero-based position of the filter in the array. | diff --git a/docs/process-services/components/task-form.component.md b/docs/process-services/components/task-form.component.md index d31d210580..04aa47a1f1 100644 --- a/docs/process-services/components/task-form.component.md +++ b/docs/process-services/components/task-form.component.md @@ -21,34 +21,34 @@ Shows a [`form`](../../../lib/process-services/src/lib/task-list/models/form.mod ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| fieldValidators | [`FormFieldValidator`](../../../lib/core/form/components/widgets/core/form-field-validator.ts)`[]` | \[] | Field validators for use with the form. | -| readOnlyForm | `boolean` | false | Toggles read-only state of the form. All form widgets render as read-only if enabled. | -| showCancelButton | `boolean` | true | Toggle rendering of the `Cancel` button. | -| showFormCompleteButton | `boolean` | true | Toggles rendering of the `Complete` outcome button. | -| showFormRefreshButton | `boolean` | true | Toggles rendering of the `Refresh` button. | -| showFormSaveButton | `boolean` | true | Toggles rendering of the `Save` outcome button. | -| showFormTitle | `boolean` | false | Toggles rendering of the form title. | -| showFormValidationIcon | `boolean` | true | Toggle rendering of the validation icon next to the form title. | -| taskId | `string` | | (**required**) The id of the task whose details we are asking for. | +| Name | Type | Default value | Description | +| ---------------------- | -------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------- | +| fieldValidators | [`FormFieldValidator`](../../../lib/core/form/components/widgets/core/form-field-validator.ts)`[]` | \[] | Field validators for use with the form. | +| readOnlyForm | `boolean` | false | Toggles read-only state of the form. All form widgets render as read-only if enabled. | +| showCancelButton | `boolean` | true | Toggle rendering of the `Cancel` button. | +| showFormCompleteButton | `boolean` | true | Toggles rendering of the `Complete` outcome button. | +| showFormRefreshButton | `boolean` | true | Toggles rendering of the `Refresh` button. | +| showFormSaveButton | `boolean` | true | Toggles rendering of the `Save` outcome button. | +| showFormTitle | `boolean` | false | Toggles rendering of the form title. | +| showFormValidationIcon | `boolean` | true | Toggle rendering of the validation icon next to the form title. | +| taskId | `string` | | (**required**) The id of the task whose details we are asking for. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "Cancel" button is clicked. | -| completed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the form associated with the task is completed. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. | -| formCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. | -| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when the form field content is clicked. | -| formError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormFieldModel`](../../core/models/form-field.model.md)`[]>` | Emitted when the supplied form values have a validation error. | -| formLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is loaded or reloaded. | -| formSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Save` or custom outcomes. | -| showAttachForm | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the form associated with the form task is attached. | -| taskClaimed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is claimed. | -| taskUnclaimed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is unclaimed (ie, requeued).. | +| Name | Type | Description | +| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | +| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "Cancel" button is clicked. | +| completed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the form associated with the task is completed. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. | +| formCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. | +| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when the form field content is clicked. | +| formError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormFieldModel`](../../core/models/form-field.model.md)`[]>` | Emitted when the supplied form values have a validation error. | +| formLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is loaded or reloaded. | +| formSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Save` or custom outcomes. | +| showAttachForm | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the form associated with the form task is attached. | +| taskClaimed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is claimed. | +| taskUnclaimed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is unclaimed (ie, requeued).. | ## See also diff --git a/docs/process-services/components/task-header.component.md b/docs/process-services/components/task-header.component.md index 8a1a391843..16ed1e741c 100644 --- a/docs/process-services/components/task-header.component.md +++ b/docs/process-services/components/task-header.component.md @@ -23,17 +23,17 @@ Shows all the information related to a task. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| formName | `string` | null | The name of the form. | -| showClaimRelease | `boolean` | true | Toggles display of the claim/release button. | -| taskDetails | [`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts) | | (required) Details related to the task. | +| Name | Type | Default value | Description | +| ---------------- | -------------------------------------------------------------------------------------------------- | ------------- | -------------------------------------------- | +| formName | `string` | null | The name of the form. | +| showClaimRelease | `boolean` | true | Toggles display of the claim/release button. | +| taskDetails | [`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts) | | (required) Details related to the task. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| claim | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is claimed. | +| Name | Type | Description | +| ------- | ----------------------------------------------------------------- | -------------------------------------------------- | +| claim | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is claimed. | | unclaim | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is unclaimed (ie, requeued). | ## Details diff --git a/docs/process-services/components/task-list.component.md b/docs/process-services/components/task-list.component.md index c258297e7a..b327767c2b 100644 --- a/docs/process-services/components/task-list.component.md +++ b/docs/process-services/components/task-list.component.md @@ -51,40 +51,40 @@ when the task list is empty: ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| appId | `number` | | The id of the app. | -| assignment | `string` | | The assignment of the process. Possible values are: "assignee" (the current user is the assignee), "candidate" (the current user is a task candidate, "group_x" (the task is assigned to a group where the current user is a member, no value (the current user is involved). | -| data | [`DataTableAdapter`](../../../lib/core/datatable/data/datatable-adapter.ts) | | Data source object that represents the number and the type of the columns that you want to show. | -| dueAfter | `string` | | Filter the tasks. Display only tasks with `created_date` after `dueAfter`. | -| dueBefore | `string` | | Filter the tasks. Display only tasks with `created_date` before `dueBefore`. | -| includeProcessInstance | `boolean` | | Toggles inclusion of Process Instances | -| landingTaskId | `string` | | Define which task id should be selected after reloading. If the task id doesn't exist or nothing is passed then the first task will be selected. | -| multiselect | `boolean` | false | Toggles multiple row selection, renders checkboxes at the beginning of each row | -| name | `string` | | Name of the tasklist. | -| page | `number` | 0 | The page number of the tasks to fetch. | -| presetColumn | `string` | | Custom preset column schema in JSON format. | -| processDefinitionId | `string` | | The [Definition](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/definition.ts) Id of the process. | -| processInstanceId | `string` | | The Instance Id of the process. | -| selectFirstRow | `boolean` | true | Toggles default selection of the first row | -| selectionMode | `string` | "single" | Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. | -| showContextMenu | `boolean` | false | Toggles custom context menu for the component. | -| size | `number` | | The number of tasks to fetch. Default value: 25. | -| sort | `string` | | Define the sort order of the tasks. Possible values are : `created-desc`, `created-asc`, `due-desc`, `due-asc` | -| start | `number` | | Starting point of the list within the full set of tasks. | -| state | `string` | | Current state of the process. Possible values are: `completed`, `active`. | -| stickyHeader | `boolean` | false | Toggles the sticky header mode. | -| taskId | `string` | | The id of a task | +| Name | Type | Default value | Description | +| ---------------------- | --------------------------------------------------------------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| appId | `number` | | The id of the app. | +| assignment | `string` | | The assignment of the process. Possible values are: "assignee" (the current user is the assignee), "candidate" (the current user is a task candidate, "group_x" (the task is assigned to a group where the current user is a member, no value (the current user is involved). | +| data | [`DataTableAdapter`](../../../lib/core/datatable/data/datatable-adapter.ts) | | Data source object that represents the number and the type of the columns that you want to show. | +| dueAfter | `string` | | Filter the tasks. Display only tasks with `created_date` after `dueAfter`. | +| dueBefore | `string` | | Filter the tasks. Display only tasks with `created_date` before `dueBefore`. | +| includeProcessInstance | `boolean` | | Toggles inclusion of Process Instances | +| landingTaskId | `string` | | Define which task id should be selected after reloading. If the task id doesn't exist or nothing is passed then the first task will be selected. | +| multiselect | `boolean` | false | Toggles multiple row selection, renders checkboxes at the beginning of each row | +| name | `string` | | Name of the tasklist. | +| page | `number` | 0 | The page number of the tasks to fetch. | +| presetColumn | `string` | | Custom preset column schema in JSON format. | +| processDefinitionId | `string` | | The [Definition](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/definition.ts) Id of the process. | +| processInstanceId | `string` | | The Instance Id of the process. | +| selectFirstRow | `boolean` | true | Toggles default selection of the first row | +| selectionMode | `string` | "single" | Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. | +| showContextMenu | `boolean` | false | Toggles custom context menu for the component. | +| size | `number` | | The number of tasks to fetch. Default value: 25. | +| sort | `string` | | Define the sort order of the tasks. Possible values are : `created-desc`, `created-asc`, `due-desc`, `due-asc` | +| start | `number` | | Starting point of the list within the full set of tasks. | +| state | `string` | | Current state of the process. Possible values are: `completed`, `active`. | +| stickyHeader | `boolean` | false | Toggles the sticky header mode. | +| taskId | `string` | | The id of a task | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a task in the list is clicked | -| rowsSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when rows are selected/unselected | +| Name | Type | Description | +| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a task in the list is clicked | +| rowsSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when rows are selected/unselected | | showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task list is loaded | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task list is loaded | ## Details diff --git a/docs/process-services/components/task-standalone.component.md b/docs/process-services/components/task-standalone.component.md index 1e120792a5..28aa867807 100644 --- a/docs/process-services/components/task-standalone.component.md +++ b/docs/process-services/components/task-standalone.component.md @@ -21,18 +21,18 @@ This component can be used when the task doesn't belong to any processes. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| hasCompletePermission | `boolean` | true | Toggles rendering of the `Complete` button. | -| hideCancelButton | `boolean` | true | Toggles rendering of the `Cancel` button. | -| isCompleted | `boolean` | false | If true then Task completed message is shown and `Complete` and `Cancel` buttons are hidden. | -| taskId | `any` | | Id of the task. | -| taskName | `any` | | Name of the task. | +| Name | Type | Default value | Description | +| --------------------- | --------- | ------------- | -------------------------------------------------------------------------------------------- | +| hasCompletePermission | `boolean` | true | Toggles rendering of the `Complete` button. | +| hideCancelButton | `boolean` | true | Toggles rendering of the `Cancel` button. | +| isCompleted | `boolean` | false | If true then Task completed message is shown and `Complete` and `Cancel` buttons are hidden. | +| taskId | `any` | | Id of the task. | +| taskName | `any` | | Name of the task. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "Cancel" button is clicked. | -| complete | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the form associated with the task is completed. | +| Name | Type | Description | +| -------------- | ------------------------------------------------------------------ | ---------------------------------------------------------------- | +| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "Cancel" button is clicked. | +| complete | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the form associated with the task is completed. | | showAttachForm | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the form associated with the form task is attached. | diff --git a/docs/process-services/directives/claim-task.directive.md b/docs/process-services/directives/claim-task.directive.md index c10e378d6d..2fa071766e 100644 --- a/docs/process-services/directives/claim-task.directive.md +++ b/docs/process-services/directives/claim-task.directive.md @@ -19,13 +19,13 @@ Claims a task ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| taskId | `string` | | (Required) The id of the task. | +| Name | Type | Default value | Description | +| ------ | -------- | ------------- | ------------------------------ | +| taskId | `string` | | (Required) The id of the task. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task cannot be claimed. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is claimed. | +| Name | Type | Description | +| ------- | ----------------------------------------------------------------- | ---------------------------------------- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task cannot be claimed. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is claimed. | diff --git a/docs/process-services/directives/process-audit.directive.md b/docs/process-services/directives/process-audit.directive.md index c22115efec..06247fb1fc 100644 --- a/docs/process-services/directives/process-audit.directive.md +++ b/docs/process-services/directives/process-audit.directive.md @@ -28,16 +28,16 @@ Fetches the Process Audit information in PDF or JSON format. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| download | `boolean` | true | Enables downloading of the audit file on clicking. | -| fileName | `string` | "Audit" | Name of the file to download (for PDF downloads). | -| format | `string` | "pdf" | Format for the audit information (can be "pdf" or "json"). | -| processId | `string` | | ID of the process. | +| Name | Type | Default value | Description | +| --------- | --------- | ------------- | ---------------------------------------------------------- | +| download | `boolean` | true | Enables downloading of the audit file on clicking. | +| fileName | `string` | "Audit" | Name of the file to download (for PDF downloads). | +| format | `string` | "pdf" | Format for the audit information (can be "pdf" or "json"). | +| processId | `string` | | ID of the process. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| ------- | ----------------------------------------------------------------- | ---------------------------------------------- | | clicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the decorated element is clicked. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | diff --git a/docs/process-services/directives/task-audit.directive.md b/docs/process-services/directives/task-audit.directive.md index 0bca1eedac..86e0683d12 100644 --- a/docs/process-services/directives/task-audit.directive.md +++ b/docs/process-services/directives/task-audit.directive.md @@ -27,16 +27,16 @@ Fetches the Task Audit information in PDF or JSON format. ### Properties -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| download | `boolean` | true | Enables downloading of the audit when the decorated element is clicked. | -| fileName | `string` | "Audit" | Name of the downloaded file (for PDF downloads). | -| format | `string` | "pdf" | Format of the audit information. Can be "pdf" or "json". | -| taskId | `string` | | (**required**) The id of the task. | +| Name | Type | Default value | Description | +| -------- | --------- | ------------- | ----------------------------------------------------------------------- | +| download | `boolean` | true | Enables downloading of the audit when the decorated element is clicked. | +| fileName | `string` | "Audit" | Name of the downloaded file (for PDF downloads). | +| format | `string` | "pdf" | Format of the audit information. Can be "pdf" or "json". | +| taskId | `string` | | (**required**) The id of the task. | ### Events -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| ------- | ----------------------------------------------------------------- | ---------------------------------------------- | | clicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the decorated element is clicked. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | diff --git a/docs/tutorials/README.md b/docs/tutorials/README.md index ca229421ac..466eabf8c6 100644 --- a/docs/tutorials/README.md +++ b/docs/tutorials/README.md @@ -11,9 +11,8 @@ Github only: true | [**Creating your Alfresco JavaScript application**](creating-javascript-app-using-alfresco-js-api.md) | Basic | In this tutorial you will learn how to create an application in JavaScript from scratch to interact with Alfresco. | | [**Adding a new component**](new-component.md) | Basic | In this tutorial, you will learn how to create a component using [Angular CLI](https://cli.angular.io/) within an existing application. | | [**Adding a new view**](new-view.md) | Beginner | In this tutorial you will learn how to create a new view in your application and how to access it using a defined endpoint. | -| [**Using ADF Components**](using-components.md) | Basic | In this tutorial you will learn how to extend, use and configure ADF Components. | +| [**Using ADF Components**](using-components.md) | Basic | In this tutorial, you will learn how to extend, use, and configure ADF Components. | | [**Basic theming**](basic-theming.md) | Beginner | In this tutorial you will see how to theme an ADF app by modifying the CSS. | -| [**Customizing the Login component**](customising-login.md) | Intermediate | In this tutorial you will learn how to customize the [Login component](../core/components/login.component.md) following the technical documentation. | | [**Working with a Data Table**](working-with-data-table.md) | Intermediate | In this tutorial you will learn how to populate a DataTable component. | | [**Working with the Nodes API Service**](working-with-nodes-api-service.md) | Intermediate | In this tutorial you will learn how to use the [`NodesApiService`](../core/services/nodes-api.service.md). | | [**Working with Nodes using the JS API**](working-with-nodes-js-api.md) | Intermediate | In this tutorial you will learn how to use the [`AlfrescoCoreRestApi`](https://github.com/Alfresco/alfresco-js-api/tree/master/src/alfresco-core-rest-api). | diff --git a/docs/upgrade-guide/upgrade26-30.md b/docs/upgrade-guide/upgrade26-30.md index 76e0392a34..b70ecc6097 100644 --- a/docs/upgrade-guide/upgrade26-30.md +++ b/docs/upgrade-guide/upgrade26-30.md @@ -209,9 +209,11 @@ update your code to use the suggested fix for each item that affects your projec component. See the [`mat-expansion-panel`](https://material.angular.io/components/expansion/overview) doc page for an example of how to do this. + - [Viewer component](../core/components/viewer.component.md): The `allowShare` input has been removed. Inject the [Share Directive](../content-services/directives/content-node-share.directive.md) in a [custom toolbar](../core/components/viewer.component.md#custom-toolbar) to recreate the behavior of the Share button. + - [Viewer component](../core/components/viewer.component.md): The handling of the sidebar has been updated to allow left and right sidebars at the same time. The following properties have changed, so you should update your code to use the new properties: @@ -224,14 +226,18 @@ update your code to use the suggested fix for each item that affects your projec - The `createFolder` event of the [`UploadBase`](../../lib/content-services/src/lib/upload/components/base-upload/upload-base.ts) class (emitted when a folder was created) has been removed. You should modify your code to use the `success` event instead. + - [Login component](../core/components/login.component.md): Two inputs have been removed: `disableCsrf` and `providers`. Set the properties with the same names in `app.config.json` to get the same effect. + - [File Draggable Directive](../content-services/directives/file-draggable.directive.md): The `file-draggable` event has been removed. Use `filesDropped` instead to get the same effect. + - [Search control component](../content-services/components/search-control.component.md): The `QueryBody`, and `customQueryBody` inputs of the [`SearchControlComponent`](../content-services/components/search-control.component.md) have been removed. See the [Search configuration interface](../core/interfaces/search-configuration.interface.md) page to learn how to get the same functionality. + - [Document list component](../content-services/components/document-list.component.md): Several inputs have been removed or replaced: - The `skipCount` input has been removed. You can define @@ -244,6 +250,7 @@ update your code to use the suggested fix for each item that affects your projec - The `SettingsService` class has been removed. Access the equivalent properties with the [App config service](../core/services/app-config.service.md) + - [Form service](../core/services/form.service.md): the `addFieldsToAForm` method has been removed. ## Relocated classes diff --git a/docs/upgrade-guide/upgrade39-40.md b/docs/upgrade-guide/upgrade39-40.md index 022efe175b..a91b4d13b7 100644 --- a/docs/upgrade-guide/upgrade39-40.md +++ b/docs/upgrade-guide/upgrade39-40.md @@ -40,7 +40,7 @@ Replace `/deep/` with `::ng-deep` in your styles, read more about angular compon Angular now uses TypeScript 3.4, read more about errors that might arise from improved type checking. -Make sure you are using Node 10 or later. +Make sure you are using [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) 10 or later. The CLI's build command now automatically creates a modern ES2015 build with minimal polyfills and a compatible ES5 build for older browsers, and loads the appropriate file based on the browser. You may opt-out of this change by setting your target back to es5 in your tsconfig.json. Learn more on angular.io. @@ -50,7 +50,7 @@ If you use ViewChild or ContentChild, we're updating the way we resolve these qu For lazy loaded modules via the router, make sure you are using dynamic imports. Importing via string is removed in v9. ng update should take care of this automatically. Learn more on angular.io. -Make sure you are using Node 10.13 or later. +Make sure you are using [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) 10.13 or later. Run `ng update @angular/core@8 @angular/cli@8` in your workspace directory to update to the latest 8.x version of @angular/core and @angular/cli and commit these changes. diff --git a/docs/user-guide/summary.json b/docs/user-guide/summary.json index d97338d835..cd545b4281 100644 --- a/docs/user-guide/summary.json +++ b/docs/user-guide/summary.json @@ -15,7 +15,6 @@ { "title": "Adding a new view", "file": "new-view.md"}, { "title": "Using components", "file": "using-components.md"}, { "title": "Basic theming", "file": "basic-theming.md"}, - { "title": "Customising the Login component", "file": "customising-login.md"}, { "title": "Working with a DataTable", "file": "working-with-data-table.md"}, { "title": "Working with the Nodes API Service", "file": "working-with-nodes-api-service.md"}, { "title": "Working with the Nodes using the JS API", "file": "working-with-nodes-js-api.md"}, diff --git a/docs/versionIndex.md b/docs/versionIndex.md index 70477dd856..1846744d05 100644 --- a/docs/versionIndex.md +++ b/docs/versionIndex.md @@ -35,9 +35,9 @@ backend services have been tested with each released version of ADF. ## v4.1.0 - + - + ## v4.0.0 @@ -49,12 +49,12 @@ backend services have been tested with each released version of ADF. +- [Audit service](content-services/services/audit.service.md) - [Claim task cloud directive](process-services-cloud/directives/claim-task-cloud.directive.md) - [Claim task directive](process-services/directives/claim-task.directive.md) - [Form custom outcome component](process-services/components/form-custom-outcome.component.md) - [Process name cloud pipe](process-services-cloud/pipes/process-name-cloud.pipe.md) - [Process name pipe](process-services/pipes/process-name.pipe.md) -- [Search header component](content-services/components/search-header.component.md) - [Unclaim task cloud directive](process-services-cloud/directives/unclaim-task-cloud.directive.md) - [Unclaim task directive](process-services/directives/unclaim-task.directive.md) - [Version comparison component](content-services/components/version-comparison.component.md) diff --git a/docs/vulnerability/README.md b/docs/vulnerability/README.md index 44a760fd01..a52dec69bc 100644 --- a/docs/vulnerability/README.md +++ b/docs/vulnerability/README.md @@ -7,6 +7,7 @@ Github only: true The pages linked below contain the audit for all third party dependencies of ADF. +- [ADF v4.1.0](audit-info-4.1.0.md) - [ADF v4.0.0](audit-info-4.0.0.md) - [ADF v3.9.0](audit-info-3.9.0.md) - [ADF v3.8.0](audit-info-3.8.0.md) diff --git a/docs/vulnerability/audit-info-4.1.0.md b/docs/vulnerability/audit-info-4.1.0.md new file mode 100644 index 0000000000..e0dd1e7581 --- /dev/null +++ b/docs/vulnerability/audit-info-4.1.0.md @@ -0,0 +1,25 @@ +--- +Title: Audit info, alfresco-ng2-components 4.1.0 +--- + +# Audit information for alfresco-ng2-components 4.1.0 + +This page lists the security audit of the dependencies this project depends on. + +## Risks + +- Critical risk: 0 +- High risk: 0 +- Moderate risk: 0 +- Low risk: 9 + +Dependencies analyzed: 3036 + +## Libraries + +| Severity | Module | Vulnerable versions | +| --- | --- | --- | +|low | minimist | "<0.2.1 || >=1.0.0 <1.2.3" | +|low | yargs-parser | "<13.1.2 || >=14.0.0 <15.0.1 || >=16.0.0 <18.1.2" | +|low | node-fetch | "< 2.6.1 || >= 3.0.0-beta.1 < 3.0.0-beta.9" | + diff --git a/e2e/protractor.conf.js b/e2e/protractor.conf.js index 065313508c..28d368e285 100644 --- a/e2e/protractor.conf.js +++ b/e2e/protractor.conf.js @@ -188,9 +188,6 @@ exports.config = { htmlOnExpect: 'none', htmlOnSpec: 'none', clearFoldersBeforeTest: false - }, { - package: 'protractor-console', - logLevels: ['debug'] }], onCleanUp(results) { diff --git a/lib/process-services/src/lib/form/form.component.ts b/lib/process-services/src/lib/form/form.component.ts index 2176c5a07a..63bb7b2ba9 100644 --- a/lib/process-services/src/lib/form/form.component.ts +++ b/lib/process-services/src/lib/form/form.component.ts @@ -58,7 +58,8 @@ export class FormComponent extends FormBaseComponent implements OnInit, OnDestro @Input() data: FormValues; - @Input() + /** The form will set a prefixed space for invisible fields. */ + @Input() enableFixedSpacedForm: boolean = true; /** Emitted when the form is submitted with the `Save` or custom outcomes. */ diff --git a/package-lock.json b/package-lock.json index 3966abf5ca..d9d64f2f3b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -19799,64 +19799,6 @@ } } }, - "protractor-console": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/protractor-console/-/protractor-console-3.0.0.tgz", - "integrity": "sha512-2BTh751CMjEAMxuZXb86jvs0TDWjvCk7fCnKTyb5vX/KE5f+olTeVCmcFm+4Aretpc6q/6yryuSJ8wjgL9QTKw==", - "dev": true, - "requires": { - "chalk": "^1.1.0", - "lodash": "^3.10.0" - }, - "dependencies": { - "ansi-regex": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-2.1.1.tgz", - "integrity": "sha1-w7M6te42DYbg5ijwRorn7yfWVN8=", - "dev": true - }, - "ansi-styles": { - "version": "2.2.1", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-2.2.1.tgz", - "integrity": "sha1-tDLdM1i2NM914eRmQ2gkBTPB3b4=", - "dev": true - }, - "chalk": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-1.1.3.tgz", - "integrity": "sha1-qBFcVeSnAv5NFQq9OHKCKn4J/Jg=", - "dev": true, - "requires": { - "ansi-styles": "^2.2.1", - "escape-string-regexp": "^1.0.2", - "has-ansi": "^2.0.0", - "strip-ansi": "^3.0.0", - "supports-color": "^2.0.0" - } - }, - "lodash": { - "version": "3.10.1", - "resolved": "https://registry.npmjs.org/lodash/-/lodash-3.10.1.tgz", - "integrity": "sha1-W/Rejkm6QYnhfUgnid/RW9FAt7Y=", - "dev": true - }, - "strip-ansi": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-3.0.1.tgz", - "integrity": "sha1-ajhfuIU9lS1f8F0Oiq+UJ43GPc8=", - "dev": true, - "requires": { - "ansi-regex": "^2.0.0" - } - }, - "supports-color": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-2.0.0.tgz", - "integrity": "sha1-U10EXOa2Nj+kARcIRimZXp3zJMc=", - "dev": true - } - } - }, "protractor-retry": { "version": "1.2.13", "resolved": "https://registry.npmjs.org/protractor-retry/-/protractor-retry-1.2.13.tgz", diff --git a/package.json b/package.json index c0a3aa02dd..d1a642fda8 100644 --- a/package.json +++ b/package.json @@ -158,7 +158,6 @@ "ng-packagr": "^10.1.2", "optimize-css-assets-webpack-plugin": "^5.0.4", "protractor": "^7.0.0", - "protractor-console": "^3.0.0", "protractor-retry": "^1.2.9", "protractor-screenshoter-plugin": "0.10.3", "protractor-smartrunner": "^0.1.1",