gcg/static-cms
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
static-cms/website/site/content/docs/widgets/list.md
Henrique Cavalieri 1167f27939 New design for the widgets section in the docs (#866) 
* Initial commit for the new widgets section

* Placing all the widgets and refining the CSS and Hugo logic

* Initial commit for the new widgets section

* Placing all the widgets and refining the CSS and Hugo logic

* Rebased and updated the info according to @verythorough contribution

* Fixing the yaml codes for the relation and select widget sections

* Merging with widgets.md and app.j

* Fixing some silly mistakes (sorry!)

* Following @verythorough contributions :)

* Adding the markdown widget and fixing the widgets container background

* Adding the URL functionality and myself as a contributor :)

* Adding myself as a contributor :)
2018-01-03 15:14:15 -07:00

1.6 KiB
Raw Blame History

label target type
List list widget

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
    • 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 (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"}