mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-19 17:14:57 +00:00
491 lines
18 KiB
Markdown
491 lines
18 KiB
Markdown
# Component Docs Index
|
|
|
|
Below is an index of the documentation for each component library. The [User Guide](#user-guide)
|
|
section discusses particular techniques in depth. The other sections are references for the ADF
|
|
components. Items marked with an asterisk (*) do not currently have documentation - the link leads
|
|
to the appropriate source file.
|
|
|
|
## Contents
|
|
|
|
- [User Guide](#user-guide)
|
|
- [ADF Analytics](#adf-analytics)
|
|
- [ADF Diagrams](#adf-diagrams)
|
|
- [ADF Form](#adf-form)
|
|
- [ADF Processlist](#adf-processlist)
|
|
- [ADF Tasklist](#adf-tasklist)
|
|
- [ADF Core](#adf-core)
|
|
- [ADF Datatable](#adf-datatable)
|
|
- [ADF Documentlist](#adf-documentlist)
|
|
- [ADF Login](#adf-login)
|
|
- [ADF Search](#adf-search)
|
|
- [ADF Social](#adf-social)
|
|
- [ADF Tag](#adf-tag)
|
|
- [ADF Upload](#adf-upload)
|
|
- [ADF Userinfo](#adf-userinfo)
|
|
- [ADF Viewer](#adf-viewer)
|
|
- [ADF Webscript](#adf-webscript)
|
|
|
|
## User guide
|
|
|
|
<!-- guide start -->
|
|
- [Form Extensibility and Customisation](extensibility.md)
|
|
- [Form Stencils with Angular 2](stencils.md)
|
|
- [Angular Material Design](angular-material-design.md)
|
|
- [Theming](theming.md)
|
|
- [Typography](typography.md)
|
|
- [Walkthrough: adding indicators to highlight information about a node](metadata-indicators.md)
|
|
|
|
<!-- guide end -->
|
|
[(Back to Contents)](#contents)
|
|
|
|
## ADF Analytics
|
|
|
|
Contains the Analytics component and other related items. See the library's
|
|
[README file](../ng2-components/ng2-activiti-analytics/README.md)
|
|
for more information about installing and using the source code.
|
|
<!-- ng2-activiti-analytics start -->
|
|
|
|
### Components
|
|
|
|
- [Analytics generator component](analytics-generator.component.md)
|
|
- [Analytics report list component](analytics-report-list.component.md)
|
|
- [Analytics component](analytics.component.md)
|
|
- [Widget component](widget.component.md)
|
|
- [*Analytics report heat map component](../ng2-components/ng2-activiti-analytics/src/components/analytics-report-heat-map.component.ts)
|
|
- [*Analytics report parameters component](../ng2-components/ng2-activiti-analytics/src/components/analytics-report-parameters.component.ts)
|
|
|
|
### Services
|
|
|
|
- [*Analytics service](../ng2-components/ng2-activiti-analytics/src/services/analytics.service.ts)
|
|
<!-- ng2-activiti-analytics end -->
|
|
|
|
[(Back to Contents)](#contents)
|
|
|
|
## ADF Diagrams
|
|
|
|
Contains the Diagram component and other related items. See the library's
|
|
[README file](../ng2-components/ng2-activiti-diagrams/README.md)
|
|
for more information about installing and using the source code.
|
|
<!-- ng2-activiti-diagrams start -->
|
|
|
|
### Components
|
|
|
|
- [Diagram component](diagram.component.md)
|
|
<!-- ng2-activiti-diagrams end -->
|
|
|
|
[(Back to Contents)](#contents)
|
|
|
|
## ADF Form
|
|
|
|
Contains the Form component and other related items. See the library's
|
|
[README file](../ng2-components/ng2-activiti-form/README.md)
|
|
for more information about installing and using the source code.
|
|
<!-- ng2-activiti-form start -->
|
|
|
|
### Components
|
|
|
|
- [Form list component](form-list.component.md)
|
|
- [Form component](form.component.md)
|
|
- [Widget component](widget.component.md)
|
|
- [*Form field component](../ng2-components/ng2-activiti-form/src/components/form-field/form-field.component.ts)
|
|
- [*Start form component](../ng2-components/ng2-activiti-form/src/components/start-form.component.ts)
|
|
- [*Error component](../ng2-components/ng2-activiti-form/src/components/widgets/error/error.component.ts)
|
|
- [*Text mask component](../ng2-components/ng2-activiti-form/src/components/widgets/text/text-mask.component.ts)
|
|
|
|
### Directives
|
|
|
|
- [*Form custom button directive](../ng2-components/ng2-activiti-form/src/components/form-custom-button.directive.ts)
|
|
|
|
### Models
|
|
|
|
- [Form field model](form-field.model.md)
|
|
|
|
### Services
|
|
|
|
- [Form rendering service](form-rendering.service.md)
|
|
- [Form service](form.service.md)
|
|
- [Node service](node.service.md)
|
|
- [*Activiti alfresco service](../ng2-components/ng2-activiti-form/src/services/activiti-alfresco.service.ts)
|
|
- [*Process content service](../ng2-components/ng2-activiti-form/src/services/process-content.service.ts)
|
|
- [*Widget visibility service](../ng2-components/ng2-activiti-form/src/services/widget-visibility.service.ts)
|
|
|
|
### Widgets
|
|
|
|
- [Content widget](content.widget.md)
|
|
<!-- ng2-activiti-form end -->
|
|
|
|
### Other classes and interfaces
|
|
|
|
- [FormFieldValidator interface](FormFieldValidator.md)
|
|
|
|
[(Back to Contents)](#contents)
|
|
|
|
## ADF Processlist
|
|
|
|
Contains the Processlist component and other related items. See the library's
|
|
[README file](../ng2-components/ng2-activiti-processlist/README.md)
|
|
for more information about installing and using the source code.
|
|
|
|
<!-- ng2-activiti-processlist start -->
|
|
|
|
### Components
|
|
|
|
- [Create process attachment component](create-process-attachment.component.md)
|
|
- [Process attachment list component](process-attachment-list.component.md)
|
|
- [Process comments component](process-comments.component.md)
|
|
- [Process filters component](process-filters.component.md)
|
|
- [Process instance details component](process-instance-details.component.md)
|
|
- [Process instance header component](process-instance-header.component.md)
|
|
- [Process instance tasks component](process-instance-tasks.component.md)
|
|
- [Process list component](process-list.component.md)
|
|
- [Start process component](start-process.component.md)
|
|
|
|
### Directives
|
|
|
|
- [Process audit directive](process-audit.directive.md)
|
|
|
|
### Services
|
|
|
|
- [*Process upload service](../ng2-components/ng2-activiti-processlist/src/services/process-upload.service.ts)
|
|
- [*Process service](../ng2-components/ng2-activiti-processlist/src/services/process.service.ts)
|
|
<!-- ng2-activiti-processlist end -->
|
|
|
|
[(Back to Contents)](#contents)
|
|
|
|
## ADF Tasklist
|
|
|
|
Contains the Tasklist component and other related items. See the library's
|
|
[README file](../ng2-components/ng2-activiti-tasklist/README.md)
|
|
for more information about installing and using the source code.
|
|
<!-- ng2-activiti-tasklist start -->
|
|
|
|
### Components
|
|
|
|
- [Apps list component](apps-list.component.md)
|
|
- [Checklist component](checklist.component.md)
|
|
- [Comments component](comments.component.md)
|
|
- [Create task attachment component](create-task-attachment.component.md)
|
|
- [People search component](people-search.component.md)
|
|
- [People component](people.component.md)
|
|
- [Start task component](start-task.component.md)
|
|
- [Task attachment list component](task-attachment-list.component.md)
|
|
- [Task details component](task-details.component.md)
|
|
- [Task filters component](task-filters.component.md)
|
|
- [Task header component](task-header.component.md)
|
|
- [Task list component](task-list.component.md)
|
|
- [*Comment list component](../ng2-components/ng2-activiti-tasklist/src/components/comment-list.component.ts)
|
|
- [*People list component](../ng2-components/ng2-activiti-tasklist/src/components/people-list.component.ts)
|
|
|
|
### Directives
|
|
|
|
- [Task audit directive](task-audit.directive.md)
|
|
|
|
### Models
|
|
|
|
- [Filter model](filter.model.md)
|
|
- [Task details model](task-details.model.md)
|
|
|
|
### Services
|
|
|
|
- [*Process upload service](../ng2-components/ng2-activiti-tasklist/src/services/process-upload.service.ts)
|
|
- [*Tasklist service](../ng2-components/ng2-activiti-tasklist/src/services/tasklist.service.ts)
|
|
<!-- ng2-activiti-tasklist end -->
|
|
|
|
[(Back to Contents)](#contents)
|
|
|
|
## ADF Core
|
|
|
|
Contains a variety of components, directives and other classes used throughout ADF. See the library's
|
|
[README file](../ng2-components/ng2-alfresco-core/README.md)
|
|
for more information about installing and using the source code.
|
|
<!-- ng2-alfresco-core start -->
|
|
|
|
### Components
|
|
|
|
- [Accordion group component](accordion-group.component.md)
|
|
- [Accordion component](accordion.component.md)
|
|
- [Data column component](data-column.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)
|
|
- [Pagination component](pagination.component.md)
|
|
- [Host settings component](host-settings.component.md)
|
|
- [Toolbar divider component](toolbar-divider.component.md)
|
|
- [Toolbar title component](toolbar-title.component.md)
|
|
- [Toolbar component](toolbar.component.md)
|
|
- [Card view component](card-view.component.md)
|
|
- [*Infinite pagination component](../ng2-components/ng2-alfresco-core/src/components/pagination/infinite-pagination.component.ts)
|
|
|
|
### Directives
|
|
|
|
- [Context menu directive](context-menu.directive.md)
|
|
- [Folder create directive](folder-create.directive.md)
|
|
- [Folder edit directive](folder-edit.directive.md)
|
|
- [Highlight directive](highlight.directive.md)
|
|
- [Logout directive](logout.directive.md)
|
|
- [Node delete directive](node-delete.directive.md)
|
|
- [Node favorite directive](node-favorite.directive.md)
|
|
- [Node permission directive](node-permission.directive.md)
|
|
- [Node restore directive](node-restore.directive.md)
|
|
- [Upload directive](upload.directive.md)
|
|
|
|
### Models
|
|
|
|
- [Comment process model](comment-process.model.md)
|
|
- [Product version model](product-version.model.md)
|
|
- [Site model](site.model.md)
|
|
- [User process model](user-process.model.md)
|
|
|
|
### Pipes
|
|
|
|
- [File size pipe](file-size.pipe.md)
|
|
- [Mime type icon pipe](mime-type-icon.pipe.md)
|
|
- [Node name tooltip pipe](node-name-tooltip.pipe.md)
|
|
- [Text highlight pipe](text-highlight.pipe.md)
|
|
- [Time ago pipe](time-ago.pipe.md)
|
|
- [User initial pipe](user-initial.pipe.md)
|
|
|
|
### Services
|
|
|
|
- [Alfresco api service](alfresco-api.service.md)
|
|
- [Alfresco content service](alfresco-content.service.md)
|
|
- [App config service](app-config.service.md)
|
|
- [Apps process service](apps-process.service.md)
|
|
- [Auth guard bpm service](auth-guard-bpm.service.md)
|
|
- [Auth guard ecm service](auth-guard-ecm.service.md)
|
|
- [Auth guard service](auth-guard.service.md)
|
|
- [Authentication service](authentication.service.md)
|
|
- [Card view update service](card-view-update.service.md)
|
|
- [Comment process service](comment-process.service.md)
|
|
- [Content service](content.service.md)
|
|
- [Cookie service](cookie.service.md)
|
|
- [Deleted nodes api service](deleted-nodes-api.service.md)
|
|
- [Discovery api service](discovery-api.service.md)
|
|
- [Favorites api service](favorites-api.service.md)
|
|
- [Highlight transform service](highlight-transform.service.md)
|
|
- [Log service](log.service.md)
|
|
- [Nodes api service](nodes-api.service.md)
|
|
- [Notification service](notification.service.md)
|
|
- [Page title service](page-title.service.md)
|
|
- [People content service](people-content.service.md)
|
|
- [People process service](people-process.service.md)
|
|
- [Renditions service](renditions.service.md)
|
|
- [Search api service](search-api.service.md)
|
|
- [Shared links api service](shared-links-api.service.md)
|
|
- [Sites api service](sites-api.service.md)
|
|
- [Storage service](storage.service.md)
|
|
- [Thumbnail service](thumbnail.service.md)
|
|
- [Translation service](translation.service.md)
|
|
- [Upload service](upload.service.md)
|
|
- [User preferences service](user-preferences.service.md)
|
|
<!-- ng2-alfresco-core end -->
|
|
|
|
[(Back to Contents)](#contents)
|
|
|
|
## ADF Datatable
|
|
|
|
Contains the Datatable component and other related items. See the library's
|
|
[README file](../ng2-components/ng2-alfresco-datatable/README.md)
|
|
for more information about installing and using the source code.
|
|
<!-- ng2-alfresco-datatable start -->
|
|
|
|
### Components
|
|
|
|
- [Datatable component](datatable.component.md)
|
|
- [*Datatable cell component](../ng2-components/ng2-alfresco-datatable/src/components/datatable/datatable-cell.component.ts)
|
|
- [*Date cell component](../ng2-components/ng2-alfresco-datatable/src/components/datatable/date-cell.component.ts)
|
|
- [*Filesize cell component](../ng2-components/ng2-alfresco-datatable/src/components/datatable/filesize-cell.component.ts)
|
|
- [*Location cell component](../ng2-components/ng2-alfresco-datatable/src/components/datatable/location-cell.component.ts)
|
|
|
|
### Directives
|
|
|
|
- [*No permission template directive](../ng2-components/ng2-alfresco-datatable/src/directives/no-permission-template.directive.ts)
|
|
<!-- ng2-alfresco-datatable end -->
|
|
|
|
### Other classes and interfaces
|
|
|
|
- [DataTableAdapter interface](DataTableAdapter.md)
|
|
|
|
[(Back to Contents)](#contents)
|
|
|
|
## ADF Documentlist
|
|
|
|
Contains the Document List component and other related items. See the library's
|
|
[README file](../ng2-components/ng2-alfresco-documentlist/README.md)
|
|
for more information about installing and using the source code.
|
|
<!-- ng2-alfresco-documentlist start -->
|
|
|
|
### Components
|
|
|
|
- [Breadcrumb component](breadcrumb.component.md)
|
|
- [Dropdown breadcrumb component](dropdown-breadcrumb.component.md)
|
|
- [Content action component](content-action.component.md)
|
|
- [Document list component](document-list.component.md)
|
|
- [Sites dropdown component](sites-dropdown.component.md)
|
|
- [Version list component](version-list.component.md)
|
|
- [Version manager component](version-manager.component.md)
|
|
- [*Content node selector component](../ng2-components/ng2-alfresco-documentlist/src/components/content-node-selector/content-node-selector.component.ts)
|
|
- [*Version upload component](../ng2-components/ng2-alfresco-documentlist/src/components/version-manager/version-upload.component.ts)
|
|
|
|
### Directives
|
|
|
|
- [*No permission content directive](../ng2-components/ng2-alfresco-documentlist/src/components/no-permission/no-permission-content.directive.ts)
|
|
|
|
### Models
|
|
|
|
- [Document library model](document-library.model.md)
|
|
- [Permissions style model](permissions-style.model.md)
|
|
|
|
### Services
|
|
|
|
- [Document actions service](document-actions.service.md)
|
|
- [Folder actions service](folder-actions.service.md)
|
|
- [*Content node selector service](../ng2-components/ng2-alfresco-documentlist/src/components/content-node-selector/content-node-selector.service.ts)
|
|
- [*Document list service](../ng2-components/ng2-alfresco-documentlist/src/services/document-list.service.ts)
|
|
- [*Node actions service](../ng2-components/ng2-alfresco-documentlist/src/services/node-actions.service.ts)
|
|
<!-- ng2-alfresco-documentlist end -->
|
|
|
|
[(Back to Contents)](#contents)
|
|
|
|
## ADF Login
|
|
|
|
Contains the Login component and other related items. See the library's
|
|
[README file](../ng2-components/ng2-alfresco-login/README.md)
|
|
for more information about installing and using the source code.
|
|
<!-- ng2-alfresco-login start -->
|
|
|
|
### Components
|
|
|
|
- [Login component](login.component.md)
|
|
<!-- ng2-alfresco-login end -->
|
|
|
|
[(Back to Contents)](#contents)
|
|
|
|
## ADF Search
|
|
|
|
Contains the Search component and other related items. See the library's
|
|
[README file](../ng2-components/ng2-alfresco-search/README.md)
|
|
for more information about installing and using the source code.
|
|
<!-- ng2-alfresco-search start -->
|
|
|
|
### Components
|
|
|
|
- [Search control component](search-control.component.md)
|
|
- [Search component](search.component.md)
|
|
- [*Search autocomplete component](../ng2-components/ng2-alfresco-search/src/components/search-autocomplete.component.ts)
|
|
<!-- ng2-alfresco-search end -->
|
|
|
|
[(Back to Contents)](#contents)
|
|
|
|
## ADF Social
|
|
|
|
Contains components for adding likes and ratings to items. See the library's
|
|
[README file](../ng2-components/ng2-alfresco-social/README.md)
|
|
for more information about installing and using the source code.
|
|
<!-- ng2-alfresco-social start -->
|
|
|
|
### Components
|
|
|
|
- [Like component](like.component.md)
|
|
- [Rating component](rating.component.md)
|
|
|
|
### Services
|
|
|
|
- [*Rating service](../ng2-components/ng2-alfresco-social/src/services/rating.service.ts)
|
|
<!-- ng2-alfresco-social end -->
|
|
|
|
[(Back to Contents)](#contents)
|
|
|
|
## ADF Tag
|
|
|
|
Contains components for adding tags to documents. See the library's
|
|
[README file](../ng2-components/ng2-alfresco-tag/README.md)
|
|
for more information about installing and using the source code.
|
|
<!-- ng2-alfresco-tag start -->
|
|
|
|
### Components
|
|
|
|
- [Tag actions component](tag-actions.component.md)
|
|
- [Tag list component](tag-list.component.md)
|
|
- [Tag node list component](tag-node-list.component.md)
|
|
|
|
### Services
|
|
|
|
- [*Tag service](../ng2-components/ng2-alfresco-tag/src/services/tag.service.ts)
|
|
<!-- ng2-alfresco-tag end -->
|
|
|
|
[(Back to Contents)](#contents)
|
|
|
|
## ADF Upload
|
|
|
|
Contains components for uploading files to Content Services. See the library's
|
|
[README file](../ng2-components/ng2-alfresco-upload/README.md)
|
|
for more information about installing and using the source code.
|
|
<!-- ng2-alfresco-upload start -->
|
|
|
|
### Components
|
|
|
|
- [File uploading dialog component](file-uploading-dialog.component.md)
|
|
- [Upload button component](upload-button.component.md)
|
|
- [Upload drag area component](upload-drag-area.component.md)
|
|
- [*File uploading list row component](../ng2-components/ng2-alfresco-upload/src/components/file-uploading-list-row.component.ts)
|
|
- [*File uploading list component](../ng2-components/ng2-alfresco-upload/src/components/file-uploading-list.component.ts)
|
|
|
|
### Directives
|
|
|
|
- [*File draggable directive](../ng2-components/ng2-alfresco-upload/src/directives/file-draggable.directive.ts)
|
|
<!-- ng2-alfresco-upload end -->
|
|
|
|
[(Back to Contents)](#contents)
|
|
|
|
## ADF Userinfo
|
|
|
|
Contains the User Info component and other related items. See the library's
|
|
[README file](../ng2-components/ng2-alfresco-userinfo/README.md)
|
|
for more information about installing and using the source code.
|
|
<!-- ng2-alfresco-userinfo start -->
|
|
|
|
### Components
|
|
|
|
- [User info component](user-info.component.md)
|
|
|
|
### Models
|
|
|
|
- [Bpm user model](bpm-user.model.md)
|
|
- [Ecm user model](ecm-user.model.md)
|
|
|
|
### Services
|
|
|
|
- [Bpm user service](bpm-user.service.md)
|
|
- [Ecm user service](ecm-user.service.md)
|
|
<!-- ng2-alfresco-userinfo end -->
|
|
|
|
[(Back to Contents)](#contents)
|
|
|
|
## ADF Viewer
|
|
|
|
Contains the Viewer component and other related items. See the library's
|
|
[README file](../ng2-components/ng2-alfresco-viewer/README.md)
|
|
for more information about installing and using the source code.
|
|
<!-- ng2-alfresco-viewer start -->
|
|
|
|
### Components
|
|
|
|
- [Viewer component](viewer.component.md)
|
|
<!-- ng2-alfresco-viewer end -->
|
|
|
|
[(Back to Contents)](#contents)
|
|
|
|
## ADF Webscript
|
|
|
|
Contains the Webscript component. See the library's
|
|
[README file](../ng2-components/ng2-alfresco-webscript/README.md)
|
|
for more information about installing and using the source code.
|
|
<!-- ng2-alfresco-webscript start -->
|
|
|
|
### Components
|
|
|
|
- [Webscript component](webscript.component.md)
|
|
<!-- ng2-alfresco-webscript end -->
|
|
|
|
[(Back to Contents)](#contents) |