Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions modules/ROOT/partials/configuration/iframe_aria_text.adoc
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
[[iframe_aria_text]]
== `+iframe_aria_text+`

This option is used to customize the `+title+` attribute on the {productname} `+iframe+` element. For example:
This option sets the accessible name for the editable content area inside the {productname} `+iframe+`. The value is read by screen readers to help users identify the editor.

On most browsers, the value is applied as an `+aria-label+` on the `+<body>+` element inside the iframe document. For example:

[source,html]
----
<iframe title="Rich Text Area. Press ALT-0 for help."></iframe>
<body aria-label="Rich Text Area. Press ALT-0 for help."></body>
----

The `+title+` attribute is read by screen-readers to help users identify the editor. This option only applies to {productname} classic (iframe) mode and has no effect on xref:inline-editor-options.adoc#inline[`+inline+` editors].
This option only applies to {productname} classic (iframe) mode and has no effect on xref:inline-editor-options.adoc#inline[`+inline+` editors].

*Type:* `+String+`

Expand Down
Loading