inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-19 17:14:57 +00:00
Code Issues Packages Projects Releases Wiki Activity
alfresco-ng2-components/docs/README.md
Andy Stark 900fd70d63 [ADF-1769] Added prop tables and fixed script (#2896) 
* [ADF-1769] Added prop tables and fixed script

* [ADF-1769] Corrected JSDoc formatting errors

* [ADF-1769] Restored default column to prop tables
2018-01-31 09:22:05 +00:00

273 lines
20 KiB
Markdown
Raw Blame History

# Component Docs Index
Below is an index of the documentation for ADF. The [User Guide](#user-guide)
section discusses particular techniques in depth. The other sections are references for the ADF
libraries. Click the name of an item to see its documentation or click the source link to see
its main source file. Note that ADF is developed continuously, so the source files for some items
may be listed here before their documentation is available.
## Contents
- [User Guide](#user-guide)
- [ADF Core](#adf-core)
- [ADF Content Services](#adf-content-services)
- [ADF Process Services](#adf-process-services)
- [ADF Insights](#adf-insights)
## User guide
<!--guide start-->
- [Form Extensibility and Customisation](extensibility.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 Core
Contains a variety of components used throughout ADF.
See the library's
[README file](../lib/core/README.md)
for more information about installing and using the source code.
<!--core start-->
## Components
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| _Card view component_ | _Not currently documented_ | [Source](../lib/core/card-view/components/card-view/card-view.component.ts) |
| _Accordion group component_ | _Not currently documented_ | [Source](../lib/core/collapsable/accordion-group.component.ts) |
| _Accordion component_ | _Not currently documented_ | [Source](../lib/core/collapsable/accordion.component.ts) |
| _Data column component_ | _Not currently documented_ | [Source](../lib/core/data-column/data-column.component.ts) |
| _Datatable component_ | _Not currently documented_ | [Source](../lib/core/datatable/components/datatable/datatable.component.ts) |
| _Form field component_ | _Not currently documented_ | [Source](../lib/core/form/components/form-field/form-field.component.ts) |
| _Form list component_ | _Not currently documented_ | [Source](../lib/core/form/components/form-list.component.ts) |
| _Form component_ | _Not currently documented_ | [Source](../lib/core/form/components/form.component.ts) |
| _Start form component_ | _Not currently documented_ | [Source](../lib/core/form/components/start-form.component.ts) |
| _Text mask component_ | _Not currently documented_ | [Source](../lib/core/form/components/widgets/text/text-mask.component.ts) |
| _Info drawer layout component_ | _Not currently documented_ | [Source](../lib/core/info-drawer/info-drawer-layout.component.ts) |
| _Info drawer component_ | _Not currently documented_ | [Source](../lib/core/info-drawer/info-drawer.component.ts) |
| _Language menu component_ | _Not currently documented_ | [Source](../lib/core/language-menu/language-menu.component.ts) |
| _Login component_ | _Not currently documented_ | [Source](../lib/core/login/components/login.component.ts) |
| _Infinite pagination component_ | _Not currently documented_ | [Source](../lib/core/pagination/infinite-pagination.component.ts) |
| _Pagination component_ | _Not currently documented_ | [Source](../lib/core/pagination/pagination.component.ts) |
| _Sidebar action menu component_ | _Not currently documented_ | [Source](../lib/core/sidebar/sidebar-action-menu.component.ts) |
| _Toolbar divider component_ | _Not currently documented_ | [Source](../lib/core/toolbar/toolbar-divider.component.ts) |
| _Toolbar title component_ | _Not currently documented_ | [Source](../lib/core/toolbar/toolbar-title.component.ts) |
| _Toolbar component_ | _Not currently documented_ | [Source](../lib/core/toolbar/toolbar.component.ts) |
| _User info component_ | _Not currently documented_ | [Source](../lib/core/userinfo/components/user-info.component.ts) |
## Directives
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| _Highlight directive_ | _Not currently documented_ | [Source](../lib/core/directives/highlight.directive.ts) |
| _Logout directive_ | _Not currently documented_ | [Source](../lib/core/directives/logout.directive.ts) |
| _Node delete directive_ | _Not currently documented_ | [Source](../lib/core/directives/node-delete.directive.ts) |
| _Node favorite directive_ | _Not currently documented_ | [Source](../lib/core/directives/node-favorite.directive.ts) |
| _Node permission directive_ | _Not currently documented_ | [Source](../lib/core/directives/node-permission.directive.ts) |
| _Node restore directive_ | _Not currently documented_ | [Source](../lib/core/directives/node-restore.directive.ts) |
| _Upload directive_ | _Not currently documented_ | [Source](../lib/core/directives/upload.directive.ts) |
## Pipes
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| _File size pipe_ | _Not currently documented_ | [Source](../lib/core/pipes/file-size.pipe.ts) |
| _Mime type icon pipe_ | _Not currently documented_ | [Source](../lib/core/pipes/mime-type-icon.pipe.ts) |
| _Node name tooltip pipe_ | _Not currently documented_ | [Source](../lib/core/pipes/node-name-tooltip.pipe.ts) |
| _Text highlight pipe_ | _Not currently documented_ | [Source](../lib/core/pipes/text-highlight.pipe.ts) |
| _Time ago pipe_ | _Not currently documented_ | [Source](../lib/core/pipes/time-ago.pipe.ts) |
| _User initial pipe_ | _Not currently documented_ | [Source](../lib/core/pipes/user-initial.pipe.ts) |
## Services
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| _Card view update service_ | _Not currently documented_ | [Source](../lib/core/card-view/services/card-view-update.service.ts) |
| _Activiti alfresco service_ | _Not currently documented_ | [Source](../lib/core/form/services/activiti-alfresco.service.ts) |
| _Form rendering service_ | _Not currently documented_ | [Source](../lib/core/form/services/form-rendering.service.ts) |
| _Form service_ | _Not currently documented_ | [Source](../lib/core/form/services/form.service.ts) |
| _Node service_ | _Not currently documented_ | [Source](../lib/core/form/services/node.service.ts) |
| _Process content service_ | _Not currently documented_ | [Source](../lib/core/form/services/process-content.service.ts) |
| _Alfresco api service_ | _Not currently documented_ | [Source](../lib/core/services/alfresco-api.service.ts) |
| _Apps process service_ | _Not currently documented_ | [Source](../lib/core/services/apps-process.service.ts) |
| _Auth guard bpm service_ | _Not currently documented_ | [Source](../lib/core/services/auth-guard-bpm.service.ts) |
| _Auth guard ecm service_ | _Not currently documented_ | [Source](../lib/core/services/auth-guard-ecm.service.ts) |
| _Auth guard service_ | _Not currently documented_ | [Source](../lib/core/services/auth-guard.service.ts) |
| _Authentication service_ | _Not currently documented_ | [Source](../lib/core/services/authentication.service.ts) |
| _Comment process service_ | _Not currently documented_ | [Source](../lib/core/services/comment-process.service.ts) |
| _Content service_ | _Not currently documented_ | [Source](../lib/core/services/content.service.ts) |
| _Cookie service_ | _Not currently documented_ | [Source](../lib/core/services/cookie.service.ts) |
| _Deleted nodes api service_ | _Not currently documented_ | [Source](../lib/core/services/deleted-nodes-api.service.ts) |
| _Discovery api service_ | _Not currently documented_ | [Source](../lib/core/services/discovery-api.service.ts) |
| _Favorites api service_ | _Not currently documented_ | [Source](../lib/core/services/favorites-api.service.ts) |
| _Highlight transform service_ | _Not currently documented_ | [Source](../lib/core/services/highlight-transform.service.ts) |
| _Log service_ | _Not currently documented_ | [Source](../lib/core/services/log.service.ts) |
| _Nodes api service_ | _Not currently documented_ | [Source](../lib/core/services/nodes-api.service.ts) |
| _Notification service_ | _Not currently documented_ | [Source](../lib/core/services/notification.service.ts) |
| _Page title service_ | _Not currently documented_ | [Source](../lib/core/services/page-title.service.ts) |
| _People content service_ | _Not currently documented_ | [Source](../lib/core/services/people-content.service.ts) |
| _People process service_ | _Not currently documented_ | [Source](../lib/core/services/people-process.service.ts) |
| _Renditions service_ | _Not currently documented_ | [Source](../lib/core/services/renditions.service.ts) |
| _Search configuration service_ | _Not currently documented_ | [Source](../lib/core/services/search-configuration.service.ts) |
| _Shared links api service_ | _Not currently documented_ | [Source](../lib/core/services/shared-links-api.service.ts) |
| _Sites service_ | _Not currently documented_ | [Source](../lib/core/services/sites.service.ts) |
| _Storage service_ | _Not currently documented_ | [Source](../lib/core/services/storage.service.ts) |
| _Thumbnail service_ | _Not currently documented_ | [Source](../lib/core/services/thumbnail.service.ts) |
| _Translation service_ | _Not currently documented_ | [Source](../lib/core/services/translation.service.ts) |
| _Upload service_ | _Not currently documented_ | [Source](../lib/core/services/upload.service.ts) |
| _User preferences service_ | _Not currently documented_ | [Source](../lib/core/services/user-preferences.service.ts) |
| _Bpm user service_ | _Not currently documented_ | [Source](../lib/core/userinfo/services/bpm-user.service.ts) |
| _Ecm user service_ | _Not currently documented_ | [Source](../lib/core/userinfo/services/ecm-user.service.ts) |
<!--core end-->
## Other classes and interfaces
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| [Data Table Adapter interface](DataTableAdapter.md) | Defines how table data is supplied to [DataTable](datatable.component.md) and [Tasklist](task-list.component.md) components. | [Source](../core/datatable/data/datatable-adapter.ts) |
| [Form Field Validator interface](FormFieldValidator.md) | Defines how the input fields of [ADF Form](form.component.md) and [ADF Task Details](task-details.component.md) components are validated. | [Source](../core/form/components/widgets/core/form-field-validator.ts) |
| [Search Configuration interface](search-configuration.interface.md) | Provides fine control of parameters to a search. | [Source](../core/services/search-configuration.service.ts) |
[(Back to Contents)](#contents)
## ADF Content Services
Contains components related to Content Services.
See the library's
[README file](../lib/content-services/README.md)
for more information about installing and using the source code.
<!--content-services start-->
## Components
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| _Breadcrumb component_ | _Not currently documented_ | [Source](../lib/content-services/breadcrumb/breadcrumb.component.ts) |
| _Dropdown breadcrumb component_ | _Not currently documented_ | [Source](../lib/content-services/breadcrumb/dropdown-breadcrumb.component.ts) |
| _Content node selector panel component_ | _Not currently documented_ | [Source](../lib/content-services/content-node-selector/content-node-selector-panel.component.ts) |
| _Content node selector component_ | _Not currently documented_ | [Source](../lib/content-services/content-node-selector/content-node-selector.component.ts) |
| _Content action component_ | _Not currently documented_ | [Source](../lib/content-services/document-list/components/content-action/content-action.component.ts) |
| _Document list component_ | _Not currently documented_ | [Source](../lib/content-services/document-list/components/document-list.component.ts) |
| _Search control component_ | _Not currently documented_ | [Source](../lib/content-services/search/components/search-control.component.ts) |
| _Search component_ | _Not currently documented_ | [Source](../lib/content-services/search/components/search.component.ts) |
| _Sites dropdown component_ | _Not currently documented_ | [Source](../lib/content-services/site-dropdown/sites-dropdown.component.ts) |
| _Like component_ | _Not currently documented_ | [Source](../lib/content-services/social/like.component.ts) |
| _Rating component_ | _Not currently documented_ | [Source](../lib/content-services/social/rating.component.ts) |
| _Tag actions component_ | _Not currently documented_ | [Source](../lib/content-services/tag/tag-actions.component.ts) |
| _Tag list component_ | _Not currently documented_ | [Source](../lib/content-services/tag/tag-list.component.ts) |
| _Tag node list component_ | _Not currently documented_ | [Source](../lib/content-services/tag/tag-node-list.component.ts) |
| _Upload button component_ | _Not currently documented_ | [Source](../lib/content-services/upload/components/upload-button.component.ts) |
| _Upload drag area component_ | _Not currently documented_ | [Source](../lib/content-services/upload/components/upload-drag-area.component.ts) |
| _Version list component_ | _Not currently documented_ | [Source](../lib/content-services/version-manager/version-list.component.ts) |
| _Version manager component_ | _Not currently documented_ | [Source](../lib/content-services/version-manager/version-manager.component.ts) |
| _Webscript component_ | _Not currently documented_ | [Source](../lib/content-services/webscript/webscript.component.ts) |
## Directives
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| _Folder create directive_ | _Not currently documented_ | [Source](../lib/content-services/folder-directive/folder-create.directive.ts) |
| _Folder edit directive_ | _Not currently documented_ | [Source](../lib/content-services/folder-directive/folder-edit.directive.ts) |
| _File draggable directive_ | _Not currently documented_ | [Source](../lib/content-services/upload/directives/file-draggable.directive.ts) |
## Services
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| _Content node dialog service_ | _Not currently documented_ | [Source](../lib/content-services/content-node-selector/content-node-dialog.service.ts) |
| _Document actions service_ | _Not currently documented_ | [Source](../lib/content-services/document-list/services/document-actions.service.ts) |
| _Document list service_ | _Not currently documented_ | [Source](../lib/content-services/document-list/services/document-list.service.ts) |
| _Folder actions service_ | _Not currently documented_ | [Source](../lib/content-services/document-list/services/folder-actions.service.ts) |
| _Rating service_ | _Not currently documented_ | [Source](../lib/content-services/social/services/rating.service.ts) |
| _Tag service_ | _Not currently documented_ | [Source](../lib/content-services/tag/services/tag.service.ts) |
<!--content-services end-->
[(Back to Contents)](#contents)
## ADF Process Services
Contains components related to Process Services.
See the library's
[README file](../lib/process-services/README.md)
for more information about installing and using the source code.
<!--process-services start-->
## Components
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| [Process list component](process-list.component.md) | Renders a list containing all the process instances matched by the parameters specified. | [Source](../lib/process-services/process-list/components/process-list.component.ts) |
| _Apps list component_ | _Not currently documented_ | [Source](../lib/process-services/app-list/apps-list.component.ts) |
| _Create process attachment component_ | _Not currently documented_ | [Source](../lib/process-services/attachment/create-process-attachment.component.ts) |
| _Create task attachment component_ | _Not currently documented_ | [Source](../lib/process-services/attachment/create-task-attachment.component.ts) |
| _Process attachment list component_ | _Not currently documented_ | [Source](../lib/process-services/attachment/process-attachment-list.component.ts) |
| _Task attachment list component_ | _Not currently documented_ | [Source](../lib/process-services/attachment/task-attachment-list.component.ts) |
| _Comment list component_ | _Not currently documented_ | [Source](../lib/process-services/comments/comment-list.component.ts) |
| _Comments component_ | _Not currently documented_ | [Source](../lib/process-services/comments/comments.component.ts) |
| _Process comments component_ | _Not currently documented_ | [Source](../lib/process-services/comments/process-comments.component.ts) |
| _People list component_ | _Not currently documented_ | [Source](../lib/process-services/people/people-list.component.ts) |
| _People search component_ | _Not currently documented_ | [Source](../lib/process-services/people/people-search.component.ts) |
| _People component_ | _Not currently documented_ | [Source](../lib/process-services/people/people.component.ts) |
| _Process filters component_ | _Not currently documented_ | [Source](../lib/process-services/process-list/components/process-filters.component.ts) |
| _Process instance details component_ | _Not currently documented_ | [Source](../lib/process-services/process-list/components/process-instance-details.component.ts) |
| _Process instance header component_ | _Not currently documented_ | [Source](../lib/process-services/process-list/components/process-instance-header.component.ts) |
| _Process instance tasks component_ | _Not currently documented_ | [Source](../lib/process-services/process-list/components/process-instance-tasks.component.ts) |
| _Start process component_ | _Not currently documented_ | [Source](../lib/process-services/process-list/components/start-process.component.ts) |
| _Checklist component_ | _Not currently documented_ | [Source](../lib/process-services/task-list/components/checklist.component.ts) |
| _Start task component_ | _Not currently documented_ | [Source](../lib/process-services/task-list/components/start-task.component.ts) |
| _Task details component_ | _Not currently documented_ | [Source](../lib/process-services/task-list/components/task-details.component.ts) |
| _Task filters component_ | _Not currently documented_ | [Source](../lib/process-services/task-list/components/task-filters.component.ts) |
| _Task header component_ | _Not currently documented_ | [Source](../lib/process-services/task-list/components/task-header.component.ts) |
| _Task list component_ | _Not currently documented_ | [Source](../lib/process-services/task-list/components/task-list.component.ts) |
## Directives
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| _Process audit directive_ | _Not currently documented_ | [Source](../lib/process-services/process-list/components/process-audit.directive.ts) |
| _Task audit directive_ | _Not currently documented_ | [Source](../lib/process-services/task-list/components/task-audit.directive.ts) |
## Services
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| _Process filter service_ | _Not currently documented_ | [Source](../lib/process-services/process-list/services/process-filter.service.ts) |
| _Process service_ | _Not currently documented_ | [Source](../lib/process-services/process-list/services/process.service.ts) |
| _Task filter service_ | _Not currently documented_ | [Source](../lib/process-services/task-list/services/task-filter.service.ts) |
| _Tasklist service_ | _Not currently documented_ | [Source](../lib/process-services/task-list/services/tasklist.service.ts) |
<!--process-services end-->
[(Back to Contents)](#contents)
## ADF Insights
Contains components for Process Services analytics and diagrams.
See the library's
[README file](../lib/insights/README.md)
for more information about installing and using the source code.
<!--insights start-->
## Components
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| _Widget component_ | _Not currently documented_ | [Source](../lib/insights/analytics-process/components/widgets/widget.component.ts) |
<!--insights end-->
[(Back to Contents)](#contents)
Reference in New Issue View Git Blame Copy Permalink