Shawn Erquhart 6e453b3f08
docs: make widget docs editable (#1782)
* make widget docs editable

* update widget doc frontmatter keys

* improve docs preview

* fix formatting

* fix preview

* add prism highlighting for previews

* fix formatting

* restore cms branch
2018-10-01 20:00:57 -04:00

1.9 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 labeled false, button to add additional widgets disapears
    • 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"
      field:
        - {label: Image, name: image, widget: image}
    
  • Example (with fields):
    - label: "Testimonials"
      name: "testimonials"
      widget: "list"
      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"}