Uploaded image for project: 'Magnolia UI'
  1. Magnolia UI
  2. MGNLUI-5098

DOC: previewDefinition property of JcrDatasourceDefinition

    XMLWordPrintable

Details

    • Task
    • Resolution: Done
    • Neutral
    • None
    • None
    • None

    Description

      Context

      This is a follow-up of MGNLUI-4989

      The previewDefinition can be seen as the successor of the Image provider definition.
      It is defined as a property of the JCR data source definition.

      The property previewDefinition currently must be of the type info.magnolia.ui.contentapp.preview.JcrPreviewDefinition.

      Example 

      of a JCR data source definition with a previewDefinition:

      datasource:
        class: info.magnolia.ui.datasource.jcr.JcrDatasourceDefinition
        workspace: contacts
        includeProperties: true
        previewDefinition:
          nodeName: photo
        allowedNodeTypes:
          - mgnl:contact
          - mgnl:folder
      

      Depending on the size of the documentation for the preview definition,
      we could add the previewDefinition part to the already existing page JCR data source definition or we create a distinct page (as we already have it for the Image provider definition).

      For the properties table, see https://git.magnolia-cms.com/projects/PLATFORM/repos/ui/browse/magnolia-ui-framework-jcr/src/main/java/info/magnolia/ui/contentapp/preview/JcrPreviewDefinition.java.

      Checklists

        Acceptance criteria

        Attachments

          Issue Links

            Activity

              People

                akhamis Ashraf Khamis
                cmeier Christoph Meier
                Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved:

                  Checklists

                    Task DoR

                    Time Tracking

                      Estimated:
                      Original Estimate - Not Specified
                      Not Specified
                      Remaining:
                      Remaining Estimate - 0d
                      0d
                      Logged:
                      Time Spent - 41m
                      41m