Skip to main content

Documentation Index

Fetch the complete documentation index at: https://prefab.prefect.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

Modal dialog overlay.
{
  "type": "object",
  "properties": {
    "type": {
      "const": "Dialog",
      "default": "Dialog",
      "type": "string"
    },
    "id": {
      "type": [
        "string",
        "null"
      ],
      "default": null,
      "description": "HTML id attribute for CSS targeting. Applied to the outermost element."
    },
    "cssClass": {
      "type": [
        "string",
        "null"
      ],
      "default": null,
      "description": "CSS/Tailwind classes for styling. Accepts a Responsive() for breakpoint-aware classes."
    },
    "onMount": {
      "default": null,
      "description": "Action(s) to execute when this component mounts."
    },
    "children": {
      "type": "array",
      "items": {
        "$ref": "Component"
      }
    },
    "let": {
      "additionalProperties": true,
      "type": [
        "object",
        "null"
      ],
      "default": null,
      "description": "Scoped bindings available to children. Values are template strings."
    },
    "title": {
      "type": [
        "string",
        "null"
      ],
      "default": null,
      "description": "Dialog header title"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "default": null,
      "description": "Dialog header description"
    },
    "name": {
      "type": [
        "string",
        "null"
      ],
      "default": null,
      "description": "State key to bind open/close state. When set, the dialog can be opened programmatically via SetState(name, True)."
    },
    "dismissible": {
      "default": true,
      "description": "Whether the dialog can be closed by clicking outside or pressing Escape. When False, the user must use an explicit close action.",
      "type": "boolean"
    }
  },
  "required": [
    "type"
  ]
}