Skip to content

Commit 06bc4f1

Browse files
committed
DOC-2614: Docs: Update iframe_aria_text description to clarify aria-label usage
1 parent 5cb4ceb commit 06bc4f1

1 file changed

Lines changed: 6 additions & 3 deletions

File tree

modules/ROOT/partials/configuration/iframe_aria_text.adoc

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
[[iframe_aria_text]]
22
== `+iframe_aria_text+`
33

4-
This option is used to customize the `+title+` attribute on the {productname} `+iframe+` element. For example:
4+
This option is used to update the `+aria-label+` applied to the editor content inside the {product name} `+iframe+`.
5+
6+
The value is set as an `aria-label` on the `<body>` element inside the {product name} iframe document. For example:
57

68
[source,html]
79
----
8-
<iframe title="Rich Text Area. Press ALT-0 for help."></iframe>
10+
<body aria-label="Rich Text Area. Press ALT-0 for help."></body>
911
----
1012

11-
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].
13+
Note:
14+
The iframe `+title+` attribute is not modified by this option and remains a fixed value ("Rich Text Area").
1215

1316
*Type:* `+String+`
1417

0 commit comments

Comments
 (0)