From 0d9f19acdb216aaac77159fe054da93c487b4ded Mon Sep 17 00:00:00 2001 From: Roger Zurawicki Date: Thu, 26 Apr 2018 10:18:31 -0700 Subject: [PATCH] :memo: Documentation updates --- website/site/content/docs/widgets/relation.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/website/site/content/docs/widgets/relation.md b/website/site/content/docs/widgets/relation.md index aea4dc9d6398..3be24bcdbb61 100644 --- a/website/site/content/docs/widgets/relation.md +++ b/website/site/content/docs/widgets/relation.md @@ -13,7 +13,7 @@ The relation widget allows you to reference items from another collection. It pr - **Options:** - `default`: accepts any widget data type; defaults to an empty string - `collection`: (**required**) name of the collection being referenced (string) - - `displayFields`: list of one or more names of fields in the referenced collection that will render in the autocomplete menu of the control. The value field is used by default. + - `displayFields`: list of one or more names of fields in the referenced collection that will render in the autocomplete menu of the control. Defaults to `valueField`. - `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): @@ -23,8 +23,8 @@ The relation widget allows you to reference items from another collection. It pr name: "author" widget: "relation" collection: "authors" - displayFields: ["twitterHandle", "followerCount"] searchFields: ["name", "twitterHandle"] valueField: "name" + displayFields: ["twitterHandle", "followerCount"] ``` - The generated UI input will search the authors collection by name and twitterHandle as the user types. Each collection will be represented by the author's handle and follower count. On selection, the author name will be saved for the field. + The generated UI input will search the authors collection by name and twitterHandle, and display each author's handle and follower count. On selection, the author name will be saved for the field.