Skip to content

Commit

Permalink
MDL-81825 core: Replace sr_text() with visually_hidden_text()
Browse files Browse the repository at this point in the history
In core renderer, replace 'sr_text' method with 'visually_hidden_text' to be
consistent with Bootstrap 5 upgrade.
  • Loading branch information
roland04 committed Nov 11, 2024
1 parent b44f9ec commit 0dc1076
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 4 deletions.
7 changes: 7 additions & 0 deletions .upgradenotes/MDL-81825-2024110812525353.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
issueNumber: MDL-81825
notes:
core:
- message: >-
The 'core_renderer::sr_text()' function has been deprecated, use
'core_renderer::visually_hidden_text()' instead.
type: deprecated
2 changes: 1 addition & 1 deletion backup/util/ui/backup_ui_setting.class.php
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ public function get_visually_hidden_label(): ?string {
return null;
}
$renderer = $PAGE->get_renderer('core_backup');
return $renderer->sr_text($this->altlabel);
return $renderer->visually_hidden_text($this->altlabel);
}

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ protected function get_dropdown_data(
\renderer_base $output,
choicelist $choice,
): stdClass {
$badgetext = $output->sr_text(get_string('availability'));
$badgetext = $output->visually_hidden_text(get_string('availability'));

if (!$this->mod->visible) {
$badgetext .= get_string('hiddenfromstudents');
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ protected function is_section_visibility_editable(): bool {
* @return array
*/
protected function get_visibility_dropdown(\renderer_base $output): array {
$badgetext = $output->sr_text(get_string('availability'));
$badgetext = $output->visually_hidden_text(get_string('availability'));
$badgetext .= get_string('hiddenfromstudents');
$icon = $this->get_icon('hide');

Expand Down
16 changes: 15 additions & 1 deletion lib/classes/output/core_renderer.php
Original file line number Diff line number Diff line change
Expand Up @@ -2952,12 +2952,26 @@ public function paragraph(string $contents, ?string $classes = null, ?string $id
*
* @param string $contents The contents of the paragraph
* @return string the HTML to output.
* @deprecated since 5.0. Use visually_hidden_text() instead.
* @todo Final deprecation in Moodle 6.0. See MDL-83671.
*/
#[\core\attribute\deprecated('core_renderer::visually_hidden_text()', since: '5.0', mdl: 'MDL-81825')]
public function sr_text(string $contents): string {
\core\deprecation::emit_deprecation_if_present([$this, __FUNCTION__]);
return $this->visually_hidden_text($contents);
}

/**
* Outputs a visually hidden inline text (but accessible to assistive technologies).
*
* @param string $contents The contents of the paragraph
* @return string the HTML to output.
*/
public function visually_hidden_text(string $contents): string {
return html_writer::tag(
'span',
$contents,
['class' => 'sr-only']
['class' => 'visually-hidden']
) . ' ';
}

Expand Down

0 comments on commit 0dc1076

Please sign in to comment.