gcg/static-cms
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
static-cms/website/site/content/docs/widgets/relation.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.3 KiB
Raw Blame History

label target type
Relation relation widget

Relation

The relation widget allows you to reference items from another collection. It provides a search input with a list of entries from the collection you're referencing, and the list automatically updates with matched entries based on what you've typed.

  • Name: relation

  • UI: text input with search result dropdown

  • Data type: data type of the value pulled from the related collection item

  • Options:

    • default: accepts any widget data type; defaults to an empty string
    • collection: (required) name of the collection being referenced (string)
    • searchFields: (required) list of one or more names of fields in the referenced collection to search for the typed value
    • valueField: (required) name of the field from the referenced collection whose value will be stored for the relation

  • Example (assuming a separate "authors" collection with "name" and "twitterHandle" fields):

    - label: "Post Author"
  name: "author"
  widget: "relation"
  collection: "authors"
  searchFields: "[name, twitterHandle]"
  valueField: "name"

    The generated UI input will search the authors collection by name and twitterHandle as the user types. On selection, the author name will be saved for the field.