Magnolia 6.1 reached end of life on March 31, 2021. This branch is no longer supported, see End-of-life policy.
LinkFieldDefinition renders a text field and a browse button that allows the user to select an item from a configured app. The link field is used to select targets inside Magnolia, for example a page to tease, an asset to render an image, etc.. The link field stores a reference to the selected item.
The link field allows you to choose items from any content app, including non-JCR apps.
class: info.magnolia.ui.form.field.definition.LinkFieldDefinition
fieldType: link
The central property when defining a link field is appName
- the name of the Magnolia app to choose the item from. The target app is responsible for providing a view that is suitable for selecting the item. When the target app is a content app, the workbench in the browser subapp is a suitable view and it is used by default. For more complex apps like the Assets app, a choose dialog is configured in the app to browse the contents.
Simple link field definition
form: tabs: - name: tabImage label: Image fields: - name: image fieldType: link targetWorkspace: dam appName: assets label: Select image identifierToPathConverter: class: info.magnolia.dam.app.assets.field.translator.AssetCompositeIdKeyTranslator contentPreviewDefinition: contentPreviewClass: info.magnolia.dam.app.ui.field.DamFilePreviewComponent
Node name | Value |
---|---|
form | |
tabs | |
tabImage | |
fields | |
image | |
identifierToPathConverter | |
class | info.magnolia.dam.app.assets.field.translator.AssetCompositeIdKeyTranslator |
contentPreviewDefinition | |
contentPreviewClass | info.magnolia.dam.app.ui.field.DamFilePreviewComponent |
appName | contacts |
fieldType | link |
targetWorkspace | dam |
label | Select image |
label | Image |
Field-specific properties:
<field name> | Name of field. | ||||||||||
| required Target app name used to create the content view to choose the item from. All content apps provide a workbench. The workbench view is used as the link target chooser by default. However, you can also provide a choose dialog and provide custom actions. See an example in | ||||||||||
| optional, default is Button label before the target node is selected. The value is i18n-able. | ||||||||||
| optional, default is Button label after the target node is selected. The value is i18n-able. | ||||||||||
| optional Render a preview of the selected content. The preview component typically displays an image thumbnail and some metadata. | ||||||||||
| optional Any class that implements the ContentPreviewComponent interface. Examples:
| ||||||||||
| optional, default is Makes the text box displaying the link editable once a target has been selected. | ||||||||||
| optional The link field returns the path of the selected node by default. You can convert the path to a UUID with a converter. | ||||||||||
| optional Any class that implements the IdentifierToPathConverter interface. Examples:
| ||||||||||
| optional, default is Path in the workspace that browsing is limited to. The user can start browsing at this path but they cannot navigate to nodes above or at the same level as the target path. Use this property to restrict selecting of items to a particular folder. | ||||||||||
| optional, default is Name of the workspace in which the target content is stored if the content app is JCR based. Examples:
|
or
| required Defines the field type via either a field alias name or a fully-qualified field definition class name. See Field definition: Field types. To check the correct form of the name, use the Definitions app. |
type | required, default is Model type of the field. Use the fully qualified class name. See PropertyType for possible values. A default type is typically hard-coded in each definition class. You only need to add this property if you want to override the default implementation (for example, with |
defaultValue | optional Pre-filled default value displayed in the field. The value can be overwritten by the user. Use alphanumeric characters.
|
description | optional Help text displayed when the user clicks the help icon. The value can be literal or retrieved from the message bundle with a key. Use alphanumeric characters in literal values. Not applicable to the static field. |
i18n | optional, default is Enables i18n authoring support which allows editors to write foreign-language or regionally targeted content. A two-letter language identifier (en, de, fr etc.) is displayed on controls where |
i18nBasename | optional, default is the message bundle defined in the dialog definition Message bundle such as |
label | optional Field label displayed to editors. The value can be literal such as If you don't provide the property then Magnolia falls back to a generated i18n key and displays they key in the UI. If you don't want a label at all then define the property and set its value to empty space such as |
name | optional, default is the name of the field's parent node Name of the node where the value is saved. The name |
placeholder | optional The placeholder text to be displayed in the empty field. The property replaces the deprecated placeholder text field.
The field is optional, but you should provide a translation or a hard-coded label, otherwise the empty field will display its auto-generated 18n key instead. |
readOnly | optional, default is Makes the field uneditable. Adding this property has the same effect as creating a static field. |
required | optional, default is Makes the field required (mandatory). An asterisk is displayed next to the field label. See also Checking for null values. |
requiredErrorMessage | optional, default is Error message displayed when required is true and the user saves an empty field. The value can be literal or retrieved from the message bundle with a key such as |
styleName | optional Adds one or more style names to this component. Multiple styles can be specified as a space-separated list of style names such as |
transformerClass | optional Property transformer classes define how field values are stored in the repository. Each field has a default transformer class. You don't need to define a class unless you want to override the default. The value is a fully-qualified class name.
|
The link field also allows you to choose items from non-JCR apps.
To understand the process when choosing an item from a content app via link field, basic knowledge of the Content app framework and the nature of LinkField is necessary.
Things to note about LinkField:
#onItemChosen(actionName, chosenValue)
is triggered on the callback. The parameter choosenValue is of type Object
and is the corresponding ItemId of the item of the content app. (See ItemIds and Items). Depending on the implementation of the content app, the ItemId may be a String or a more complex Object. A well-known ItemId is JcrItemId . The callback properly handles JcrItemId, and if it is another type, String.valueOf(chosenValue) is saved to the link field.When using LinkField with JCR-agnostic target apps that use complex ItemIds that extend Object
, override the public String toString()
method on the implementation of the itemId.
If LinkField does not work for your custom content app, create a custom link field. See Custom fields for more.