modules

Kirby Modules Field

This field extends the sortable field and adds some presets and features to help you manage your modules.
To use this field you have to install the modules-plugin.

Some of the features

• Preset parent and prefix to match those set by the modules-plugin
• Adds a preview if provided

Blueprint

After installing the plugin, you can use the new field type modules.
This blueprint shows all available options and their defaults.

fields:
  title:
    label: Title
    type: text

  modules:
    label: Modules
    type: modules

    add: true
    copy: true
    paste: true
    limit: false
    variant: modules

    actions:
      - edit
      - duplicate
      - delete
      - toggle

    options:
      preview: true
      limit: false
      edit: true
      duplicate: true
      delete: true
      toggle: true
  ...

Examples

The following examples show and explain some of the possible settings.

Preview

A preview is a normal PHP file with the HTML and PHP code that defines your preview. The preview has access to the following variables:

• $page is the page on which the module appears
• $module is the module subpage, which you can use to access the fields from your module blueprint as well as module files
• $moduleName is the name of the module such as text or gallery

The preview file must be in the same folder as the module itself. The module directory looks something like this:

site/modules/
    gallery/
        gallery.html.php
        gallery.yml

        # The preview file
        gallery.preview.php
        ...

Preview options

Previews are enabled by default. Set preview to false to disable the preview. It is also possible to change the position in the module.

    options:
      # Render the preview at the bottom
      preview: bottom

      # Or at the top
      preview: top
      preview: true

Limit the number of visible modules

  modules_field:
    label: Modules
    type: modules

    # Allow 3 visible modules overall
    limit: 3

    # Template specific option
    options:
      module.gallery:
        # Allow only 1 visible gallery module
        limit: 1

Is it a module or a section?

Change the naming.

    # Modules is fine
    variant: modules

    # Nah sections it is
    variant: sections

Changing actions

To change the actions or remove an action completely from the modules, you must specify the actions array in the blueprint.

    # Default
    actions:
      - edit
      - duplicate
      - delete
      - toggle

    actions:
      - edit
      - toggle

Disabling an action

    options:
      edit: false
      duplicate: false
      delete: true
      toggle: true

      # Template specific options
      module.gallery:
        edit: true
        duplicate: true

Requirements

• Kirby Modules Plugin 1.3+