static-cms/list.md at f8cdb6abfa5d52d0e42b1feabaf7adaaf89916fe

docs(fix): revert prettier formatting on markdown files (#1612 )

Prettier formatting our markdown files is causing bugs because of the
differences between Gatsby's parser and Prettier's. Also, Prettier
formats the inline code-blocks containing example CMS configs, but the
formatting it uses doesn't really make much sense or match the suggested
CMS config style.

It doesn't actually make much sense to format the docs anyway, since we
use the CMS itself to edit/generate them.

2018-08-14 11:33:13 -06:00

1.9 KiB

Raw Blame History

label	target
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"}

1.9 KiB Raw Blame History

1.9 KiB

Raw Blame History