2020-06-03 16:43:34 +03:00

3.1 KiB

label title
List list

The list widget allows you to create a repeatable item in the UI which saves as a list of widget values. map a user-provided string with a comma delimiter into a list. You can choose any widget as a child of a list widget—even other lists.

  • Name: list
  • UI: if fields is specified, field containing a repeatable child widget, with controls for adding, deleting, and re-ordering the repeated widgets; if unspecified, a text input for entering comma-separated values
  • Data type: list of widget values
  • Options:
    • default: if fields is specified, declare defaults on the child widgets; if not, you may specify a list of strings to populate the text field
    • allow_add: if added and set to false, hides the button to add additional items
    • collapsed: if added and set to false, the list widget's content does not collapse by default
    • summary: allows customization of a collapsed list item object in a similar way to a collection summary
    • minimize_collapsed: if added and set to true, the list widget's content will be completely hidden instead of only collapsed if the list widget itself is collapsed
    • label_singular: singular label to show as a part of the add button
    • field: a single widget field to be repeated
    • fields: a nested list of multiple widget fields to be included in each repeatable iteration
  • Example (field/fields not specified):
    - label: "Tags"
      name: "tags"
      widget: "list"
      default: ["news"]
    
  • Example (allow_add marked false):
    - label: "Tags"
      name: "tags"
      widget: "list"
      allow_add: false
      default: ["news"]
    
  • Example (with field):
    - label: "Gallery"
      name: "galleryImages"
      widget: "list"
      summary: '{{fields.image}}'
      field: {label: Image, name: image, widget: image}
    
  • Example (with fields):
    - label: "Testimonials"
      name: "testimonials"
      widget: "list"
      summary: '{{fields.quote}} - {{fields.author.name}}'
      fields:
        - {label: Quote, name: quote, widget: string, default: "Everything is awesome!"}
        - label: Author
          name: author
          widget: object
          fields:
            - {label: Name, name: name, widget: string, default: "Emmet"}
            - {label: Avatar, name: avatar, widget: image, default: "/img/emmet.jpg"}
    
  • Example (collapsed marked false):
    - label: "Testimonials"
      name: "testimonials"
      collapsed: false
      widget: "list"
      fields:
        - {label: Quote, name: quote, widget: string, default: "Everything is awesome!"}
        - {label: Author, name: author, widget: string }
    
  • Example (minimize_collapsed marked true):
    - label: "Testimonials"
      name: "testimonials"
      minimize_collapsed: true
      widget: "list"
      fields:
        - {label: Quote, name: quote, widget: string, default: "Everything is awesome!"}
        - {label: Author, name: author, widget: string }