From 0a394869f563528b29455290604396193245cdfe Mon Sep 17 00:00:00 2001 From: Andy Stark <30621568+therealandeeee@users.noreply.github.com> Date: Wed, 21 Nov 2018 11:19:56 +0000 Subject: [PATCH] [ADF-3745] Updates for doc review (20-11-2018) (#3992) --- .../content-action.component.md | 28 +++++++++--------- .../file-uploading-dialog.component.md | 2 +- .../folder-create.directive.md | 2 +- .../inherited-button.directive.md | 2 +- .../node-download.directive.md | 2 +- docs/content-services/node-lock.directive.md | 19 +++++++----- .../permission-list.component.md | 2 +- docs/core/card-item-types.service.md | 8 ++--- docs/core/context-menu.directive.md | 5 ++-- docs/core/form-field.component.md | 12 ++++---- docs/core/form-list.component.md | 3 +- docs/core/form-rendering.service.md | 24 +++++++-------- docs/core/header.component.md | 29 +++++++++---------- docs/core/highlight.directive.md | 4 +-- docs/core/node-delete.directive.md | 2 +- docs/core/node-permission.directive.md | 12 +++++--- docs/core/node.service.md | 2 +- docs/core/pagination.component.md | 2 +- docs/core/sidebar-action-menu.component.md | 2 +- docs/core/sidenav-layout.component.md | 4 ++- docs/core/text-mask.component.md | 2 +- docs/core/upload.directive.md | 2 +- docs/core/user-preferences.service.md | 6 ++-- .../process-services/attach-form.component.md | 4 +-- .../components/header/header.component.ts | 21 +++++++++++++- .../dynamic-component-mapper.service.ts | 4 +-- tools/doc/doctool.config.json | 2 ++ 27 files changed, 119 insertions(+), 88 deletions(-) diff --git a/docs/content-services/content-action.component.md b/docs/content-services/content-action.component.md index 79067631f9..693434b69f 100644 --- a/docs/content-services/content-action.component.md +++ b/docs/content-services/content-action.component.md @@ -1,7 +1,7 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-06-08 +Last reviewed: 2018-11-20 --- # Content Action component @@ -104,7 +104,7 @@ export class MyView { ## Details The document actions are rendered on a dropdown menu for each items of content. You can use the -`target` property to choose whether the action applies to folders, documents or both. (By default the actions are applied to both) +`target` property to choose whether the action applies to folders, documents or both. (By default the actions are applied to both). A number of built-in actions are defined to handle common use cases: @@ -161,7 +161,7 @@ type, and other details of the item just deleted: #### System handler -This action simply execute one of the built-in actions described above: +This action simply executes one of the built-in actions described above: ```html @@ -212,7 +212,7 @@ If you specify both a system handler and your own custom handler with `(execute)="myCustomActionAfterDelete($event)"`, your handler will run after the system handler completes successfully. A system operation is considered successful if there are no permission or network-related errors for the system request. You can avoid permission errors simply -by disablingan item for users who don't have permission to use it (set `disableWithNoPermission="true"`). +by disabling an item for users who don't have permission to use it (set `disableWithNoPermission="true"`). ```html @@ -366,7 +366,7 @@ The code above checks the node name and evaluates to `true` only if the correspo node is called "For Sale.docx". Note that if you want to preserve `this` context within the evaluator function then -the property should be declared as a lambda function: +you should declare it as a lambda function: ```ts funcName = (parameters): boolean => { @@ -377,10 +377,10 @@ funcName = (parameters): boolean => { ### Conditional disabled state -Similar to `visible` property, it is possible to control the `disabled` state with the following scenarios: +As with the `visible` property, you can control the `disabled` state with the following options: - direct value of `boolean` type -- binding to a property of the `Function` type that evaluates condition and returns `boolean` value +- binding to a property of the `Function` type that evaluates a condition and returns a `boolean` value #### Using direct value of boolean type @@ -418,10 +418,10 @@ export class MyComponent { } ``` -Code above checks the node name, and evaluates to `true` only if corresponding node is called "custom". +The code above checks the node name, and evaluates to `true` only if the corresponding node is called "custom". -Please note that if you want to preserve `this` context within the evaluator function, -its property should be declared as a lambda one: +Note that if you want to preserve the `this` context within the evaluator function, +you should declare it as a lambda function: ```ts funcName = (parameters): boolean => { @@ -440,11 +440,11 @@ for details and examples. ### Error, Permission and Success callbacks -Defining error, permission and success callbacks are pretty much the same as doing it for the delete permission handling. +You can define error, permission and success callbacks in much the same way as for the delete permission handling. -- The error handler callback gets the error object which was raised -- The success callback's only parameter is the translatable success message string (could be used for showing in snackbar for example) -- The permissionEvent callback is the same as described above with the delete action +- The error handler callback gets the error object that was raised +- The success callback's only parameter is the translatable success message string (which could be shown in a snackbar, for example) +- The `permissionEvent` callback is the same as described above for the delete action ![Copy/move document action](../docassets/images/document-action-copymove.png) diff --git a/docs/content-services/file-uploading-dialog.component.md b/docs/content-services/file-uploading-dialog.component.md index 46e3377592..ef29808885 100644 --- a/docs/content-services/file-uploading-dialog.component.md +++ b/docs/content-services/file-uploading-dialog.component.md @@ -1,7 +1,7 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-05-08 +Last reviewed: 2018-11-20 --- # File Uploading Dialog Component diff --git a/docs/content-services/folder-create.directive.md b/docs/content-services/folder-create.directive.md index cf2b686c95..adcec824b1 100644 --- a/docs/content-services/folder-create.directive.md +++ b/docs/content-services/folder-create.directive.md @@ -1,7 +1,7 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-05-03 +Last reviewed: 2018-11-20 --- # Folder Create directive diff --git a/docs/content-services/inherited-button.directive.md b/docs/content-services/inherited-button.directive.md index 22c770ed50..1ecc5c7735 100644 --- a/docs/content-services/inherited-button.directive.md +++ b/docs/content-services/inherited-button.directive.md @@ -1,7 +1,7 @@ --- Added: v2.3.0 Status: Active -Last reviewed: 2018-09-13 +Last reviewed: 2018-11-20 --- # Inherit Permission directive diff --git a/docs/content-services/node-download.directive.md b/docs/content-services/node-download.directive.md index ece7a3e39b..1c5d4fe2fd 100644 --- a/docs/content-services/node-download.directive.md +++ b/docs/content-services/node-download.directive.md @@ -1,7 +1,7 @@ --- Added: v2.2.0 Status: Active -Last reviewed: 2018-04-10 +Last reviewed: 2018-11-20 --- # Node Download directive diff --git a/docs/content-services/node-lock.directive.md b/docs/content-services/node-lock.directive.md index 0dac91d482..ea0e08dcf6 100644 --- a/docs/content-services/node-lock.directive.md +++ b/docs/content-services/node-lock.directive.md @@ -1,7 +1,7 @@ --- Added: v2.2.0 Status: Active -Last reviewed: 2018-04-10 +Last reviewed: 2018-11-20 --- # Node Lock directive @@ -26,15 +26,18 @@ Locks a node. ## Details -When the decorated element (eg, div) is clicked, a dialog is shown to let you lock +When the user clicks the decorated element (eg, div), a dialog is shown to let them lock or unlock a file (a folder cannot be locked). -There are two types of lock: indefinite lock and time lock. -If the time is not selected the user will lock the file it until will not unlock it -When a file is locked it can be locked and unlocked by default only by the user that creates the lock but you can also allow the other file owners to modify it +There are two types of lock that the user can choose from the dialog: indefinite lock and time lock. The time lock will expire at the specified time +but the indefinite lock remains in place until the user cancels it. + +When a file is locked it can be locked and unlocked by default only by the user that creates the lock but you can also allow the other file owners to modify it: + ![adf-lock](../docassets/images/lock-directive.png) -This calls the `openLockNodeDialog` method from the -[Content Node Dialog service](content-node-dialog.service.md) method when clicked, -and disables the target button if the provided node is not a file or the user doesn't +This directive calls the `openLockNodeDialog` method from the +[Content Node Dialog service](content-node-dialog.service.md) +when clicked. +It disables the target button if the provided node is not a file or the user doesn't have permissions. diff --git a/docs/content-services/permission-list.component.md b/docs/content-services/permission-list.component.md index 8d59d96aab..4e721fc70b 100644 --- a/docs/content-services/permission-list.component.md +++ b/docs/content-services/permission-list.component.md @@ -1,7 +1,7 @@ --- Added: v2.3.0 Status: Active -Last reviewed: 2018-09-13 +Last reviewed: 2018-11-20 --- # Permission List Component diff --git a/docs/core/card-item-types.service.md b/docs/core/card-item-types.service.md index 63b71b8787..616b0e4aab 100644 --- a/docs/core/card-item-types.service.md +++ b/docs/core/card-item-types.service.md @@ -1,7 +1,7 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-05-08 +Last reviewed: 2018-11-20 --- # Card Item Type service @@ -13,7 +13,7 @@ Maps type names to field component types for the [Card View component](../core/c ### Methods - **getComponentTypeResolver**(type: `string`, defaultValue: `Type<__type>` = `this.defaultValue`): `DynamicComponentResolveFunction`
- Gets the currently active ComponentTypeResolver function for a field type. + Gets the currently active DynamicComponentResolveFunction 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 - **Returns** `DynamicComponentResolveFunction` - Resolver function @@ -23,7 +23,7 @@ Maps type names to field component types for the [Card View component](../core/c - _defaultValue:_ `Type<__type>` - Default type returned for field types that are not yet mapped. - **Returns** `Type<__type>` - Component type - **setComponentTypeResolver**(type: `string`, resolver: `DynamicComponentResolveFunction`, override: `boolean` = `true`)
- Sets or optionally replaces a ComponentTypeResolver function for a field type. + Sets or optionally replaces a DynamicComponentResolveFunction for a field type. - _type:_ `string` - The type whose resolver you want to set - _resolver:_ `DynamicComponentResolveFunction` - The new resolver function - _override:_ `boolean` - The new resolver will only replace an existing one if this parameter is true @@ -32,7 +32,7 @@ Maps type names to field component types for the [Card View component](../core/c The [Card View component](card-view.component.md) uses this service to find the component type that is required to display a particular field type (text, date, etc). The service -maps a type name string to a corresponding `ComponentTypeResolver` function that takes a +maps a type name string to a corresponding `DynamicComponentResolveFunction` that takes a model object as a parameter and returns the component type needed to display that model. The default mapping is shown below: diff --git a/docs/core/context-menu.directive.md b/docs/core/context-menu.directive.md index 6559d64361..8a56a949da 100644 --- a/docs/core/context-menu.directive.md +++ b/docs/core/context-menu.directive.md @@ -1,7 +1,7 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-04-10 +Last reviewed: 2018-11-20 --- # Context Menu directive @@ -53,4 +53,5 @@ export class MyComponent implements OnInit { ## Details -See **Demo Shell** or **DocumentList** implementation for more details and use cases. +See the [Demo Shell](../../demo-shell/README.md) +or [Document List component](../content-services/document-list.component.md) implementation for more details and use cases. diff --git a/docs/core/form-field.component.md b/docs/core/form-field.component.md index c1954c3089..14ade81e17 100644 --- a/docs/core/form-field.component.md +++ b/docs/core/form-field.component.md @@ -1,12 +1,12 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-05-08 +Last reviewed: 2018-11-20 --- # Form field component -A form field in an APS form. +Represents a UI field in a form. ## Basic Usage @@ -26,7 +26,7 @@ based on the field type or the metadata information. | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| field | [`FormFieldModel`](../core/form-field.model.md) | null | Contains all the necessary data needed to determine what UI Widget 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`](../core/form-field.model.md) definitions. | +| field | [`FormFieldModel`](../core/form-field.model.md) | null | Contains all the necessary data needed to determine what UI [`Widget`](../../e2e/pages/adf/process_services/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 @@ -37,8 +37,8 @@ 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/task-list/models/form.model.ts) Designer Widget | Field Type | Component Type | -| --------------------------------------------------------------------------------------- | ---------- | -------------- | +| _APS [Form](../../lib/process-services/task-list/models/form.model.ts) Designer_ [`Widget`](../../e2e/pages/adf/process_services/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) | @@ -54,7 +54,7 @@ Forms defined in APS have the following default mappings for the form fields: | 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 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/form-list.component.md b/docs/core/form-list.component.md index 79c9d56526..9c8910ce44 100644 --- a/docs/core/form-list.component.md +++ b/docs/core/form-list.component.md @@ -1,11 +1,12 @@ --- Added: v2.0.0 Status: Active +Last reviewed: 2018-11-20 --- # Form List Component -Shows APS forms as a list. +Shows forms as a list. ## Basic Usage diff --git a/docs/core/form-rendering.service.md b/docs/core/form-rendering.service.md index 04ae77e32a..93653de27f 100644 --- a/docs/core/form-rendering.service.md +++ b/docs/core/form-rendering.service.md @@ -1,19 +1,19 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-05-08 +Last reviewed: 2018-11-20 --- # Form Rendering service -Maps an APS form field type string onto the corresponding form [widget component](../insights/widget.component.md) type. +Maps a form field type string onto the corresponding form [widget component](../insights/widget.component.md) type. ## Class members ### Methods - **getComponentTypeResolver**(type: `string`, defaultValue: `Type<__type>` = `this.defaultValue`): `DynamicComponentResolveFunction`
- Gets the currently active ComponentTypeResolver function for a field type. + Gets the currently active DynamicComponentResolveFunction 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 - **Returns** `DynamicComponentResolveFunction` - Resolver function @@ -23,32 +23,32 @@ Maps an APS form field type string onto the corresponding form [widget component - _defaultValue:_ `Type<__type>` - Default type returned for field types that are not yet mapped. - **Returns** `Type<__type>` - Component type - **setComponentTypeResolver**(type: `string`, resolver: `DynamicComponentResolveFunction`, override: `boolean` = `true`)
- Sets or optionally replaces a ComponentTypeResolver function for a field type. + Sets or optionally replaces a DynamicComponentResolveFunction for a field type. - _type:_ `string` - The type whose resolver you want to set - _resolver:_ `DynamicComponentResolveFunction` - The new resolver function - _override:_ `boolean` - The new resolver will only replace an existing one if this parameter is true ## Details -The [`Form`](../../lib/process-services/task-list/models/form.model.ts) Field component uses this service to choose which widget to use to render an instance of a +The [`Form`](../../lib/process-services/task-list/models/form.model.ts) Field component uses this service to choose which [widget](../../e2e/pages/adf/process_services/widgets/widget.ts) to use to render an instance of a form field. The [`Form`](../../lib/process-services/task-list/models/form.model.ts) Field model stores the field type name as a string (see the table below). The [`Form`](../../lib/process-services/task-list/models/form.model.ts) Rendering service maintains a mapping between each type name and -a corresponding ComponentTypeResolver function. The function takes a [`FormFieldModel`](../core/form-field.model.md) object as its argument and -uses the data from the object to determine which widget should be used to render the field. +a corresponding `DynamicComponentResolveFunction`. The function takes a [`FormFieldModel`](../core/form-field.model.md) object as its argument and +uses the data from the object to determine which [widget](../../e2e/pages/adf/process_services/widgets/widget.ts) should be used to render the field. -In some cases, the field type string alone is enough to determine the widget type and so the function +In some cases, the field type string alone is enough to determine the [widget](../../e2e/pages/adf/process_services/widgets/widget.ts) type and so the function just returns the type directly: ```ts -let customResolver: ComponentTypeResolver = () => CustomWidgetComponent; +let customResolver: DynamicComponentResolveFunction = () => CustomWidgetComponent; formRenderingService.setComponentTypeResolver('text', customResolver, true); ``` -In other cases, the function may need to choose the widget dynamically based on +In other cases, the function may need to choose the [widget](../../e2e/pages/adf/process_services/widgets/widget.ts) dynamically based on specific values in the form data: ```ts -let customResolver: ComponentTypeResolver = (field: FormFieldModel): Type<{}> => { +let customResolver: DynamicComponentResolveFunction = (field: FormFieldModel): Type<{}> => { if (field) { let params = field.params; } @@ -94,7 +94,7 @@ if you set the `override` parameter to 'true': formRenderingService.setComponentTypeResolver('text', newResolver, true); ``` -You would typically use this to replace an existing widget with your own custom version that +You would typically use this to replace an existing [widget](../../e2e/pages/adf/process_services/widgets/widget.ts) with your own custom version that implements a modified layout or responds differently when the data is entered. See the [Form Extensibility and Customisation](../user-guide/extensibility.md) guide for further details and examples of this technique. diff --git a/docs/core/header.component.md b/docs/core/header.component.md index 79b80ac2e2..c2972ca492 100644 --- a/docs/core/header.component.md +++ b/docs/core/header.component.md @@ -1,10 +1,10 @@ --- Added: v2.5.0 -Status: Experimental -Last reviewed: 2018-08-07 +Status: Active +Last reviewed: 2018-11-20 --- -# Header component +# Header component Reusable header for Alfresco applications. @@ -31,26 +31,25 @@ body of the element: ``` - ## Class members ### Properties -| Name | Type | Description | -| -- | -- | -- | -| title | `string` | Title of the application -| logo | `string` | Path to an image file for the application logo. -| redirectUrl | `string` \| `any[]` | The router link for the application logo. -| tooltip | `string` | The tooltip text for the application logo. -| color | `string` | Background color for the header. It can be any hex color code or the Material theme colors: 'primary', 'accent' or 'warn'. -| showSidenavToggle | `boolean` | Signals if the sidenav button will be displayed in the header or not. By default is true. -| position | `string` | 'start' | The side that the drawer is attached to 'start' or 'end' page | +| 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'. | +| 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 | -| -- | -- | -- | -| clicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when click on sidenav button +| ---- | ---- | ----------- | +| clicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the sidenav button is clicked. | ## Details diff --git a/docs/core/highlight.directive.md b/docs/core/highlight.directive.md index 2714c470c8..64022cd7e1 100644 --- a/docs/core/highlight.directive.md +++ b/docs/core/highlight.directive.md @@ -1,7 +1,7 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-04-10 +Last reviewed: 2018-11-20 --- # Highlight directive @@ -43,7 +43,7 @@ of that term in its content. For example: ``` -...will result in the word "dance" being highlighted. Note that you must also +This will result in the word "dance" being highlighted. Note that you must also specify `adf-highlight-selector`, a CSS selector that specifies which elements can have their contents highlighted. diff --git a/docs/core/node-delete.directive.md b/docs/core/node-delete.directive.md index fb0e8bda87..af8b222959 100644 --- a/docs/core/node-delete.directive.md +++ b/docs/core/node-delete.directive.md @@ -1,7 +1,7 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-04-10 +Last reviewed: 2018-11-20 --- # Node Delete directive diff --git a/docs/core/node-permission.directive.md b/docs/core/node-permission.directive.md index a6883a57b3..3683c21b22 100644 --- a/docs/core/node-permission.directive.md +++ b/docs/core/node-permission.directive.md @@ -1,12 +1,12 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-04-10 +Last reviewed: 2018-11-20 --- # Node Permission directive -Selectively disables an HTML element or Angular component +Selectively disables an HTML element or Angular component. ## Contents @@ -95,7 +95,9 @@ for example). You can also use it in much the same way as you would with an HTML ``` To enable your own component to work with this directive, you need to implement the -[`NodePermissionSubject`](../../lib/core/directives/node-permission.directive.ts) interface and also define it as an EXTENDIBLE_COMPONENT parent component, +[`NodePermissionSubject`](../../lib/core/directives/node-permission.directive.ts) interface and also define it as an +[`EXTENDIBLE_COMPONENT`](../../lib/core/interface/injection.tokens.ts) +parent component, as described in the following sections. ### Implementing the NodePermissionSubject interface @@ -118,7 +120,9 @@ The directive will look up the component in the dependency injection tree, up to the `@Host()` component. The host component is typically the component that requests the dependency. However, when this component is projected into a parent component, the parent becomes the host. This means you must provide your component with forward referencing -as the `EXTENDIBLE_COMPONENT` and also provide your component as a `viewProvider`: +as the +[`EXTENDIBLE_COMPONENT`](../../lib/core/interface/injection.tokens.ts) +and also provide your component as a `viewProvider`: ```js import { EXTENDIBLE_COMPONENT } from '@alfresco/adf-core'; diff --git a/docs/core/node.service.md b/docs/core/node.service.md index c12c882f22..1ce18e66f3 100644 --- a/docs/core/node.service.md +++ b/docs/core/node.service.md @@ -1,7 +1,7 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-09-13 +Last reviewed: 2018-11-20 --- # Node Service diff --git a/docs/core/pagination.component.md b/docs/core/pagination.component.md index f0ce74792b..3a52ef9953 100644 --- a/docs/core/pagination.component.md +++ b/docs/core/pagination.component.md @@ -1,7 +1,7 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-04-16 +Last reviewed: 2018-11-20 --- # Pagination Component diff --git a/docs/core/sidebar-action-menu.component.md b/docs/core/sidebar-action-menu.component.md index 9a448a4352..9db9718c27 100644 --- a/docs/core/sidebar-action-menu.component.md +++ b/docs/core/sidebar-action-menu.component.md @@ -1,7 +1,7 @@ --- Added: v2.1.0 Status: Active -Last reviewed: 2018-09-14 +Last reviewed: 2018-11-20 --- # Sidebar action menu component diff --git a/docs/core/sidenav-layout.component.md b/docs/core/sidenav-layout.component.md index bbcb960ca5..17d4ed0bcd 100644 --- a/docs/core/sidenav-layout.component.md +++ b/docs/core/sidenav-layout.component.md @@ -1,7 +1,7 @@ --- Added: v2.3.0 Status: Active -Last reviewed: 2018-09-14 +Last reviewed: 2018-11-20 --- # Sidenav Layout component @@ -102,9 +102,11 @@ The contents of the 3 regions can be injected through Angular's template transcl in the usage example above. Desktop layout (screen width greater than the `stepOver` value): + ![Sidenav on desktop](../docassets/images/sidenav-layout.png) Mobile layout (screen width less than the `stepOver` value): + ![Sidenav on mobile](../docassets/images/sidenav-layout-mobile.png) ### Template context diff --git a/docs/core/text-mask.component.md b/docs/core/text-mask.component.md index 994aa015c5..4387c76544 100644 --- a/docs/core/text-mask.component.md +++ b/docs/core/text-mask.component.md @@ -1,7 +1,7 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-04-10 +Last reviewed: 2018-11-20 --- # Text Mask directive diff --git a/docs/core/upload.directive.md b/docs/core/upload.directive.md index 251851a090..ec3c5bec47 100644 --- a/docs/core/upload.directive.md +++ b/docs/core/upload.directive.md @@ -1,7 +1,7 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-04-10 +Last reviewed: 2018-11-20 --- # Upload Directive diff --git a/docs/core/user-preferences.service.md b/docs/core/user-preferences.service.md index 10149e3ae3..b7dd7da29a 100644 --- a/docs/core/user-preferences.service.md +++ b/docs/core/user-preferences.service.md @@ -1,12 +1,12 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-09-14 +Last reviewed: 2018-11-20 --- # User Preferences Service -Stores preferences for components. +Stores preferences for the app and for individual components. ## Class members @@ -99,7 +99,7 @@ The service also provides quick access to a set of the "known" properties used a ## User Preference onChange Stream -Whenever a property is set with the user preference service, an `onChange` event is sent with the +Whenever a property is set with the [user preferences service,](../core/user-preferences.service.md) an `onChange` event is sent with the whole set of user properties. This is useful when a component needs to react to a property change: ```ts diff --git a/docs/process-services/attach-form.component.md b/docs/process-services/attach-form.component.md index 86a64e499f..483215da96 100644 --- a/docs/process-services/attach-form.component.md +++ b/docs/process-services/attach-form.component.md @@ -1,12 +1,12 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-09-14 +Last reviewed: 2018-11-20 --- # Attach Form component -This component can be used when there is no form attached to a task and we want to add one. +This component can be used when there is no form attached to a task and you want to add one. ## Basic Usage diff --git a/lib/core/layout/components/header/header.component.ts b/lib/core/layout/components/header/header.component.ts index 027e57aaf8..7a2ed3e5d4 100644 --- a/lib/core/layout/components/header/header.component.ts +++ b/lib/core/layout/components/header/header.component.ts @@ -24,15 +24,34 @@ import { Component, Input, Output, EventEmitter, ViewEncapsulation, OnInit } fro host: { class: 'adf-layout-header' } }) export class HeaderLayoutComponent implements OnInit { + /** Title of the application. */ @Input() title: string; + + /** Path to an image file for the application logo. */ @Input() logo: string; + + /** The router link for the application logo, when clicked. */ @Input() redirectUrl: string | any[] = '/'; + + /** The tooltip text for the application logo. */ @Input() tooltip: string; + + /** + * Background color for the header. It can be any hex color code or one + * of the Material theme colors: 'primary', 'accent' or 'warn'. + */ @Input() color: string; + + /** + * Toggles whether the sidenav button will be displayed in the header + * or not. + */ @Input() showSidenavToggle: boolean = true; + + /** Emitted when the sidenav button is clicked. */ @Output() clicked = new EventEmitter(); - /** The side that the drawer is attached to 'start' | 'end' page */ + /** The side of the page that the drawer is attached to (can be 'start' or 'end') */ @Input() position = 'start'; toggleMenu() { diff --git a/lib/core/services/dynamic-component-mapper.service.ts b/lib/core/services/dynamic-component-mapper.service.ts index b8c038ad4c..717dbe5ad4 100644 --- a/lib/core/services/dynamic-component-mapper.service.ts +++ b/lib/core/services/dynamic-component-mapper.service.ts @@ -32,7 +32,7 @@ export abstract class DynamicComponentMapper { protected types: { [key: string]: DynamicComponentResolveFunction } = {}; /** - * Gets the currently active ComponentTypeResolver function for a field type. + * Gets the currently active DynamicComponentResolveFunction for a field type. * @param type The type whose resolver you want * @param defaultValue Default type returned for types that are not yet mapped * @returns Resolver function @@ -45,7 +45,7 @@ export abstract class DynamicComponentMapper { } /** - * Sets or optionally replaces a ComponentTypeResolver function for a field type. + * Sets or optionally replaces a DynamicComponentResolveFunction for a field type. * @param type The type whose resolver you want to set * @param resolver The new resolver function * @param override The new resolver will only replace an existing one if this parameter is true diff --git a/tools/doc/doctool.config.json b/tools/doc/doctool.config.json index f003dfc3f3..9d0e6489de 100644 --- a/tools/doc/doctool.config.json +++ b/tools/doc/doctool.config.json @@ -51,11 +51,13 @@ "UserRepresentation": "https://github.com/Alfresco/alfresco-js-api/blob/development/src/alfresco-activiti-rest-api/docs/UserRepresentation.md" }, "typeNameExceptions": { + "content.widget": "ContentWidgetComponent", "datatable.component": "DataTableComponent", "tasklist.service": "TaskListService", "text-mask.component": "InputMaskDirective", "card-item-types.service": "CardItemTypeService", "create-task-attachment.component": "AttachmentComponent", + "header.component": "HeaderLayoutComponent", "process-list.component": "ProcessInstanceListComponent", "inherited-button.directive": "InheritPermissionDirective", "node-share.directive": "NodeSharedDirective",