You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
DOC-2614: Correct iframe_aria_text description to reflect aria-label behavior
Describe the option as setting the editor's accessible name via the body
aria-label, fix the {productname} attribute, and restore the iframe-mode
scope note. Removes the inaccurate claim that the iframe title is unchanged.
Copy file name to clipboardExpand all lines: modules/ROOT/partials/configuration/iframe_aria_text.adoc
+3-4Lines changed: 3 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,17 +1,16 @@
1
1
[[iframe_aria_text]]
2
2
== `+iframe_aria_text+`
3
3
4
-
This option is used to update the `+aria-label+` applied to the editor content inside the {product name} `+iframe+`.
4
+
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.
5
5
6
-
The value is set as an `aria-label` on the `<body>` element inside the {product name} iframe document. For example:
6
+
On most browsers, the value is applied as an `+aria-label+` on the `+<body>+` element inside the iframe document. For example:
7
7
8
8
[source,html]
9
9
----
10
10
<body aria-label="Rich Text Area. Press ALT-0 for help."></body>
11
11
----
12
12
13
-
Note:
14
-
The iframe `+title+` attribute is not modified by this option and remains a fixed value ("Rich Text Area").
13
+
This option only applies to {productname} classic (iframe) mode and has no effect on xref:inline-editor-options.adoc#inline[`+inline+` editors].
0 commit comments