Versions Compared

Old Version 3

changes.mady.by.user Ashraf Khamis

Saved on

compared with

New Version 4

changes.mady.by.user Ashraf Khamis

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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. 

Table of Contents

Link field properties

...

<field name>Name of field.

appName

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 /modules/dam/apps/assets/chooseDialog .

buttonSelectNewLabel

optional, default is Select new...

Button label before the target node is selected. The value is i18n-able.

buttonSelectOtherLabel

optional, default is Select another...

Button label after the target node is selected. The value is i18n-able.

contentPreviewDefinition

optional

Render a preview of the selected content. The preview component typically displays an image thumbnail and some metadata.  

contentPreviewClass

optional

Any class that implements the

Javadoc resource link
rangeHigherVersion6.0
classNameinfo.magnolia.ui.form.field.component.ContentPreviewComponent
renderTypeasynchronous
interface. Examples:

  • info.magnolia.contacts.app.field.component.ContactPreviewComponent displays a contact thumbnail and information.

  • info.magnolia.dam.app.ui.field.DamFilePreviewComponent. Displays an asset thumbnail and related information.

fieldEditable

optional, default is true

Makes the text box displaying the link editable once a target has been selected.

identifierToPathConverter

optional

The link field returns the path of the selected node by default. You can convert the path to a UUID with a converter. 

class

optional

Any class that implements the

Javadoc resource link
rangeHigherVersion6.0
classNameinfo.magnolia.ui.form.field.converter.IdentifierToPathConverter
renderTypeasynchronous
interface. Examples:

  • info.magnolia.ui.form.field.converter.BaseIdentifierToPathConverter

  • info.magnolia.dam.app.assets.field.translator.AssetCompositeIdKeyTranslator converts an asset composite ID key to a path.

targetTreeRootPath

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.

targetWorkspace

optional, default is website

Name of the workspace in which the target content is stored if the content app is JCR based. Examples:

appNametargetWorkspace
pageswebsite
assetsdam
contactscontacts
categoriescategory

Common field properties:

Include Page
_Common field properties
_Common field properties

...

If LinkField does not work for your custom content app, create a custom link field. See Custom fields for more.