inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-3745] Fixed broken links in docs (#4141)

Browse Source 
* [ADF-3745] Updated broken links

* [ADF-3745] Fixed glitches in release notes

* [ADF-3745] Removed unwanted type links
This commit is contained in:
Andy Stark
2019-01-12 23:10:31 +00:00
committed by Eugenio Romano
parent b32654b236
commit a416cbab82
17 changed files with 766 additions and 766 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/core/form-field.component.md
View File

@@ -27,7 +27,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`](../../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. |
| 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` definitions. |
## Details
@@ -38,7 +38,7 @@ uses `<adf-form-field>` 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`](../../e2e/pages/adf/process_services/widgets/widget.ts) | Field Type | Component Type |
| _APS Form Designer_ Widget | 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) |

10
docs/core/form-rendering.service.md
View File

@@ -31,13 +31,13 @@ Maps a form field type string onto the corresponding form [widget component](../
## Details
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
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
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 `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.
uses the data from the object to determine which widget should be used to render the field.
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
In some cases, the field type string alone is enough to determine the widget type and so the function
just returns the type directly:
```ts
@@ -45,7 +45,7 @@ let customResolver: DynamicComponentResolveFunction = () => CustomWidgetComponen
formRenderingService.setComponentTypeResolver('text', customResolver, true);
```
In other cases, the function may need to choose the [widget](../../e2e/pages/adf/process_services/widgets/widget.ts) dynamically based on
In other cases, the function may need to choose the widget dynamically based on
specific values in the form data:
```ts
@@ -95,7 +95,7 @@ if you set the `override` parameter to 'true':
formRenderingService.setComponentTypeResolver('text', newResolver, true);
```
You would typically use this to replace an existing [widget](../../e2e/pages/adf/process_services/widgets/widget.ts) with your own custom version that
You would typically use this to replace an existing widget 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.

4
docs/core/form.component.md
View File

@@ -278,7 +278,7 @@ could use this, say, to provide two alternative ways of entering the same inform
up default values that can be edited.
You can implement this in ADF using the `formFieldValueChanged` event of the
[Form service](form.service.md). For example, if you had a form with a [dropdown widget](../../e2e/pages/adf/process_services/widgets/dropdownWidget.ts) (id: `type`)
[Form service](form.service.md). For example, if you had a form with a dropdown widget (id: `type`)
and a multiline text (id:`description`), you could synchronize their values as follows:
```ts
@@ -295,7 +295,7 @@ formService.formFieldValueChanged.subscribe((e: FormFieldEvent) => {
```
The code shown above subscribes to the `formFieldValueChanged` event to check whether an event
is emitted for the `type` [widget](../../e2e/pages/adf/process_services/widgets/widget.ts). Then it finds the `description` [widget](../../e2e/pages/adf/process_services/widgets/widget.ts) and assigns some text
is emitted for the `type` widget. Then it finds the `description` widget and assigns some text
to its `value` property.
The result should look like the following: