DayPilot.Modal.ariaLabel

The ariaLabel property (string) sets a custom accessible name for a Modal dialog.

Availability

• DayPilot Lite for JavaScript: version 2026.4.895 and later.
• DayPilot Pro for JavaScript: version 2026.4.7147 and later.

Declaration

DayPilot.Modal.ariaLabel

Default Value

null

Notes

Pass this property in the options object accepted by form() and the other Modal helper methods, or set it on a DayPilot.Modal instance. A nonempty string overrides the automatically derived name. Empty or whitespace-only values keep automatic naming.

Without a custom value, the dialog uses its form title, message content or heading when available, and otherwise uses "Dialog". To display a visible heading in a form, add a field with type: "title"; the accessible name itself does not create visible content.

Example

const form = [{name: "Name", id: "name"}];
const data = {name: "Planning"};
const options = {ariaLabel: "Edit reservation"};
const args = await DayPilot.Modal.form(form, data, options);
if (!args.canceled) {
  console.log(args.result.name);
}

See Also

Modal Properties

Modal.form()

Modal Class