View source for Template:Screen reader-only/doc

{{Documentation subpage}}
{{Template redirect|sronly}}
{{uses TemplateStyles|Template:Screen reader-only/styles.css|noprotcat=yes}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
== Screen reader only ==
The text supplied as the sole unnamed parameter is not to be displayed in a browser, but should be voiced by a screen reader.

<code><nowiki>First part. {{Screen reader-only|Second part only for a screen reader.}} Third part.</nowiki></code> → First part. {{Screen reader-only|Second part only for a screen reader.}} Third part.

== Usage ==
This template should only be used to hide text from sighted readers when that text substantially duplicates adjacent text that is visible.

=== Table captions ===
The main usage case is when a table is placed immediately below a heading, where the heading is effectively identical to the table's caption. This template may be used to hide the caption from a sighted reader (as it would be duplicative), while allowing a screen reader to hear the caption{{snd}} for example, if the screen reader reads a list of tables in the article to allow navigation directly to a particular table.

If the table is moved to another location away from the heading, then this template should be removed to allow sighted readers to see the table caption. This is a requirement of [https://www.w3.org/TR/WCAG21/#info-and-relationships WCAG 1.3.1].

== Example ==
The table below has a caption "Example table" that will be voiced by a screen reader.

<code><nowiki>|+ {{Screen reader-only|Example table}}</nowiki></code>

=== Example table ===
{| class="wikitable"
|+ {{Screen reader-only|Example table}}
|-
! scope="col" | Header
! scope="col" | Information
|-
! scope="row" | Row hdr 1
| data 1
|-
! scope="row" | Row hdr 2
| data 2
|-
! scope="row" | Row hdr 3
| data 3
|}

=== TemplateData ===
{{TemplateData header|noheader=yes}}
<templatedata>
{
	"params": {
		"1": {
			"label": "Text",
			"type": "string",
			"required": true
		}
	},
	"format": "inline",
	"description": "The text supplied is not to be displayed in a browser, but should be voiced by a screen reader."
}
</templatedata>

<includeonly>{{sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Wikipedia templates that change text based on client state]]
}}</includeonly>