diff --git a/.all-contributorsrc b/.all-contributorsrc index a2002865ecd9..65d3b53fe6e4 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -448,6 +448,15 @@ "contributions": [ "doc" ] + }, + { + "login": "hcavalieri", + "name": "Henrique Cavalieri", + "avatar_url": "https://avatars0.githubusercontent.com/u/27744332?v=4", + "profile": "https://kaordica.com.br", + "contributions": [ + "doc" + ] } ] } diff --git a/README.md b/README.md index 1bd306c48739..4d91d2188ce3 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # Netlify CMS -[![All Contributors](https://img.shields.io/badge/all_contributors-55-orange.svg)](#contributors) +[![All Contributors](https://img.shields.io/badge/all_contributors-56-orange.svg)](#contributors) [![](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/netlify/netlifycms) A CMS for static site generators. Give non-technical users a simple way to edit @@ -56,7 +56,7 @@ Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds | [
Benjamin Kniffler](https://github.com/bkniffler)
| [
Mike Wickett](http://www.wickett.ca)
| [
Rory Claasen](http://roryclaasen.me)
| [
Frederic Brodbeck](http://www.freder.io/)
| [
Stuart Dum](https://github.com/simplystuart)
| [
Ryan Watters](https://github.com/rdwatters)
| [
Helder S Ribeiro](https://twitter.com/hsribei)
| | [
Artem Govorov](http://dm.gl)
| [
Cรฉdric Delpoux](http://xuopled.netlify.com/)
| [
imorente](https://github.com/imorente)
| [
David Francoeur](http://davidfrancoeur.com)
| [
Rusta](https://github.com/Rusta)
| [
Henrik Lau Eriksson](http://henrik.laueriksson.com)
| [
Kraig Walker](https://www.kraigwalker.com)
| | [
Rich Cook](http://www.TalesofMurder.com)
| [
Damien Van Der Windt](https://github.com/damienvdw)
| [
Matt Jared](http://mattjared.github.io/)
| [
bruce-one](https://github.com/bruce-one)
| [
Frank Taillandier](https://frank.taillandier.me)
[๐Ÿ“–](https://github.com/netlify/netlify-cms/commits?author=DirtyF "Documentation") | [
Aquib Master](http://aquibm.com/)
[๐Ÿ’ป](https://github.com/netlify/netlify-cms/commits?author=aquibm "Code") | [
Eric Jinks](http://ericjinks.com)
[๐Ÿ’ป](https://github.com/netlify/netlify-cms/commits?author=Jinksi "Code") | -| [
Tony Alves](https://github.com/talves)
[๐Ÿ’ป](https://github.com/netlify/netlify-cms/commits?author=talves "Code") | [
Ernie Bello](http://ern.me)
[๐Ÿ›](https://github.com/netlify/netlify-cms/issues?q=author%3Aebello "Bug reports") | [
Alexander Kushi-Willis](https://ackushiw.com)
[๐Ÿ“–](https://github.com/netlify/netlify-cms/commits?author=ackushiw "Documentation") | [
Igor Kuznetsov](http://www.igk.ru)
[๐Ÿ›](https://github.com/netlify/netlify-cms/issues?q=author%3Aigk1972 "Bug reports") [๐Ÿ’ป](https://github.com/netlify/netlify-cms/commits?author=igk1972 "Code") [๐Ÿ”Œ](#plugin-igk1972 "Plugin/utility libraries") | [
Tim Erickson](http://neutyp.com)
[๐ŸŽจ](#design-neutyp "Design") | [
David Jones](http://davidejones.com)
[๐Ÿ“–](https://github.com/netlify/netlify-cms/commits?author=davidejones "Documentation") | +| [
Tony Alves](https://github.com/talves)
[๐Ÿ’ป](https://github.com/netlify/netlify-cms/commits?author=talves "Code") | [
Ernie Bello](http://ern.me)
[๐Ÿ›](https://github.com/netlify/netlify-cms/issues?q=author%3Aebello "Bug reports") | [
Alexander Kushi-Willis](https://ackushiw.com)
[๐Ÿ“–](https://github.com/netlify/netlify-cms/commits?author=ackushiw "Documentation") | [
Igor Kuznetsov](http://www.igk.ru)
[๐Ÿ›](https://github.com/netlify/netlify-cms/issues?q=author%3Aigk1972 "Bug reports") [๐Ÿ’ป](https://github.com/netlify/netlify-cms/commits?author=igk1972 "Code") [๐Ÿ”Œ](#plugin-igk1972 "Plugin/utility libraries") | [
Tim Erickson](http://neutyp.com)
[๐ŸŽจ](#design-neutyp "Design") | [
David Jones](http://davidejones.com)
[๐Ÿ“–](https://github.com/netlify/netlify-cms/commits?author=davidejones "Documentation") | [
Henrique Cavalieri](https://kaordica.com.br)
[๐Ÿ“–](https://github.com/netlify/netlify-cms/commits?author=hcavalieri "Documentation") | -This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome! +This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome! \ No newline at end of file diff --git a/website/site/content/docs/widgets.md b/website/site/content/docs/widgets.md index ed5f8e773f6a..fd8e5215555d 100644 --- a/website/site/content/docs/widgets.md +++ b/website/site/content/docs/widgets.md @@ -17,7 +17,7 @@ To see working examples of all of the built-in widgets, try making a 'Kitchen Si The following options are available on all fields: - `required`: specify as `false` to make a field optional; defaults to `true` -- `pattern`: add field validation by specifying a list with a regex pattern and an error message; more extensive validation can be achieved with [custom widgets](https://www.netlifycms.org/docs/custom-widgets/#advanced-field-validation) +- `pattern`: add field validation by specifying a list with a [regex pattern](https://regexr.com/) and an error message; more extensive validation can be achieved with [custom widgets](https://www.netlifycms.org/docs/custom-widgets/#advanced-field-validation) - **Example:** ```yaml @@ -27,310 +27,4 @@ The following options are available on all fields: pattern: ['.{10,}', "Must have at least 20 characters"] ``` - -## Boolean - -The boolean widget translates a toggle switch input to a true/false value. - -- **Name:** `boolean` -- **UI:** toggle switch -- **Data type:** boolean -- **Options:** - - `default`: accepts `true` or `false`; defaults to `false` -- **Example:** - - ```yaml - - {label: "Draft", name: "draft", widget: "boolean", default: true} - ``` - - -## Date - -The date widget translates a date picker input to a date string. For saving date and time together, use the [DateTime](#datetime) widget. - -- **Name:** `date` -- **UI:** date picker -- **Data type:** Moment.js-formatted date string -- **Options:** - - `default`: accepts a date string, or an empty string to accept blank input; otherwise defaults to current date - - `format`: accepts Moment.js [tokens](https://momentjs.com/docs/#/parsing/string-format/); defaults to ISO8601 format `YYYY-MM-DD` -- **Example:** - - ```yaml - - label: "Birthdate" - name: "birthdate" - widget: "date" - default: "" - format: "MMM Do YY" - ``` - - -## DateTime - -The datetime widget translates a datetime picker to a datetime string. For saving the date only, use the [Date](#date) widget. - -- **Name:** `datetime` -- **UI:** datetime picker -- **Data type:** Moment.js-formatted datetime string -- **Options:** - - `default`: accepts a datetime string, or an empty string to accept blank input; otherwise defaults to current datetime - - `format`: accepts Moment.js [tokens](https://momentjs.com/docs/#/parsing/string-format/); defaults to ISO8601 format `YYYY-MM-DDTHH:mm:ssZ` -- **Example:** - - ```yaml - - label: "Start time" - name: "start" - widget: "datetime" - default: "" - format: "LLL" - ``` - - -## File - -The file widget allows editors to upload a file or select an existing one from the media library. The path to the file will be saved to the field as a string. - -- **Name:** `file` -- **UI:** file picker button opens media gallery -- **Data type:** file path string, based on `media_folder`/`public_folder` configuration -- **Options:** - - `default`: accepts a file path string; defaults to null -- **Example:** - - ```yaml - - label: "Manual PDF" - name: "manual_pdf" - widget: "file" - default: "/uploads/general-manual.pdf" - ``` - - -## Hidden - -Hidden widgets do not display in the UI. In folder collections that allow users to create new items, you will often want to set a default for hidden fields, so they will be set without requiring an input. - -- **Name:** `hidden` -- **UI:** none -- **Data type:** any valid data type -- **Options:** - - `default`: accepts any valid data type; recommended for collections that allow adding new items -- **Example:** - - ```yaml - - {label: "Layout", name: "layout", widget: "hidden", default: "blog"} - ``` - - -## Image - -The image widget allows editors to upload an image or select an existing one from the media library. The path to the image file will be saved to the field as a string. - -- **Name:** `image` -- **UI:** file picker button opens media gallery allowing image files (jpg, jpeg, webp, gif, png, bmp, tiff, svg) only; displays selected image thumbnail -- **Data type:** file path string, based on `media_folder`/`public_folder` configuration -- **Options:** - - `default`: accepts a file path string; defaults to null -- **Example:** - - ```yaml - - label: "Featured Image" - name: "thumbnail" - widget: "image" - default: "/uploads/chocolate-dogecoin.jpg" - ``` - - -## 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): - - ```yaml - - label: "Tags" - name: "tags" - widget: "list" - default: ["news"] - ``` - -- **Example** (with `field`): - - ```yaml - - label: "Gallery" - name: "galleryImages" - widget: "list" - field: - - {label: Image, name: image, widget: image} - ``` - -- **Example** (with `fields`): - - ```yaml - - 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"} - ``` - - -## Number - -The number widget uses an HTML number input, saving the value as a string, integer, or floating point number. - -- **Name:** `number` -- **UI:** HTML [number input](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/number) -- **Data type:** string by default; configured by `valueType` option -- **Options:** - - `default`: accepts string or number value; defaults to empty string - - `valueType`: accepts `int` or `float`; any other value results in saving as a string - - `min`: accepts a number for minimum value accepted; unset by default - - `max`: accepts a number for maximum value accepted; unset by default -- **Example:** - - ```yaml - - label: "Puppy Count" - name: "puppies" - widget: "number" - default: 2 - valueType: "int" - min: 1 - max: 101 - ``` - - -## Object - -The object widget allows you to group multiple widgets together, nested under a single field. You can choose any widget as a child of an object widgetโ€”even other objects. - -- **Name:** `object` -- **UI:** a field containing one or more child widgets -- **Data type:** list of child widget values -- **Options:** - - `default`: you can set defaults within each sub-field's configuration - - `fields`: (**required**) a nested list of widget fields to include in your widget -- **Example:** - - ```yaml - - label: "Profile" - name: "profile" - widget: "object" - fields: - - {label: "Public", name: "public", widget: "boolean", default: true} - - {label: "Name", name: "name", widget: "string"} - - label: "Birthdate" - name: "birthdate" - widget: "date" - default: "" - format: "MM/DD/YYYY" - - label: "Address" - name: "address" - widget: "object" - fields: - - {label: "Street Address", name: "street", widget: "string"} - - {label: "City", name: "city", widget: "string"} - - {label: "Postal Code", name: "post-code", widget: "string"} - ``` - - -## 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): - - ```yaml - - 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. - - -## Select - -The select widget allows you to pick a single string value from a dropdown menu. - -- **Name:** `select` -- **UI:** HTML select input -- **Data type:** string -- **Options:** - - `default`: accepts a string; defaults to an empty string - - `options`: (**required**) a list of options for the dropdown menu; can be listed in two ways: - - string values: the label displayed in the dropdown is the value saved in the file - - object with `label` and `value` fields: the label displays in the dropdown; the value is saved in the file -- **Example** (options as strings): - - ```yaml - - label: "Align Content" - name: "align" - widget: "select" - options: ["left", "center", "right"] - ``` -- **Example** (options as objects): - - ```yaml - - label: "City" - name: "airport-code" - widget: "select" - options: - - { label: "Chicago", value: "ORD" } - - { label: "Paris", value: "CDG" } - - { label: "Tokyo", value: "HND" } - ``` - - -## String - -The string widget translates a basic text input to a string value. For larger textarea inputs, use the [text](#text) widget. - -- **Name:** `string` -- **UI:** text input -- **Data type:** string -- **Options:** - - `default`: accepts a string; defaults to an empty string -- **Example:** - - ```yaml - - {label: "Title", name: "title", widget: "string"} - ``` - - -## Text - -The text widget takes a multiline text field and saves it as a string. For shorter text inputs, use the [string](#string) widget. - -- **Name:** `text` -- **UI:** HTML textarea -- **Data type:** string -- **Options:** - - `default`: accepts a string; defaults to an empty string -- **Example:** - - ```yaml - - {label: "Description", name: "description", widget: "text"} - ``` +## Default widgets diff --git a/website/site/content/docs/widgets/boolean.md b/website/site/content/docs/widgets/boolean.md new file mode 100644 index 000000000000..7105a9bb2571 --- /dev/null +++ b/website/site/content/docs/widgets/boolean.md @@ -0,0 +1,20 @@ +--- +label: "Boolean" +target: "boolean" +type: "widget" +--- + +### Boolean + +The boolean widget translates a toggle switch input to a true/false value. + +- **Name:** `boolean` +- **UI:** toggle switch +- **Data type:** boolean +- **Options:** + - `default`: accepts `true` or `false`; defaults to `false` +- **Example:** + + ```yaml + - {label: "Draft", name: "draft", widget: "boolean", default: true} + ``` \ No newline at end of file diff --git a/website/site/content/docs/widgets/date.md b/website/site/content/docs/widgets/date.md new file mode 100644 index 000000000000..05f2e65961df --- /dev/null +++ b/website/site/content/docs/widgets/date.md @@ -0,0 +1,25 @@ +--- +label: "Date" +target: "date" +type: "widget" +--- + +### Date + +The date widget translates a date picker input to a date string. For saving date and time together, use the datetime widget. + +- **Name:** `date` +- **UI:** date picker +- **Data type:** Moment.js-formatted date string +- **Options:** + - `default`: accepts a date string, or an empty string to accept blank input; otherwise defaults to current date + - `format`: accepts Moment.js [tokens](https://momentjs.com/docs/#/parsing/string-format/); defaults to ISO8601 format `YYYY-MM-DD` +- **Example:** + + ```yaml + - label: "Birthdate" + name: "birthdate" + widget: "date" + default: "" + format: "MMM Do YY" + ``` \ No newline at end of file diff --git a/website/site/content/docs/widgets/datetime.md b/website/site/content/docs/widgets/datetime.md new file mode 100644 index 000000000000..b6e4d91c9bc2 --- /dev/null +++ b/website/site/content/docs/widgets/datetime.md @@ -0,0 +1,25 @@ +--- +label: "DateTime" +target: "datetime" +type: "widget" +--- + +### DateTime + +The datetime widget translates a datetime picker to a datetime string. For saving the date only, use the date widget. + +- **Name:** `datetime` +- **UI:** datetime picker +- **Data type:** Moment.js-formatted datetime string +- **Options:** + - `default`: accepts a datetime string, or an empty string to accept blank input; otherwise defaults to current datetime + - `format`: accepts Moment.js [tokens](https://momentjs.com/docs/#/parsing/string-format/); defaults to ISO8601 format `YYYY-MM-DDTHH:mm:ssZ` +- **Example:** + + ```yaml + - label: "Start time" + name: "start" + widget: "datetime" + default: "" + format: "LLL" + ``` diff --git a/website/site/content/docs/widgets/file.md b/website/site/content/docs/widgets/file.md new file mode 100644 index 000000000000..a332a1b454e2 --- /dev/null +++ b/website/site/content/docs/widgets/file.md @@ -0,0 +1,23 @@ +--- +label: "File" +target: "file" +type: "widget" +--- + +### File + +The file widget allows editors to upload a file or select an existing one from the media library. The path to the file will be saved to the field as a string. + +- **Name:** `file` +- **UI:** file picker button opens media gallery +- **Data type:** file path string, based on `media_folder`/`public_folder` configuration +- **Options:** + - `default`: accepts a file path string; defaults to null +- **Example:** + + ```yaml + - label: "Manual PDF" + name: "manual_pdf" + widget: "file" + default: "/uploads/general-manual.pdf" + ``` \ No newline at end of file diff --git a/website/site/content/docs/widgets/hidden.md b/website/site/content/docs/widgets/hidden.md new file mode 100644 index 000000000000..6a17db732e75 --- /dev/null +++ b/website/site/content/docs/widgets/hidden.md @@ -0,0 +1,20 @@ +--- +label: "Hidden" +target: "hidden" +type: "widget" +--- + +### Hidden + +Hidden widgets do not display in the UI. In folder collections that allow users to create new items, you will often want to set a default for hidden fields, so they will be set without requiring an input. + +- **Name:** `hidden` +- **UI:** none +- **Data type:** any valid data type +- **Options:** + - `default`: accepts any valid data type; recommended for collections that allow adding new items +- **Example:** + + ```yaml + - {label: "Layout", name: "layout", widget: "hidden", default: "blog"} + ``` \ No newline at end of file diff --git a/website/site/content/docs/widgets/image.md b/website/site/content/docs/widgets/image.md new file mode 100644 index 000000000000..afaed0cda1fd --- /dev/null +++ b/website/site/content/docs/widgets/image.md @@ -0,0 +1,23 @@ +--- +label: "Image" +target: "image" +type: "widget" +--- + +### Image + +The image widget allows editors to upload an image or select an existing one from the media library. The path to the image file will be saved to the field as a string. + +- **Name:** `image` +- **UI:** file picker button opens media gallery allowing image files (jpg, jpeg, webp, gif, png, bmp, tiff, svg) only; displays selected image thumbnail +- **Data type:** file path string, based on `media_folder`/`public_folder` configuration +- **Options:** + - `default`: accepts a file path string; defaults to null +- **Example:** + + ```yaml + - label: "Featured Image" + name: "thumbnail" + widget: "image" + default: "/uploads/chocolate-dogecoin.jpg" + ``` \ No newline at end of file diff --git a/website/site/content/docs/widgets/list.md b/website/site/content/docs/widgets/list.md new file mode 100644 index 000000000000..fac4e3201f68 --- /dev/null +++ b/website/site/content/docs/widgets/list.md @@ -0,0 +1,51 @@ +--- +label: "List" +target: "list" +type: "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): + + ```yaml + - label: "Tags" + name: "tags" + widget: "list" + default: ["news"] + ``` + +- **Example** (with `field`): + + ```yaml + - label: "Gallery" + name: "galleryImages" + widget: "list" + field: + - {label: Image, name: image, widget: image} + ``` + +- **Example** (with `fields`): + + ```yaml + - 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"} + ``` diff --git a/website/site/content/docs/widgets/markdown.md b/website/site/content/docs/widgets/markdown.md new file mode 100644 index 000000000000..58034cb13f65 --- /dev/null +++ b/website/site/content/docs/widgets/markdown.md @@ -0,0 +1,27 @@ +--- +label: "Markdown" +target: "markdown" +type: "widget" +--- + +### Markdown + +The markdown widget provides a full fledged text editor - which is based on [slate](https://github.com/ianstormtaylor/slate) - that allows users to format text with features such as headings and blockquotes. Users are also allowed to write in markdown by simply flipping a switch. + +*Please note:* in case you want to use your markdown editor to fill a markdown's file content after the frontmatter, you'll have name the field as `body` so then the CMS can recognize it and save the file accordingly. + +- **Name:** `markdown` +- **UI:** full text editor +- **Data type:** markdown +- **Options:** + - `default`: accepts markdown content +- **Example:** + + ```yaml + - {label: "Blog post content", name: "body", widget: "markdown"} + ``` + +This would render as: + +![Markdown widget example](/img/widgets-markdown.png) + diff --git a/website/site/content/docs/widgets/number.md b/website/site/content/docs/widgets/number.md new file mode 100644 index 000000000000..027705e5082b --- /dev/null +++ b/website/site/content/docs/widgets/number.md @@ -0,0 +1,30 @@ +--- +label: "Number" +target: "number" +type: "widget" +--- + +### Number + + +The number widget uses an HTML number input, saving the value as a string, integer, or floating point number. + +- **Name:** `number` +- **UI:** HTML [number input](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/number) +- **Data type:** string by default; configured by `valueType` option +- **Options:** + - `default`: accepts string or number value; defaults to empty string + - `valueType`: accepts `int` or `float`; any other value results in saving as a string + - `min`: accepts a number for minimum value accepted; unset by default + - `max`: accepts a number for maximum value accepted; unset by default +- **Example:** + + ```yaml + - label: "Puppy Count" + name: "puppies" + widget: "number" + default: 2 + valueType: "int" + min: 1 + max: 101 + ``` \ No newline at end of file diff --git a/website/site/content/docs/widgets/object.md b/website/site/content/docs/widgets/object.md new file mode 100644 index 000000000000..83a1dcb3f967 --- /dev/null +++ b/website/site/content/docs/widgets/object.md @@ -0,0 +1,38 @@ +--- +label: "Object" +target: "object" +type: "widget" +--- + +### Object + +The object widget allows you to group multiple widgets together, nested under a single field. You can choose any widget as a child of an object widgetโ€”even other objects. + +- **Name:** `object` +- **UI:** a field containing one or more child widgets +- **Data type:** list of child widget values +- **Options:** + - `default`: you can set defaults within each sub-field's configuration + - `fields`: (**required**) a nested list of widget fields to include in your widget +- **Example:** + + ```yaml + - label: "Profile" + name: "profile" + widget: "object" + fields: + - {label: "Public", name: "public", widget: "boolean", default: true} + - {label: "Name", name: "name", widget: "string"} + - label: "Birthdate" + name: "birthdate" + widget: "date" + default: "" + format: "MM/DD/YYYY" + - label: "Address" + name: "address" + widget: "object" + fields: + - {label: "Street Address", name: "street", widget: "string"} + - {label: "City", name: "city", widget: "string"} + - {label: "Postal Code", name: "post-code", widget: "string"} + ``` \ No newline at end of file diff --git a/website/site/content/docs/widgets/relation.md b/website/site/content/docs/widgets/relation.md new file mode 100644 index 000000000000..c8b363fdba5c --- /dev/null +++ b/website/site/content/docs/widgets/relation.md @@ -0,0 +1,29 @@ +--- +label: "Relation" +target: "relation" +type: "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): + + ```yaml + - 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. diff --git a/website/site/content/docs/widgets/select.md b/website/site/content/docs/widgets/select.md new file mode 100644 index 000000000000..d5e7fda657f2 --- /dev/null +++ b/website/site/content/docs/widgets/select.md @@ -0,0 +1,38 @@ +--- +label: "Select" +target: "select" +type: "widget" +--- + +### Select + +The select widget allows you to pick a single string value from a dropdown menu. + +- **Name:** `select` +- **UI:** HTML select input +- **Data type:** string +- **Options:** + - `default`: accepts a string; defaults to an empty string + - `options`: (**required**) a list of options for the dropdown menu; can be listed in two ways: + - string values: the label displayed in the dropdown is the value saved in the file + - object with `label` and `value` fields: the label displays in the dropdown; the value is saved in the file +- **Example** (options as strings): + + ```yaml + - label: "Align Content" + name: "align" + widget: "select" + options: ["left", "center", "right"] + ``` +- **Example** (options as objects): + + ```yaml + - label: "City" + name: "airport-code" + widget: "select" + options: + - { label: "Chicago", value: "ORD" } + - { label: "Paris", value: "CDG" } + - { label: "Tokyo", value: "HND" } + ``` + diff --git a/website/site/content/docs/widgets/string.md b/website/site/content/docs/widgets/string.md new file mode 100644 index 000000000000..8d62c7edaae0 --- /dev/null +++ b/website/site/content/docs/widgets/string.md @@ -0,0 +1,20 @@ +--- +label: "String" +target: "string" +type: "widget" +--- + +### String + +The string widget translates a basic text input to a string value. For larger textarea inputs, use the text widget. + +- **Name:** `string` +- **UI:** text input +- **Data type:** string +- **Options:** + - `default`: accepts a string; defaults to an empty string +- **Example:** + + ```yaml + - {label: "Title", name: "title", widget: "string"} + ``` diff --git a/website/site/content/docs/widgets/text.md b/website/site/content/docs/widgets/text.md new file mode 100644 index 000000000000..2898c897b09c --- /dev/null +++ b/website/site/content/docs/widgets/text.md @@ -0,0 +1,21 @@ +--- +label: "Text" +target: "text" +type: "widget" +--- + +### Text + +The text widget takes a multiline text field and saves it as a string. For shorter text inputs, use the string widget. + +- **Name:** `text` +- **UI:** HTML textarea +- **Data type:** string +- **Options:** + - `default`: accepts a string; defaults to an empty string +- **Example:** + + ```yaml + - {label: "Description", name: "description", widget: "text"} + ``` + diff --git a/website/site/layouts/_default/single.html b/website/site/layouts/_default/single.html index 50c7057cbc54..9d7fc970c78a 100644 --- a/website/site/layouts/_default/single.html +++ b/website/site/layouts/_default/single.html @@ -7,7 +7,9 @@
@@ -15,7 +17,9 @@ {{ $subjects := where .Site.Pages "Section" "docs" }} {{ range sort $subjects "Params.position" }} + {{- if ne .Type "widget" -}} + {{- end -}} {{ end }}
@@ -23,6 +27,9 @@
{{ partial "edit-link" . }} {{ .Content }} + {{- if eq .Title "Widgets" -}} + {{- partial "widgets" . -}} + {{- end -}}
diff --git a/website/site/layouts/partials/footer.html b/website/site/layouts/partials/footer.html index bdd3b4fcf8dd..09af0b720aed 100755 --- a/website/site/layouts/partials/footer.html +++ b/website/site/layouts/partials/footer.html @@ -21,5 +21,8 @@ debug: false // Set debug to true if you want to inspect the dropdown }); +{{- if eq .Title "Widgets" -}} + +{{- end -}} diff --git a/website/site/layouts/partials/widgets.html b/website/site/layouts/partials/widgets.html new file mode 100644 index 000000000000..6327195bac7f --- /dev/null +++ b/website/site/layouts/partials/widgets.html @@ -0,0 +1,14 @@ +
+
+ {{- range $index, $widget := where .Site.RegularPages "Type" "eq" "widget" -}} + {{.Params.label}} + {{- end -}} +
+
+ {{- range $index, $widget := where .Site.RegularPages "Type" "eq" "widget" -}} +
+ {{.Content}} +
+ {{- end -}} +
+
\ No newline at end of file diff --git a/website/site/static/img/widgets-markdown.PNG b/website/site/static/img/widgets-markdown.PNG new file mode 100644 index 000000000000..a42726c12664 Binary files /dev/null and b/website/site/static/img/widgets-markdown.PNG differ diff --git a/website/site/static/widgets.js b/website/site/static/widgets.js new file mode 100644 index 000000000000..5d18fabef7ac --- /dev/null +++ b/website/site/static/widgets.js @@ -0,0 +1,66 @@ +// Widgets section +function widgetsCloud() { + + const widgetItems = document.getElementsByClassName("widgets__item"), // Widget word cloud + widgets = document.getElementsByClassName("widget"); // Widgets' bodies + let activeWidgetItem = document.getElementsByClassName("widgets__item_active")[0]; // Active button in the widgets cloud + + if (document.getElementsByClassName("widgets")) { + + if (window.location.hash) { // Function to check if the given URL has a hash to make each widget shareable + const targetWidget = document.getElementById(window.location.hash.substr(1)), + openedWidget = document.getElementsByClassName("widget_open")[0]; + + let targetWidgetItem = ""; + for (let i = 0; i < widgetItems.length; i++) { + if (widgetItems[i].dataset.widgetTarget == window.location.hash.substr(1)) { + targetWidgetItem = widgetItems[i] + } + }; + changeWidgets(openedWidget, targetWidget, targetWidgetItem); // Runs the function to change which widget is displayed + setTimeout(() => { + document.getElementsByClassName("widgets")[0].scrollIntoView({ + behavior: "smooth", + block: "nearest" + }); // Scrolls to the widgets section + },200) + } + + for (let i = 0; i < widgetItems.length; i++) { + widgetItems[i].addEventListener("click", e => { // Add click event for each widget button in the cloud + const targetWidget = document.getElementById(e.target.dataset.widgetTarget), // Defines which widget the user is trying to render + openedWidget = document.getElementsByClassName("widget_open")[0], // Defines the current open widget + targetWidgetItem = e.target; // Defines the current open widget + changeWidgets(openedWidget, targetWidget, targetWidgetItem); // Runs the function to change which widget is displayed + }) + } + } + function changeWidgets(active, target, cloudItem) { + + target.classList.add("widget_opening"); // Starts the process of opening the next widget + + active.classList.remove("widget_open"); // Removes the active state of the current widget + active.classList.add("widget_closing"); // But guarantees the current active widget a closing class for transition purposes + + activeWidgetItem.classList.remove("widgets__item_active"); // Removes the active state of the current widget item in the cloud + activeWidgetItem = cloudItem; // Sets the new active widget item as the clicked one + activeWidgetItem.classList.add("widgets__item_active"); // And adds the active CSS class to it + + if (history.pushState) { + history.pushState(null, null, '#' + cloudItem.dataset.widgetTarget); + } + else { + location.hash = '#' + cloudItem.dataset.widgetTarget; + } + + setTimeout(() => { + target.classList.remove("widget_opening"); // Removes the opening class to finish transition + target.classList.add("widget_open"); // Defines the new target widget + active.classList.remove("widget_closing"); // Finally gets completely rid of the previously openened widget + + }, 150) // When the transition is done, finish the process by attributing the final classes to each widget + } +} + + +widgetsCloud(); \ No newline at end of file diff --git a/website/src/css/imports/widgets.css b/website/src/css/imports/widgets.css new file mode 100644 index 000000000000..0ebc878faff0 --- /dev/null +++ b/website/src/css/imports/widgets.css @@ -0,0 +1,71 @@ +.widgets { + margin: 2rem 0; +} + +.widgets__cloud { + margin: $micro calc(-$micro / 2); +} + +.widgets__item { + color: $darkGrey; + border: 2px solid $darkGreen; + border-radius: $borderRadius; + padding: calc($micro /2) $micro; + margin: calc($micro / 2); + cursor: pointer; + transition: color .2s ease, background .2s ease; + display: inline-block; + font-weight: normal; +} + +.widgets__item:hover, .widgets__item_active { + background: $darkGreen; + color: white !important; +} + +.widgets__container { + margin: 1em 0; + background: $lightGrey; + border-radius: $borderRadius; + transition: height .15s ease; +} + +.widget { + padding: .5em 1em; + display: none; +} + +.widget_open { + display: block; +} + +.widget_closing { + display: block; + animation: widgetOpacity .15s ease forwards reverse; +} + +.widget_opening { + display: block; + position: absolute; + top: 0; + left: 0; + opacity: 0; + animation: widgetOpacity .15s .05s ease forwards; +} + +@keyframes widgetOpacity { + from { + opacity: 0 + } + to { + opacity: 1 + } +} + +.widget pre { + background: #eee !important; /* making sure the pre has proper background contrast */ +} + +.widget h3 { + margin-top: 0 !important; +} \ No newline at end of file diff --git a/website/src/css/main.css b/website/src/css/main.css index a3d7d2db9287..2632ede083a8 100755 --- a/website/src/css/main.css +++ b/website/src/css/main.css @@ -7,4 +7,5 @@ @import "imports/community.css"; @import "imports/collab.css"; @import "imports/docs.css"; +@import "imports/widgets.css"; @import "imports/footer.css"; diff --git a/website/src/js/app.js b/website/src/js/app.js index 163695fbafeb..77e979e0e569 100755 --- a/website/src/js/app.js +++ b/website/src/js/app.js @@ -121,4 +121,4 @@ var eventInfoLoad = function() { } } -eventInfoLoad(); \ No newline at end of file +eventInfoLoad();