Widgets on Hugolify

Blocks

Mon, 01 Jan 0001 00:00:00 +0000

Usage

{{ partial "admin/widgets/blocks.js" $args }}

Parameters

Parameter	Type	Required	Description
`label`	string	yes	Field label
`name`	string	yes	Field name
`blocks`	array	yes	Array of block type definitions
`collapsed`	boolean	—	Collapse items by default (default: `true`)
`hint`	string	—	Help text
`i18n`	boolean or string	—	i18n mode
`label_singular`	string	—	Singular label
`max`	number	—	Maximum number of blocks
`min`	number	—	Minimum number of blocks
`required`	boolean	—	Mark as required

Boolean

Mon, 01 Jan 0001 00:00:00 +0000

Usage

{{ partial "admin/widgets/boolean.js" $args }}

Parameters

Parameter	Type	Required	Description
`label`	string	yes	Field label
`name`	string	yes	Field name
`default`	boolean or string	—	Default value
`hidden`	boolean	—	Hide from the editor
`hint`	string	—	Help text
`i18n`	boolean or string	—	i18n mode
`nameOverride`	string	—	Override the name in output
`required`	boolean	—	Mark as required

Code

Mon, 01 Jan 0001 00:00:00 +0000

Usage

{{ partial "admin/widgets/code.js" $args }}

Parameters

Parameter	Type	Required	Description
`label`	string	yes	Field label
`name`	string	yes	Field name
`default`	boolean or string	—	Default value
`hidden`	boolean	—	Hide from the editor
`hint`	string	—	Help text
`i18n`	boolean or string	—	i18n mode
`language`	string	—	Syntax language (e.g. `html`, `css`, `javascript`)
`nameOverride`	string	—	Override the name in output
`required`	boolean	—	Mark as required

Color

Mon, 01 Jan 0001 00:00:00 +0000

Usage

{{ partial "admin/widgets/color.js" $args }}

Parameters

Parameter	Type	Required	Description
`label`	string	yes	Field label
`name`	string	yes	Field name
`default`	boolean or string	—	Default value
`hidden`	boolean	—	Hide from the editor
`hint`	string	—	Help text
`i18n`	boolean or string	—	i18n mode
`required`	boolean	—	Mark as required

Compute

Mon, 01 Jan 0001 00:00:00 +0000

New in v2 Only available with Sveltia CMS

The value is rebuilt as the other fields are typed. Every other supported CMS emits an empty field, so the value stays typed by hand there.

Usage

{{ partial "admin/widgets/compute.js" $args }}

Parameters

Parameter	Type	Required	Description
`label`	string	yes	Field label
`name`	string	yes	Field name
`value`	string	yes	Value template
`hint`	string	—	Help text
`i18n`	boolean or string	—	i18n mode (default: `true`)
`required`	boolean	—	Mark as required

Value template

A template references another field with {{fields.name}} and accepts a string transformation after a pipe.

Datetime

Mon, 01 Jan 0001 00:00:00 +0000

Usage

{{ partial "admin/widgets/datetime.js" $args }}

Parameters

Parameter	Type	Required	Description
`label`	string	yes	Field label
`name`	string	yes	Field name
`default`	date or string	—	Default value
`hidden`	boolean	—	Hide from the editor
`hint`	string	—	Help text
`i18n`	boolean or string	—	i18n mode
`nameOverride`	string	—	Override the name in output
`required`	boolean	—	Mark as required

File

Mon, 01 Jan 0001 00:00:00 +0000

Usage

{{ partial "admin/widgets/file.js" $args }}

Parameters

Parameter	Type	Required	Description
`label`	string	yes	Field label
`name`	string	yes	Field name
`type`	string	yes	Media category: `audio`, `document`, `file`, `video`
`extensions`	array	—	Allowed file extensions
`hidden`	boolean	—	Hide from the editor
`hint`	string	—	Help text
`i18n`	boolean or string	—	i18n mode
`label_singular`	string	—	Singular label
`max`	number	—	Maximum number of files
`min`	number	—	Minimum number of files
`multiple`	boolean	—	Allow multiple files
`nameOverride`	string	—	Override the name in output
`required`	boolean	—	Mark as required

Image

Mon, 01 Jan 0001 00:00:00 +0000

Usage

{{ partial "admin/widgets/image.js" $args }}

Parameters

Parameter	Type	Required	Description
`label`	string	yes	Field label
`name`	string	yes	Field name
`hidden`	boolean	—	Hide from the editor
`hint`	string	—	Help text
`i18n`	boolean or string	—	i18n mode
`max`	number	—	Maximum number of images
`max_file_size`	number	—	Maximum file size in bytes
`media_folder`	string	—	Upload folder
`min`	number	—	Minimum number of images
`multiple`	boolean	—	Allow multiple images
`nameOverride`	string	—	Override the name in output
`public_folder`	string	—	Public path for images
`required`	boolean	—	Mark as required

List

Mon, 01 Jan 0001 00:00:00 +0000

Usage

{{ partial "admin/widgets/list.js" $args }}

Parameters

Parameter	Type	Required	Description
`label`	string	yes	Field label
`name`	string	yes	Field name
`fields`	array	yes	Array of field definitions
`collapsed`	boolean	—	Collapse items by default (default: `true`)
`hidden`	boolean	—	Hide from the editor
`hint`	string	—	Help text
`i18n`	boolean or string	—	i18n mode
`label_singular`	string	—	Singular label
`max`	number	—	Maximum number of items
`min`	number	—	Minimum number of items
`nameOverride`	string	—	Override the name in output
`required`	boolean	—	Mark as required
`summary`	string	—	Summary template for collapsed view

Map

Mon, 01 Jan 0001 00:00:00 +0000

Not available with CloudCannon, Pages and TinaCMS

Usage

{{ partial "admin/widgets/map.js" $args }}

Parameters

Parameter	Type	Required	Description
`label`	string	yes	Field label
`name`	string	yes	Field name
`default`	string	—	Default value
`hint`	string	—	Help text
`i18n`	boolean or string	—	i18n mode

Markdown

Mon, 01 Jan 0001 00:00:00 +0000

Usage

{{ partial "admin/widgets/markdown.js" $args }}

Parameters

Parameter	Type	Required	Description
`label`	string	yes	Field label
`name`	string	yes	Field name
`buttons`	array	—	Toolbar buttons to show
`default`	string	—	Default value
`editor_components`	array	—	Editor components to enable
`hidden`	boolean	—	Hide from the editor
`hint`	string	—	Help text
`i18n`	boolean or string	—	i18n mode
`minimal`	boolean	—	Minimal toolbar (default: `true`)
`modes`	array	—	Editor modes (default: `['rich_text']`)
`nameOverride`	string	—	Override the name in output
`pattern`	object	—	Validation pattern
`required`	boolean	—	Mark as required

Number

Mon, 01 Jan 0001 00:00:00 +0000

Usage

{{ partial "admin/widgets/number.js" $args }}

Parameters

Parameter	Type	Required	Description
`label`	string	yes	Field label
`name`	string	yes	Field name
`default`	string	—	Default value
`hint`	string	—	Help text
`i18n`	boolean or string	—	i18n mode
`max`	number	—	Maximum value
`min`	number	—	Minimum value
`nameOverride`	string	—	Override the name in output
`range`	boolean	—	Render as a range slider
`required`	boolean	—	Mark as required
`step`	number	—	Step increment

Object

Mon, 01 Jan 0001 00:00:00 +0000

Usage

{{ partial "admin/widgets/object.js" $args }}

Parameters

Parameter	Type	Required	Description
`label`	string	yes	Field label
`name`	string	yes	Field name
`fields`	array	yes	Array of field definitions
`collapsed`	boolean	—	Collapse by default (default: `true`)
`hidden`	boolean	—	Hide from the editor
`hint`	string	—	Help text
`i18n`	boolean or string	—	i18n mode
`label_singular`	string	—	Singular label
`nameOverride`	string	—	Override the name in output
`required`	boolean	—	Mark as required
`summary`	string	—	Summary template for collapsed view

Relation

Mon, 01 Jan 0001 00:00:00 +0000

Usage

{{ partial "admin/widgets/relation.js" $args }}

Parameters

Parameter	Type	Required	Description
`label`	string	yes	Field label
`name`	string	yes	Field name
`collection`	string	yes	Target collection name
`value_field`	string	yes	Field used as the stored value
`display_fields`	array	—	Fields shown in the picker
`filters`	array	—	Filter entries by field values
`hidden`	boolean	—	Hide from the editor
`hint`	string	—	Help text
`i18n`	boolean or string	—	i18n mode
`label_singular`	string	—	Singular label
`multiple`	boolean	—	Allow multiple relations (default: `true`)
`nameOverride`	string	—	Override the name in output
`required`	boolean	—	Mark as required
`search_fields`	array	—	Fields to search in the picker

Select

Mon, 01 Jan 0001 00:00:00 +0000

Usage

{{ partial "admin/widgets/select.js" $args }}

Parameters

Parameter	Type	Required	Description
`label`	string	yes	Field label
`name`	string	yes	Field name
`options`	array or object	yes	Available options
`default`	string	—	Default selected value
`hidden`	boolean	—	Hide from the editor
`hint`	string	—	Help text
`i18n`	boolean or string	—	i18n mode
`label_options`	string	—	i18n key prefix for option labels
`multiple`	boolean	—	Allow multiple selections
`nameOverride`	string	—	Override the name in output
`required`	boolean	—	Mark as required

String

Mon, 01 Jan 0001 00:00:00 +0000

Usage

{{ partial "admin/widgets/string.js" $args }}

Parameters

Parameter	Type	Required	Description
`label`	string	yes	Field label
`name`	string	yes	Field name
`default`	string	—	Default value
`hidden`	boolean	—	Hide from the editor
`hint`	string	—	Help text
`i18n`	boolean or string	—	i18n mode
`nameOverride`	string	—	Override the name in output
`pattern`	object	—	Validation pattern
`required`	boolean	—	Mark as required

Text

Mon, 01 Jan 0001 00:00:00 +0000

Usage

{{ partial "admin/widgets/text.js" $args }}

Parameters

Parameter	Type	Required	Description
`label`	string	yes	Field label
`name`	string	yes	Field name
`default`	string	—	Default value
`hint`	string	—	Help text
`i18n`	boolean or string	—	i18n mode
`nameOverride`	string	—	Override the name in output
`pattern`	object	—	Validation pattern
`required`	boolean	—	Mark as required

UUID

Mon, 01 Jan 0001 00:00:00 +0000

Usage

{{ partial "admin/widgets/uuid.js" $args }}

Parameters

Parameter	Type	Required	Description
`label`	string	yes	Field label
`name`	string	yes	Field name
`hidden`	boolean	—	Hide from the editor
`hint`	string	—	Help text
`i18n`	boolean or string	—	i18n mode
`nameOverride`	string	—	Override the name in output