Skip to content

meta

The meta section controls the form window itself – its title, size, position, and opacity. It also lets you add documentation metadata like the form's name and version, and configure keyboard shortcuts.

Optional Section

If you skip this section, the window uses default settings (800×800 pixels, fully opaque, centered).

What Meta Controls

Think of meta as answering three questions:

  1. What is this form? — Name, description, version, author (useful when you have many forms)
  2. How should the window appear? — Title bar text, window size, position, transparency
  3. How do I interact with it? — Keyboard shortcuts for submitting, resetting, or closing

meta-window-large-small.avifTwo forms with different meta.window settings: a large, semi-transparent window on the left and a small, opaque window on the right. Anime girl in the background.

Example Usage

yml
meta:
  name: Follow-up Email
  description: A template for sending follow-up emails...
  version: 1.0.0
  window:
    title: EDF Email
    opacity: 0.7
    height: 500
    width: 500
    x: 0
    y: 0
  hotkeys:
    submit: "ctrl+s"
    reset: "ctrl+r"

Properties

Complete list of available properties in the meta section:

PropertyTypeDescriptionDefault Value
namestringName of the form-
descriptionstringDescription of the form-
versionstringVersion of the form-
authorstringAuthor of the form-

Window Configuration

Properties under meta.window:

PropertyTypeDescriptionDefault Value
titlestringWindow title"Espanso Dynamic Forms"
widthnumberWindow width in pixels1500 (dev) / 800 (prod)
heightnumberWindow height in pixels800
opacitynumberWindow opacity (0.0 - 1.0)1.0
xnumberInitial window X position-
ynumberInitial window Y position-

Hotkeys Configuration

Properties under meta.hotkeys.

Format

Shortcuts are defined as strings using common modifiers (ctrl, alt, shift) and keys joined by +. Case insensitive. Examples: ctrl+enter, shift+s.

PropertyTypeDescriptionDefault Value
submitstringHotkey to submit the formctrl+enter
resetstringHotkey to reset the form-
closestringHotkey to close the form-