inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2026-09-09 18:03:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-2152] Added See Also sections and updated doc tools (#2835)

Browse Source 
* [ADF-2152] Added See Also sections to docs

* [ADF-2152] Added doc script to package.json
This commit is contained in:
Andy Stark
2018-01-16 17:43:10 +00:00
committed by Eugenio Romano
parent f4684f68be
commit 7a523961e2
16 changed files with 275 additions and 302 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/form-field.component.md
+7 -6
View File
@@ -1,7 +1,9 @@
# Form field component
A form field in an APS form.
## Basic Usage
All form field editors (aka widgets) on a Form are rendered by means of a `FormFieldComponent`
that takes an instance of a `FormFieldModel`:
@@ -13,20 +15,23 @@ This component depends on the `FormRenderingService` to map the `FormFieldModel`
based on the field type or the metadata information.
### Properties
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------- | ----------- |
| field | FormFieldModel | | 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
You would typically not use this component directly but instead use the `<adf-form>` component, which under the hood
uses `<adf-form-field>` components to render the form fields. See next section for how each field in a form definition
is mapped to a form field component (i.e. UI widget) implementation.
### Field Type -> Form Field Component mappings
Forms defined in APS have the following default mappings for the form fields:
| APS Form Designer Widget | Field Type | Component Type |
| --- | --- | --- |
| ------------------------ | ---------- | -------------- |
| Text | text | TextWidgetComponent |
| Multi-line text | multi-line-text | MultilineTextWidgetComponentComponent |
| Number | integer | NumberWidgetComponent |
@@ -46,7 +51,3 @@ Forms defined in APS have the following default mappings for the form fields:
| Display text | readonly-text | DisplayTextWidgetComponentComponent |
| N/A | container | ContainerWidgetComponent (layout component) |
| N/A | N/A | UnknownWidgetComponent |
<!-- seealso start -->
<!-- seealso end -->