diff --git a/docs/README.md b/docs/README.md index 7ee9c06a3d..68764339c6 100644 --- a/docs/README.md +++ b/docs/README.md @@ -44,11 +44,14 @@ for more information about installing and using the source code. - [Form field component](form-field.component.md) - [Form list component](form-list.component.md) - [Form component](form.component.md) +- [Start form component](start-form.component.md) +- [Text mask component](text-mask.component.md) - [Widget component](widget.component.md) - [Info drawer layout component](info-drawer-layout.component.md) - [Info drawer component](info-drawer.component.md) - [Language menu component](language-menu.component.md) - [Login component](login.component.md) +- [Infinite pagination component](infinite-pagination.component.md) - [Pagination component](pagination.component.md) - [Host settings component](host-settings.component.md) - [Toolbar divider component](toolbar-divider.component.md) @@ -56,14 +59,6 @@ for more information about installing and using the source code. - [Toolbar component](toolbar.component.md) - [User info component](user-info.component.md) - [Viewer component](viewer.component.md) -- [*Datatable cell component](../lib/core/datatable/components/datatable/datatable-cell.component.ts) -- [*Date cell component](../lib/core/datatable/components/datatable/date-cell.component.ts) -- [*Filesize cell component](../lib/core/datatable/components/datatable/filesize-cell.component.ts) -- [*Location cell component](../lib/core/datatable/components/datatable/location-cell.component.ts) -- [*Start form component](../lib/core/form/components/start-form.component.ts) -- [*Error component](../lib/core/form/components/widgets/error/error.component.ts) -- [*Text mask component](../lib/core/form/components/widgets/text/text-mask.component.ts) -- [*Infinite pagination component](../lib/core/pagination/infinite-pagination.component.ts) ### Directives @@ -75,8 +70,6 @@ for more information about installing and using the source code. - [Node permission directive](node-permission.directive.md) - [Node restore directive](node-restore.directive.md) - [Upload directive](upload.directive.md) -- [*No permission template directive](../lib/core/datatable/directives/no-permission-template.directive.ts) -- [*Form custom button directive](../lib/core/form/components/form-custom-button.directive.ts) ### Models @@ -136,10 +129,6 @@ for more information about installing and using the source code. - [Bpm user service](bpm-user.service.md) - [Ecm user service](ecm-user.service.md) - [*Activiti alfresco service](../lib/core/form/services/activiti-alfresco.service.ts) -- [*Widget visibility service](../lib/core/form/services/widget-visibility.service.ts) -- [*Card item types service](../lib/core/services/card-item-types.service.ts) -- [*Dynamic component mapper service](../lib/core/services/dynamic-component-mapper.service.ts) -- [*Settings service](../lib/core/services/settings.service.ts) ### Widgets @@ -181,6 +170,8 @@ for more information about installing and using the source code. - [Version list component](version-list.component.md) - [Version manager component](version-manager.component.md) - [Webscript component](webscript.component.md) +- [*Content metadata card component](../lib/content-services/content-metadata/content-metadata-card.component.ts) +- [*Content metadata component](../lib/content-services/content-metadata/content-metadata.component.ts) - [*Content node selector component](../lib/content-services/content-node-selector/content-node-selector.component.ts) - [*File uploading list row component](../lib/content-services/upload/components/file-uploading-list-row.component.ts) - [*File uploading list component](../lib/content-services/upload/components/file-uploading-list.component.ts) @@ -191,7 +182,6 @@ for more information about installing and using the source code. - [Folder create directive](folder-create.directive.md) - [Folder edit directive](folder-edit.directive.md) - [File draggable directive](file-draggable.directive.md) -- [*No permission content directive](../lib/content-services/document-list/components/no-permission/no-permission-content.directive.ts) - [*Search trigger directive](../lib/content-services/search/components/search-trigger.directive.ts) ### Models @@ -203,6 +193,7 @@ for more information about installing and using the source code. - [Document actions service](document-actions.service.md) - [Folder actions service](folder-actions.service.md) +- [*Content metadata service](../lib/content-services/content-metadata/content-metadata.service.ts) - [*Content node selector service](../lib/content-services/content-node-selector/content-node-selector.service.ts) - [*Document list service](../lib/content-services/document-list/services/document-list.service.ts) - [*Node actions service](../lib/content-services/document-list/services/node-actions.service.ts) @@ -230,6 +221,7 @@ for more information about installing and using the source code. - [Comment list component](comment-list.component.md) - [Comments component](comments.component.md) - [Process comments component](process-comments.component.md) +- [People list component](people-list.component.md) - [People search component](people-search.component.md) - [People component](people.component.md) - [Process filters component](process-filters.component.md) @@ -244,7 +236,6 @@ for more information about installing and using the source code. - [Task filters component](task-filters.component.md) - [Task header component](task-header.component.md) - [Task list component](task-list.component.md) -- [*People list component](../lib/process-services/people/people-list.component.ts) ### Directives diff --git a/docs/bpm-user.model.md b/docs/bpm-user.model.md index f629fc2d74..03de2832b7 100644 --- a/docs/bpm-user.model.md +++ b/docs/bpm-user.model.md @@ -7,7 +7,7 @@ Contains information about a Process Services user. Instances of this class are returned by the methods of the [Bpm User service](bpm-user.service.md). It implements the `UserRepresentation` interface, which is defined in the -[Alfresco JS API]h(ttps://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/UserRepresentation.md). +[Alfresco JS API](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/UserRepresentation.md). Note that the Typescript class for this model is in active development; it is likely to change and so its properties are not listed here. For the diff --git a/docs/docassets/images/InfPagination.png b/docs/docassets/images/InfPagination.png new file mode 100644 index 0000000000..100df9bb48 Binary files /dev/null and b/docs/docassets/images/InfPagination.png differ diff --git a/docs/docassets/images/ProcessStartForm.png b/docs/docassets/images/ProcessStartForm.png new file mode 100644 index 0000000000..920c3eac17 Binary files /dev/null and b/docs/docassets/images/ProcessStartForm.png differ diff --git a/docs/document-list.component.md b/docs/document-list.component.md index b03e2687d5..deb18edf28 100644 --- a/docs/document-list.component.md +++ b/docs/document-list.component.md @@ -761,6 +761,7 @@ That will give the following output: - [Datatable component](datatable.component.md) - [Data column component](data-column.component.md) - [Pagination component](pagination.component.md) +- [Infinite pagination component](infinite-pagination.component.md) - [Sites dropdown component](sites-dropdown.component.md) - [Metadata indicators](metadata-indicators.md) - [Document library model](document-library.model.md) diff --git a/docs/infinite-pagination.component.md b/docs/infinite-pagination.component.md new file mode 100644 index 0000000000..6a5f85954d --- /dev/null +++ b/docs/infinite-pagination.component.md @@ -0,0 +1,52 @@ +# Infinite Pagination component + +Adds "infinite" pagination to the component it is used with. + +![Infinite Pagination screenshot](docassets/images/InfPagination.png) + +## Basic Usage + +```html + + +``` + +### Properties + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| pagination | Pagination | `InfinitePaginationComponent.DEFAULT_PAGINATION` | Pagination object | +| pageSize | number | `InfinitePaginationComponent.DEFAULT_PAGE_SIZE` | Number of items that are added with each "load more" event | +| loading | boolean | false | | + +### Events + +| Name | Description | +| --- | --- | +| loadMore | Emitted when the "Load More" button is clicked | + +## Details + +Pagination is the process of dividing a list into separate ranges or "pages" with a +certain number of items each. This allows a long list to be delivered in manageable pieces +rather than all at once. "Infinite" pagination means that there is no upper limit on +the number of items that can be displayed visually; a single page is shown initially but +the user can extend the list one page at a time by clicking a "Load More" button. + +The `loadMore` event is emitted when the button is pressed. It is passed a +[Pagination](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/Pagination.md) +parameter which contains the details of the current page (the start offset of the +page within the list to be shown, whether there are more items left to show, etc). + +See the [Pagination component](pagination.component.md) for more information about the alternative "finite" pagination scheme. + + + +## See also + +- [Document list component](document-list.component.md) +- [Pagination component](pagination.component.md) + diff --git a/docs/seeAlsoGraph.json b/docs/seeAlsoGraph.json index 7e984c6123..2f1298b299 100644 --- a/docs/seeAlsoGraph.json +++ b/docs/seeAlsoGraph.json @@ -43,6 +43,7 @@ "datatable.component", "data-column.component", "pagination.component", + "infinite-pagination.component", "sites-dropdown.component", "metadata-indicators", "document-library.model", @@ -69,6 +70,7 @@ "FormFieldValidator": [], "highlight.directive": ["text-highlight.pipe"], "highlight-transform.service": ["text-highlight.pipe", "highlight.directive"], + "infinite-pagination.component": [], "info-drawer.component": ["info-drawer-layout.component"], "info-drawer-layout.component": [], "like.component": ["rating.component"], @@ -80,7 +82,7 @@ "nodes-api.service": ["document-library.model", "deleted-nodes-api.service"], "node.service": ["nodes-api.service", "deleted-nodes-api.service"], "notification.service": [], - "pagination.component": [], + "pagination.component": ["infinite-pagination.component"], "page-title.service": ["app-config.service"], "permissions-style.model": ["document-list.component"], "people-search.component": [], diff --git a/docs/start-form.component.md b/docs/start-form.component.md new file mode 100644 index 0000000000..f9a16dcbad --- /dev/null +++ b/docs/start-form.component.md @@ -0,0 +1,46 @@ +# Start Form component + +Displays the Start Form for a process. + +![Start Form screenshot](docassets/images/ProcessStartForm.png) + +## Basic Usage + +```html + + +``` + +### Properties + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| processDefinitionId | string | | Definition ID of the process to start. | +| processId | string | | Process ID of the process to start. | +| showOutcomeButtons | boolean | true | Should form outcome buttons be shown? | +| showRefreshButton | boolean | true | | +| readOnlyForm | boolean | false | Is the form read-only (ie, can't be edited)? | + +### Events + +| Name | Description | +| --- | --- | +| outcomeClick | Emitted when the user clicks one of the outcome buttons that completes the form. | + +## Details + +The [Start Process component](start-process.component.md) uses the Start Form component +to display the +[start form](http://docs.alfresco.com/process-services1.6/topics/none_start_event.html) +for the process. + +The `outcomeClick` event is passed a string containing the ID of the outcome button that +the user clicked. You can pass this value to the `startProcess` method (defined in the +[Process service](process.service.md)) when activating the process, if necessary. + + + + + \ No newline at end of file diff --git a/docs/text-mask.component.md b/docs/text-mask.component.md new file mode 100644 index 0000000000..564637f894 --- /dev/null +++ b/docs/text-mask.component.md @@ -0,0 +1,67 @@ +# Text Mask directive + +Implements text field input masks. + +## Basic Usage + +```html + +``` + +### Properties + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| textMask | any | | Object defining mask and "reversed" status. | + +## Details + +The Text Mask directive implements the "input mask" feature defined in the +Process Services form editor. The mask restricts the way that text data can +be added to the field and also adds formatting as you type. A common example of +this feature is seen in text boxes that accept credit card numbers. The number is +printed on the card as groups of four digits separated by spaces: + +`1234 5678 9012 3456` + +When you type into the field, you can only enter digits and spaces (spaces +are only valid if you type them in the position they occur in the mask; +otherwise, they are added automatically as you type digits). The equivalent +text mask in ADF would be: + +`0000 0000 0000 0000` + +### Mask format characters + +The following characters have special meaning within a mask; all other characters +are included in the text as they are: + +- **"0"**: Denotes a digit +- **"9"**: Denotes a digit that can optionally be left out +- **"A"**: Denotes a alphanumeric character (upper- or lower-case A-Z and digits 0-9) +- **"S"**: Denotes a alphabetic character (upper- or lower-case A-Z) +- **"#"**: Denotes a string of zero or more digits + +The mask is passed to the directive in the `mask` field of the parameter object. The +`reversed` field indicates that digits in the mask are "filled up" in +right-to-left order rather than the usual left-to-right. For example, with the +following mask: + +`#0.0` + +...if the user typed the digits "23" in sequence, the normal left-to-right ordering +would show + +`23` + +...in the textbox. To get the decimal point, the user would have to type it explicitly. +However, with reversed (right-to-left) ordering, the textbox would show + +`2.3` + +...and these digits would slide leftward as the user typed more. + + + + + \ No newline at end of file diff --git a/docs/undocStoplist.json b/docs/undocStoplist.json index 17e124d603..70bc6bd510 100644 --- a/docs/undocStoplist.json +++ b/docs/undocStoplist.json @@ -23,5 +23,13 @@ "translate-loader", "search\\.service", "mediaPlayer", - "unknown-format" + "unknown-format", + "cell", + "error.component", + "no-permission", + "form-custom", + "widget-visibility", + "card-item-types", + "dynamic-component", + "settings" ] \ No newline at end of file