com.eden.orchid.forms.FormsGenerator


Own Options

Type Default Value Description
baseDir String forms The base directory in local resources to look for forms in.

Inherited Options

Type Default Value Description
allData Map {} All options passed to this object.
layout String empty string Set the default layout to be used for all Pages from this Generator. Pages can specify their own layouts, which take precedence over the Generator layout.
parallel boolean false Improve site generation performance dramatically by rendering the pages from this Generator in parallel. There are currently thread-safety issues that may cause deadlocks, especially when in `serve` mode when build cycles may be executed multiple times. As such this feature should be considered highly experimental and used with caution.
theme Object null Set a theme to be used only when rendering pages from this Generator. This can be a String to use that theme's default options set in `config.yml`, or an object with a `key` property to use those specific options for the theme.

com.eden.orchid.forms.SearchIndexGenerator


Own Options

Type Default Value Description
enablePageIndices boolean false Whether this generator is enabled or not. This generator effectively doubles the number of pages generated, but allows most pages on your site to

Inherited Options

Type Default Value Description
allData Map {} All options passed to this object.
layout String empty string Set the default layout to be used for all Pages from this Generator. Pages can specify their own layouts, which take precedence over the Generator layout.
parallel boolean false Improve site generation performance dramatically by rendering the pages from this Generator in parallel. There are currently thread-safety issues that may cause deadlocks, especially when in `serve` mode when build cycles may be executed multiple times. As such this feature should be considered highly experimental and used with caution.
theme Object null Set a theme to be used only when rendering pages from this Generator. This can be a String to use that theme's default options set in `config.yml`, or an object with a `key` property to use those specific options for the theme.

com.eden.orchid.forms.components.FormComponent


Own Options

Type Default Value Description
form Form null The Form to render. Can be either a key to an indexed form definition, or a complete form definition for a one-off use.

Inherited Options

Type Default Value Description
allData Map {} All options passed to this object.
extraCss String[] empty array Add extra CSS files to the page containing this Component, which will be compiled just like the rest of the site's assets.
extraJs String[] empty array Add extra Javascript files to the page containing this Component, which will be compiled just like the rest of the site's assets.
hidden boolean false When true, this component will not have a template rendered on the page. Useful for Components that only add extra CSS or JS, or for temporarily removing a component from the page.
noWrapper boolean false When true, this component will not be wrapped in a wrapper element. The wrapper element is determinedby the theme, and it is up to the theme to ensure this is implemented properly.
order int 0 By default, components are rendered in the order in which they are declared, but the ordering can be changed by setting the order on any individual component. A higher value for order will render that component earlier in the list.
template String[] empty array Specify a template or a list of templates to use when rendering this component. The first template that exists will be chosen for this component.

com.eden.orchid.forms.model.Form


Own Options

Type Default Value Description
action String empty string The 'action' attribute of the form. On forms which have a dedicated submission page, if this is not provided, it defaults to the URL of the submission page.
allData Map {} All options passed to this object.
attributes JSONObject {} A map of arbitrary attributes to add to the form element.
fields FormFieldList Empty FormFieldList The fields in this form.
method String POST The HTTP request method the form submits as. One of ['GET', 'POST'].
title String empty string The user-facing title of the form.

Inherited Options

com.eden.orchid.forms.model.FormField


Own Options

Type Default Value Description
key String empty string The key the field maps to in the resulting form
label String empty string The user-facing label of this field.
order int 0 Form fields are defined in maps which do not have a defined order, and so order in which fields are rendered are not necessarily the order they are declared. Set this property to manually define the ordering of each field.
placeholder String empty string The user-facing placeholder of this field.
required boolean false Whether this field is required for submission.
span String auto The number of columns this field should occupy on large screens, out of 12. Can also be 'left' (6columns, ordered from the left), 'right' (6 columns, ordered from the right), 'auto' (equivalent to 'left'), or 'full' (12 columns) The default is 'auto'.
spanSm String auto The number of columns this field should occupy on small screens, out of 12. Can also be 'left', 'right', 'auto', or 'full', which are all 12 columns. The default is 'auto'.
template String[] empty array A list of templates to use for this field, which takes precedence over the normal template. The first template in this lit that exists will be chosen, otherwise falling back to the default if the list is empty or none of the templates are found.
type String empty string The field type.

Inherited Options

com.eden.orchid.forms.model.fields.DropdownField


Own Options

Type Default Value Description
multiple boolean false Whether to allow multi-select of options.
options JSONObject {} A map of values which populate the select element.

Inherited Options

Type Default Value Description
key String empty string The key the field maps to in the resulting form
label String empty string The user-facing label of this field.
order int 0 Form fields are defined in maps which do not have a defined order, and so order in which fields are rendered are not necessarily the order they are declared. Set this property to manually define the ordering of each field.
placeholder String empty string The user-facing placeholder of this field.
required boolean false Whether this field is required for submission.
span String auto The number of columns this field should occupy on large screens, out of 12. Can also be 'left' (6columns, ordered from the left), 'right' (6 columns, ordered from the right), 'auto' (equivalent to 'left'), or 'full' (12 columns) The default is 'auto'.
spanSm String auto The number of columns this field should occupy on small screens, out of 12. Can also be 'left', 'right', 'auto', or 'full', which are all 12 columns. The default is 'auto'.
template String[] empty array A list of templates to use for this field, which takes precedence over the normal template. The first template in this lit that exists will be chosen, otherwise falling back to the default if the list is empty or none of the templates are found.
type String empty string The field type.

com.eden.orchid.forms.model.fields.HiddenField


Own Options

Type Default Value Description
value String empty string The value of this hidden field.

Inherited Options

Type Default Value Description
key String empty string The key the field maps to in the resulting form
label String empty string The user-facing label of this field.
order int 0 Form fields are defined in maps which do not have a defined order, and so order in which fields are rendered are not necessarily the order they are declared. Set this property to manually define the ordering of each field.
placeholder String empty string The user-facing placeholder of this field.
required boolean false Whether this field is required for submission.
span String auto The number of columns this field should occupy on large screens, out of 12. Can also be 'left' (6columns, ordered from the left), 'right' (6 columns, ordered from the right), 'auto' (equivalent to 'left'), or 'full' (12 columns) The default is 'auto'.
spanSm String auto The number of columns this field should occupy on small screens, out of 12. Can also be 'left', 'right', 'auto', or 'full', which are all 12 columns. The default is 'auto'.
template String[] empty array A list of templates to use for this field, which takes precedence over the normal template. The first template in this lit that exists will be chosen, otherwise falling back to the default if the list is empty or none of the templates are found.
type String empty string The field type.

com.eden.orchid.forms.model.fields.TextField


Own Options

Inherited Options

Type Default Value Description
key String empty string The key the field maps to in the resulting form
label String empty string The user-facing label of this field.
order int 0 Form fields are defined in maps which do not have a defined order, and so order in which fields are rendered are not necessarily the order they are declared. Set this property to manually define the ordering of each field.
placeholder String empty string The user-facing placeholder of this field.
required boolean false Whether this field is required for submission.
span String auto The number of columns this field should occupy on large screens, out of 12. Can also be 'left' (6columns, ordered from the left), 'right' (6 columns, ordered from the right), 'auto' (equivalent to 'left'), or 'full' (12 columns) The default is 'auto'.
spanSm String auto The number of columns this field should occupy on small screens, out of 12. Can also be 'left', 'right', 'auto', or 'full', which are all 12 columns. The default is 'auto'.
template String[] empty array A list of templates to use for this field, which takes precedence over the normal template. The first template in this lit that exists will be chosen, otherwise falling back to the default if the list is empty or none of the templates are found.
type String empty string The field type.

com.eden.orchid.forms.model.fields.TextareaField


Own Options

Type Default Value Description
cols int 0 The initial width of the textarea in average character columns.
rows int 0 The initial height of the textarea in rows.

Inherited Options

Type Default Value Description
key String empty string The key the field maps to in the resulting form
label String empty string The user-facing label of this field.
order int 0 Form fields are defined in maps which do not have a defined order, and so order in which fields are rendered are not necessarily the order they are declared. Set this property to manually define the ordering of each field.
placeholder String empty string The user-facing placeholder of this field.
required boolean false Whether this field is required for submission.
span String auto The number of columns this field should occupy on large screens, out of 12. Can also be 'left' (6columns, ordered from the left), 'right' (6 columns, ordered from the right), 'auto' (equivalent to 'left'), or 'full' (12 columns) The default is 'auto'.
spanSm String auto The number of columns this field should occupy on small screens, out of 12. Can also be 'left', 'right', 'auto', or 'full', which are all 12 columns. The default is 'auto'.
template String[] empty array A list of templates to use for this field, which takes precedence over the normal template. The first template in this lit that exists will be chosen, otherwise falling back to the default if the list is empty or none of the templates are found.
type String empty string The field type.

com.eden.orchid.forms.pages.FormSubmissionPage


Own Options

Inherited Options

Type Default Value Description
allData Map {} All options passed to this object.
changeFrequency String empty string A rough estimate of how frequently the content of this page changes, primarily to include in the generated sitemap.xml. One of [always, hourly, daily, weekly, monthly, yearly, never].
components ComponentHolder Empty ComponentHolder The components that comprise the main content body for this page. The 'intrinsic content' of the page, which is typically the rendered markup of the containing file, is added by default as a component of type `pageContent` if none are specified. The full `pageContent` component is rendered within the chosen page template. If a custom list of components is given, you will need to add the `pageContent` component yourself.
defaultBreadcrumbs String empty string The default breadcrumbs to display for this page.
description String empty string Specify a custom description for this page, to include in the meta description tag.
draft boolean false Set this page as currently being a draft. Drafts will not be included in the rendered site.
expiryDate LocalDateTime now (yyyy-mm-dd HH:MM:SS) Set when this page expires. Pages with an expiry date in the past are considered a draft. Should be a valid ISO-8601 date or datetime without timezone, such as `2018-01-01` or `2018-01-01T08:15:30`.
extraCss String[] empty array Add extra CSS files to this page only, which will be compiled just like the rest of the site's assets.
extraJs String[] empty array Add extra Javascript files to every this page only, which will be compiled just like the rest of the site's assets.
lastModifiedDate LocalDateTime now (yyyy-mm-dd HH:MM:SS) Set when this page was last modified. Should be a valid ISO-8601 date or datetime without timezone, such as `2018-01-01` or `2018-01-01T08:15:30`.
layout String empty string The layout to embed this page in, or 'none' to render the page content without a layout. A page's default layout, if none is specified, is `index`
menu OrchidMenu Empty OrchidMenu The secondary only added to this page. It is common for generators to add menu items to their pagesautomcatically, but the menu specified on the page will take precedence over the generator's page.
noFollow boolean false Request that search engines do not follow links from this page by adding a meta tag on in the page's head.
noIndex boolean false Request that search engines do not index this page by adding a meta tag on in the page's head.
publishDate LocalDateTime now (yyyy-mm-dd HH:MM:SS) Set when this page was published. Pages with a publish date in the future are considered a draft. Should be a valid ISO-8601 date or datetime without timezone, such as `2018-01-01` or `2018-01-01T08:15:30`. Note that some generators may choose to set this value based on some external criteria, but the value in front matter should take precedence over the generator's determined publish date.
relativePriority float 0.0 The importance of this page relative to the rest of the pages on your site. Should be a value between 0 and 1.
template String[] empty array Specify a template or a list of templates to use when rendering this page. The first template that exists will be chosen for this page, otherwise the page's default set of templates will be searched for (which typically is customized by the generator that produces this page).
title String empty string Specify a custom title for this Page, which takes precedence over the title given by its generator.