alfresco-ng2-components/docs/README.md

Component Docs Index

Below is an index of the documentation for ADF. The 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
• ADF Core
• ADF Content Services
• ADF Process Services
• ADF Insights

User guide

• Form Extensibility and Customisation
• Angular Material Design
• Theming
• Typography
• Walkthrough - adding indicators to highlight information about a node

(Back to Contents)

ADF Core

Contains a variety of components used throughout ADF. See the library's README file for more information about installing and using the source code.

Components

Name	Description	Source link
Card view component	Not currently documented	Source
Accordion group component	Not currently documented	Source
Accordion component	Not currently documented	Source
Data column component	Not currently documented	Source
Datatable component	Not currently documented	Source
Form field component	Not currently documented	Source
Form list component	Not currently documented	Source
Form component	Not currently documented	Source
Start form component	Not currently documented	Source
Text mask component	Not currently documented	Source
Info drawer layout component	Not currently documented	Source
Info drawer component	Not currently documented	Source
Language menu component	Not currently documented	Source
Login component	Not currently documented	Source
Infinite pagination component	Not currently documented	Source
Pagination component	Not currently documented	Source
Sidebar action menu component	Not currently documented	Source
Toolbar divider component	Not currently documented	Source
Toolbar title component	Not currently documented	Source
Toolbar component	Not currently documented	Source
User info component	Not currently documented	Source

Directives

Name	Description	Source link
Highlight directive	Not currently documented	Source
Logout directive	Not currently documented	Source
Node delete directive	Not currently documented	Source
Node favorite directive	Not currently documented	Source
Node permission directive	Not currently documented	Source
Node restore directive	Not currently documented	Source
Upload directive	Not currently documented	Source

Pipes

Name	Description	Source link
File size pipe	Not currently documented	Source
Mime type icon pipe	Not currently documented	Source
Node name tooltip pipe	Not currently documented	Source
Text highlight pipe	Not currently documented	Source
Time ago pipe	Not currently documented	Source
User initial pipe	Not currently documented	Source

Services

Name	Description	Source link
Card view update service	Not currently documented	Source
Activiti alfresco service	Not currently documented	Source
Form rendering service	Not currently documented	Source
Form service	Not currently documented	Source
Node service	Not currently documented	Source
Process content service	Not currently documented	Source
Alfresco api service	Not currently documented	Source
Apps process service	Not currently documented	Source
Auth guard bpm service	Not currently documented	Source
Auth guard ecm service	Not currently documented	Source
Auth guard service	Not currently documented	Source
Authentication service	Not currently documented	Source
Comment process service	Not currently documented	Source
Content service	Not currently documented	Source
Cookie service	Not currently documented	Source
Deleted nodes api service	Not currently documented	Source
Discovery api service	Not currently documented	Source
Favorites api service	Not currently documented	Source
Highlight transform service	Not currently documented	Source
Log service	Not currently documented	Source
Nodes api service	Not currently documented	Source
Notification service	Not currently documented	Source
Page title service	Not currently documented	Source
People content service	Not currently documented	Source
People process service	Not currently documented	Source
Renditions service	Not currently documented	Source
Search configuration service	Not currently documented	Source
Shared links api service	Not currently documented	Source
Sites service	Not currently documented	Source
Storage service	Not currently documented	Source
Thumbnail service	Not currently documented	Source
Translation service	Not currently documented	Source
Upload service	Not currently documented	Source
User preferences service	Not currently documented	Source
Bpm user service	Not currently documented	Source
Ecm user service	Not currently documented	Source

Other classes and interfaces

Name	Description	Source link
Data Table Adapter interface	Defines how table data is supplied to DataTable and Tasklist components.	Source
Form Field Validator interface	Defines how the input fields of ADF Form and ADF Task Details components are validated.	Source
Search Configuration interface	Provides fine control of parameters to a search.	Source

(Back to Contents)

ADF Content Services

Contains components related to Content Services. See the library's README file for more information about installing and using the source code.

Components

Name	Description	Source link
Breadcrumb component	Not currently documented	Source
Dropdown breadcrumb component	Not currently documented	Source
Content node selector panel component	Not currently documented	Source
Content node selector component	Not currently documented	Source
Content action component	Not currently documented	Source
Document list component	Not currently documented	Source
Search control component	Not currently documented	Source
Search component	Not currently documented	Source
Sites dropdown component	Not currently documented	Source
Like component	Not currently documented	Source
Rating component	Not currently documented	Source
Tag actions component	Not currently documented	Source
Tag list component	Not currently documented	Source
Tag node list component	Not currently documented	Source
Upload button component	Not currently documented	Source
Upload drag area component	Not currently documented	Source
Version list component	Not currently documented	Source
Version manager component	Not currently documented	Source
Webscript component	Not currently documented	Source

Directives

Name	Description	Source link
Folder create directive	Not currently documented	Source
Folder edit directive	Not currently documented	Source
File draggable directive	Not currently documented	Source

Services

Name	Description	Source link
Content node dialog service	Not currently documented	Source
Document actions service	Not currently documented	Source
Document list service	Not currently documented	Source
Folder actions service	Not currently documented	Source
Rating service	Not currently documented	Source
Tag service	Not currently documented	Source

(Back to Contents)

ADF Process Services

Contains components related to Process Services. See the library's README file for more information about installing and using the source code.

Components

Name	Description	Source link
Process list component	Renders a list containing all the process instances matched by the parameters specified.	Source
Apps list component	Not currently documented	Source
Create process attachment component	Not currently documented	Source
Create task attachment component	Not currently documented	Source
Process attachment list component	Not currently documented	Source
Task attachment list component	Not currently documented	Source
Comment list component	Not currently documented	Source
Comments component	Not currently documented	Source
Process comments component	Not currently documented	Source
People list component	Not currently documented	Source
People search component	Not currently documented	Source
People component	Not currently documented	Source
Process filters component	Not currently documented	Source
Process instance details component	Not currently documented	Source
Process instance header component	Not currently documented	Source
Process instance tasks component	Not currently documented	Source
Start process component	Not currently documented	Source
Checklist component	Not currently documented	Source
Start task component	Not currently documented	Source
Task details component	Not currently documented	Source
Task filters component	Not currently documented	Source
Task header component	Not currently documented	Source
Task list component	Not currently documented	Source

Directives

Name	Description	Source link
Process audit directive	Not currently documented	Source
Task audit directive	Not currently documented	Source

Services

Name	Description	Source link
Process filter service	Not currently documented	Source
Process service	Not currently documented	Source
Task filter service	Not currently documented	Source
Tasklist service	Not currently documented	Source

(Back to Contents)

ADF Insights

Contains components for Process Services analytics and diagrams. See the library's README file for more information about installing and using the source code.

Components

Name	Description	Source link
Widget component	Not currently documented	Source

(Back to Contents)