Default Admin Theme

No options
Key Type Default Value Description
allData Map<String, Object> {}

All options passed to this object.

extraCss String[] empty array

Add extra CSS files to every page rendered with this theme, which will be compiled just like the rest of the site's assets.

extraJs String[] empty array

Add extra Javascript files to every page rendered with this theme, which will be compiled just like the rest of the site's assets.

Plugin Documentation

Show all options for your plugin's classes.

25: [pluginDocs]

Basic Usage
# a page's Front Matter, or in any option of type ComponentHolder
...
components:
  - type: "pluginDocs"
    classNames: empty array
    packageNames: empty array
    tableClass: empty string
    tableHeaderClass: empty string
    tableLeaderClass: empty string
    tabsTemplate: empty string

Key Type Default Value Description
classNames String[] empty array

A list of fully-qualified class names to render options for.

packageNames String[] empty array

A list of fully-qualified package names. All OptionsHolder classes in these packages will have their options displayed.

tableClass String empty string

A fully-qualified class name to render options for.

tableHeaderClass String empty string

A fully-qualified class name to render options for.

tableLeaderClass String empty string

A fully-qualified class name to render options for.

tabsTemplate String empty string

A custom template to use the for tabs tag used internally.

Key Type Default Value Description
allData Map<String, Object> {}

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.

Describe Params

Key Type Default Value Description
className String empty string
No options

Plugin Documentation

Show all options for one of your plugin's classes.

Key Type Default Value Description
className String empty string

A fully-qualified class name to render options for.

tableClass String empty string

A fully-qualified class name to render options for.

tableHeaderClass String empty string

A fully-qualified class name to render options for.

tableLeaderClass String empty string

A fully-qualified class name to render options for.

tabsTemplate String empty string

A custom template to use the for tabs tag used internally.

Key Type Default Value Description
template String empty string

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.