li-reference-list

Deprecated in: release-2023-09

Removed in: release-2023-11

Supported Features

Document
Media
Include
Document Creation Flow
Push Message
Table Dashboard
Display Filter
Search Indexing
System Metadata

Description

With release-2022-11 this is superseeded by li-document-references.

A list of references to other documents. A Document Selection Dialog is shown, based on shorthand queries and useDashboard to select documents.

Default UI

Document selection dialog.

Storage Format

{
  $ref: 'documents',
  references: [
    {
      id: <String>
    }
  ]
}

Content Type Config

{
  handle: 'myContentType',
  // ...
  metadata: [
    {
      handle: 'myHandle'
      type: 'li-reference-list',
      config: {
        // common
        hideFromForm: false,                     // optional, default: false
        required: true,                          // optional, default: false
        requiredErrorMessage: 'Provide a value', // optional
        index: true,                             // optional, default: false. Added in: release-2023-07
        // specific
        referenceType: 'documents',              // required, must be 'documents'
        documentType: 'article',                 // optional, one of article, page, data-record
        contentType: 'my-content-type',          // optional, content type handle (or array)
        min: 3,                                  // optional, minimum number of references
        max: 6                                   // optional, maximum number of references
      }
    }
    // ...
  ]
}