From a0c58cfb86df170821b44410f9a43ee9b72f15f3 Mon Sep 17 00:00:00 2001 From: Vit Rozkovec Date: Tue, 5 Dec 2023 08:37:28 +0100 Subject: [PATCH] Replace .sr-only with .visually-hidden, use static Helper.screenReaderOnly class where applicable, fix SpinnerAjax(Button|Link) label rendering (#1010) * Only add class .sr-only when the label is empty - check in onConfigure * Update helper class name for screenReaderOnly content * Replace .sr-only -> .visually-hidden, use static Helper where applicable * rename all references from "srOnly" to "visuallyHidden" for consistency --- .../html/bootstrap/button/dropdown/SplitButton.html | 2 +- .../html/bootstrap/components/progress/Stack.html | 2 +- .../html/bootstrap/components/progress/Stack.java | 11 +++++++---- .../agilecoders/wicket/core/util/CssClassNames.java | 2 +- .../components/progress/ProgressBarTest.java | 3 ++- .../html/bootstrap/spinner/SpinnerAjaxButton.java | 9 +++++---- .../html/bootstrap/spinner/SpinnerAjaxLink.java | 11 +++++++++-- .../de/agilecoders/wicket/samples/pages/BasePage.html | 2 +- .../wicket/samples/pages/ComponentsPage.html | 4 ++-- .../agilecoders/wicket/samples/pages/SelectPage.html | 2 +- 10 files changed, 30 insertions(+), 18 deletions(-) diff --git a/bootstrap-core/src/main/java/de/agilecoders/wicket/core/markup/html/bootstrap/button/dropdown/SplitButton.html b/bootstrap-core/src/main/java/de/agilecoders/wicket/core/markup/html/bootstrap/button/dropdown/SplitButton.html index a3ee6ee99..aba0800b9 100644 --- a/bootstrap-core/src/main/java/de/agilecoders/wicket/core/markup/html/bootstrap/button/dropdown/SplitButton.html +++ b/bootstrap-core/src/main/java/de/agilecoders/wicket/core/markup/html/bootstrap/button/dropdown/SplitButton.html @@ -7,7 +7,7 @@
diff --git a/bootstrap-core/src/main/java/de/agilecoders/wicket/core/markup/html/bootstrap/components/progress/Stack.html b/bootstrap-core/src/main/java/de/agilecoders/wicket/core/markup/html/bootstrap/components/progress/Stack.html index ca52f5559..bbbdfba26 100644 --- a/bootstrap-core/src/main/java/de/agilecoders/wicket/core/markup/html/bootstrap/components/progress/Stack.html +++ b/bootstrap-core/src/main/java/de/agilecoders/wicket/core/markup/html/bootstrap/components/progress/Stack.html @@ -1,6 +1,6 @@ - + diff --git a/bootstrap-core/src/main/java/de/agilecoders/wicket/core/markup/html/bootstrap/components/progress/Stack.java b/bootstrap-core/src/main/java/de/agilecoders/wicket/core/markup/html/bootstrap/components/progress/Stack.java index 210c4aa03..b3de94faf 100644 --- a/bootstrap-core/src/main/java/de/agilecoders/wicket/core/markup/html/bootstrap/components/progress/Stack.java +++ b/bootstrap-core/src/main/java/de/agilecoders/wicket/core/markup/html/bootstrap/components/progress/Stack.java @@ -1,5 +1,6 @@ package de.agilecoders.wicket.core.markup.html.bootstrap.components.progress; +import org.apache.wicket.AttributeModifier; import org.apache.wicket.markup.ComponentTag; import org.apache.wicket.markup.head.IHeaderResponse; import org.apache.wicket.markup.head.OnDomReadyHeaderItem; @@ -9,6 +10,7 @@ import de.agilecoders.wicket.core.markup.html.bootstrap.utilities.BackgroundColorBehavior; import de.agilecoders.wicket.core.util.Attributes; +import de.agilecoders.wicket.core.util.CssClassNames.Helper; /** * Represents a stack of the progress bar. @@ -19,7 +21,7 @@ public class Stack extends GenericPanel { /** * A label for the stack's progress */ - private Label srOnly; + private Label visuallyHidden; /** * The color type of the stack @@ -56,8 +58,9 @@ public Stack(String id, IModel model) { protected void onInitialize() { super.onInitialize(); - srOnly = new Label("srOnly", createLabelModel()); - add(srOnly); + visuallyHidden = new Label("visuallyHidden", createLabelModel()); + visuallyHidden.add(AttributeModifier.append("class", Helper.visuallyHidden)); + add(visuallyHidden); } public BackgroundColorBehavior.Color color() { @@ -105,7 +108,7 @@ protected void onConfigure() { super.onConfigure(); if (labeled()) { - srOnly.setRenderBodyOnly(true); + visuallyHidden.setRenderBodyOnly(true); } } diff --git a/bootstrap-core/src/main/java/de/agilecoders/wicket/core/util/CssClassNames.java b/bootstrap-core/src/main/java/de/agilecoders/wicket/core/util/CssClassNames.java index 06acccd0c..17877e43b 100644 --- a/bootstrap-core/src/main/java/de/agilecoders/wicket/core/util/CssClassNames.java +++ b/bootstrap-core/src/main/java/de/agilecoders/wicket/core/util/CssClassNames.java @@ -236,7 +236,7 @@ public boolean contains(final String className) { @SuppressWarnings("UnusedDeclaration") public static final class Helper { public static final String clearfix = "clearfix"; - public static final String screenReaderOnly = "sr-only"; + public static final String visuallyHidden = "visually-hidden"; } @SuppressWarnings("UnusedDeclaration") diff --git a/bootstrap-core/src/test/java/de/agilecoders/wicket/core/markup/html/bootstrap/components/progress/ProgressBarTest.java b/bootstrap-core/src/test/java/de/agilecoders/wicket/core/markup/html/bootstrap/components/progress/ProgressBarTest.java index 5d2ba02a2..0e5f83638 100644 --- a/bootstrap-core/src/test/java/de/agilecoders/wicket/core/markup/html/bootstrap/components/progress/ProgressBarTest.java +++ b/bootstrap-core/src/test/java/de/agilecoders/wicket/core/markup/html/bootstrap/components/progress/ProgressBarTest.java @@ -7,6 +7,7 @@ import de.agilecoders.wicket.core.WicketApplicationTest; import de.agilecoders.wicket.core.markup.html.bootstrap.utilities.BackgroundColorBehavior; +import de.agilecoders.wicket.core.util.CssClassNames.Helper; /** * Tests for ProgressBar @@ -58,7 +59,7 @@ void progressBarWithDefaultStackMarkup() { assertEquals("" + ProgressBar.MIN, stackTester.getAttribute("aria-valuemin")); assertEquals("" + ProgressBar.MAX, stackTester.getAttribute("aria-valuemax")); - TagTester stackLabelTester = stackTester.getChild("class", "sr-only"); + TagTester stackLabelTester = stackTester.getChild("class", Helper.visuallyHidden); assertEquals("" + progress + "%", stackLabelTester.getValue()); } diff --git a/bootstrap-extensions/src/main/java/de/agilecoders/wicket/extensions/markup/html/bootstrap/spinner/SpinnerAjaxButton.java b/bootstrap-extensions/src/main/java/de/agilecoders/wicket/extensions/markup/html/bootstrap/spinner/SpinnerAjaxButton.java index 887d6299e..ad72087d1 100644 --- a/bootstrap-extensions/src/main/java/de/agilecoders/wicket/extensions/markup/html/bootstrap/spinner/SpinnerAjaxButton.java +++ b/bootstrap-extensions/src/main/java/de/agilecoders/wicket/extensions/markup/html/bootstrap/spinner/SpinnerAjaxButton.java @@ -11,6 +11,7 @@ import de.agilecoders.wicket.core.markup.html.bootstrap.button.BootstrapAjaxButton; import de.agilecoders.wicket.core.markup.html.bootstrap.button.Buttons; +import de.agilecoders.wicket.core.util.CssClassNames.Helper; /** * A specialization of {@link de.agilecoders.wicket.core.markup.html.bootstrap.button.BootstrapAjaxButton} @@ -103,11 +104,11 @@ protected void updateAjaxAttributes(AjaxRequestAttributes attributes) { } @Override - protected Component newLabel(String markupId, IModel model) { - Component label = super.newLabel(markupId, model); + protected void onConfigure() { + super.onConfigure(); + Component label = get("label"); if (Strings.isEmpty(label.getDefaultModelObjectAsString())) { - label.add(AttributeModifier.append("class", "sr-only")); + label.add(AttributeModifier.append("class", Helper.visuallyHidden)); } - return label; } } diff --git a/bootstrap-extensions/src/main/java/de/agilecoders/wicket/extensions/markup/html/bootstrap/spinner/SpinnerAjaxLink.java b/bootstrap-extensions/src/main/java/de/agilecoders/wicket/extensions/markup/html/bootstrap/spinner/SpinnerAjaxLink.java index b95410ff8..19a0d55bf 100644 --- a/bootstrap-extensions/src/main/java/de/agilecoders/wicket/extensions/markup/html/bootstrap/spinner/SpinnerAjaxLink.java +++ b/bootstrap-extensions/src/main/java/de/agilecoders/wicket/extensions/markup/html/bootstrap/spinner/SpinnerAjaxLink.java @@ -10,6 +10,7 @@ import de.agilecoders.wicket.core.markup.html.bootstrap.button.BootstrapAjaxLink; import de.agilecoders.wicket.core.markup.html.bootstrap.button.Buttons; +import de.agilecoders.wicket.core.util.CssClassNames.Helper; /** * A specialization of {@link de.agilecoders.wicket.core.markup.html.bootstrap.button.BootstrapAjaxLink} @@ -94,9 +95,15 @@ protected void updateAjaxAttributes(AjaxRequestAttributes attributes) { protected Component newLabel(String markupId, IModel model) { Component label = super.newLabel(markupId, model); label.setRenderBodyOnly(false); + return label; + } + + @Override + protected void onConfigure() { + super.onConfigure(); + Component label = get("label"); if (Strings.isEmpty(label.getDefaultModelObjectAsString())) { - label.add(AttributeModifier.append("class", "sr-only")); + label.add(AttributeModifier.append("class", Helper.visuallyHidden)); } - return label; } } diff --git a/bootstrap-samples/src/main/java/de/agilecoders/wicket/samples/pages/BasePage.html b/bootstrap-samples/src/main/java/de/agilecoders/wicket/samples/pages/BasePage.html index 7b1e525b9..fc1c3a83a 100644 --- a/bootstrap-samples/src/main/java/de/agilecoders/wicket/samples/pages/BasePage.html +++ b/bootstrap-samples/src/main/java/de/agilecoders/wicket/samples/pages/BasePage.html @@ -13,7 +13,7 @@ - Skip navigation +
diff --git a/bootstrap-samples/src/main/java/de/agilecoders/wicket/samples/pages/ComponentsPage.html b/bootstrap-samples/src/main/java/de/agilecoders/wicket/samples/pages/ComponentsPage.html index 74e6cd01c..ce13e6ffe 100644 --- a/bootstrap-samples/src/main/java/de/agilecoders/wicket/samples/pages/ComponentsPage.html +++ b/bootstrap-samples/src/main/java/de/agilecoders/wicket/samples/pages/ComponentsPage.html @@ -1538,14 +1538,14 @@

Pills

Submit - unread messages + 
             <button wicket:id="badge-button">
                 Submit <span wicket:id="button-count"></span>
-                <span class="sr-only">unread messages</span>
+                <span class="visually-hidden">unread messages</span>
             </button>
diff --git a/bootstrap-samples/src/main/java/de/agilecoders/wicket/samples/pages/SelectPage.html b/bootstrap-samples/src/main/java/de/agilecoders/wicket/samples/pages/SelectPage.html index 3b571ecf0..2b357fcd6 100644 --- a/bootstrap-samples/src/main/java/de/agilecoders/wicket/samples/pages/SelectPage.html +++ b/bootstrap-samples/src/main/java/de/agilecoders/wicket/samples/pages/SelectPage.html @@ -82,7 +82,7 @@

Example