Skip to content

Commit 03164dd

Browse files
authored
Merge branch 'master' into develop
2 parents 98682bc + 189fc04 commit 03164dd

2 files changed

Lines changed: 5 additions & 3 deletions

File tree

src/components.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ export namespace Components {
155155
*/
156156
'hosted'?: boolean;
157157
/**
158-
* Whether to include a screen reader (SR) heading for the player. Set to `false` in contexts where an SR heading would be redundant or counter-indicated (e.g. the player is already labelled by a surrounding landmark, or the host page manages its own heading structure). Defaults to `true` so that assistive-technology users get a navigable heading out of the box.
158+
* Whether to inject a visually-hidden (screen-reader-only) heading at the top of the player's rendered content. Set to `false` in contexts where an SR heading would be redundant or counter-indicated (e.g. the player is already labelled by a surrounding landmark, or the host page manages its own heading structure). Defaults to `true` so that assistive-technology users get a navigable heading out of the box.
159159
*/
160160
'includeSrHeading': boolean;
161161
/**
@@ -382,7 +382,7 @@ declare namespace LocalJSX {
382382
*/
383383
'hosted'?: boolean;
384384
/**
385-
* Whether to include a screen reader (SR) heading for the player. Set to `false` in contexts where an SR heading would be redundant or counter-indicated (e.g. the player is already labelled by a surrounding landmark, or the host page manages its own heading structure). Defaults to `true` so that assistive-technology users get a navigable heading out of the box.
385+
* Whether to inject a visually-hidden (screen-reader-only) heading at the top of the player's rendered content. Set to `false` in contexts where an SR heading would be redundant or counter-indicated (e.g. the player is already labelled by a surrounding landmark, or the host page manages its own heading structure). Defaults to `true` so that assistive-technology users get a navigable heading out of the box.
386386
*/
387387
'includeSrHeading'?: boolean;
388388
/**

src/components/pie-player/pie-player.tsx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,9 @@ export class Player {
220220
@Prop() baseHeadingLevel?: 1 | 2 | 3 | 4 | 5 | 6;
221221

222222
/**
223-
* Whether to include a screen reader (SR) heading for the player.
223+
* Whether to inject a visually-hidden (screen-reader-only) heading at the
224+
* top of the player's rendered content.
225+
*
224226
* Set to `false` in contexts where an SR heading would be redundant or
225227
* counter-indicated (e.g. the player is already labelled by a surrounding
226228
* landmark, or the host page manages its own heading structure).

0 commit comments

Comments
 (0)