Skip to main content

ariaLabel

Optional. Sets the accessible name of the form, which a screen reader announces

Usage​

ariaLabel?: string;

Example​

const form = new dhx.Form("form_container", {
ariaLabel: "Sign-up form",
rows: [
{ type: "input", name: "email", label: "Email" },
{ type: "button", name: "signup", text: "Sign up" }
]
});

The value is rendered as the aria-label attribute of the root element of the form, which has the form role. If the property is not set, the title of the form is used. If neither is set, the form has no accessible name.

Form controls have their own ariaLabel property. For example, see the Input properties.

Change log:

added in v9.4.2