Skip to content

Commit 927e9a0

Browse files
feat: make TextFieldBase implement HasAriaLabel (#4835)
Co-authored-by: Serhii Kulykov <iamkulykov@gmail.com>
1 parent d4273b3 commit 927e9a0

8 files changed

Lines changed: 245 additions & 1 deletion

File tree

‎vaadin-text-field-flow-parent/vaadin-text-field-flow/src/main/java/com/vaadin/flow/component/textfield/TextFieldBase.java‎

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
import com.vaadin.flow.component.Component;
2020
import com.vaadin.flow.component.CompositionNotifier;
2121
import com.vaadin.flow.component.Focusable;
22+
import com.vaadin.flow.component.HasAriaLabel;
2223
import com.vaadin.flow.component.HasLabel;
2324
import com.vaadin.flow.component.HasHelper;
2425
import com.vaadin.flow.component.HasSize;
@@ -36,6 +37,8 @@
3637
import com.vaadin.flow.function.SerializableBiFunction;
3738
import com.vaadin.flow.function.SerializableFunction;
3839

40+
import java.util.Optional;
41+
3942
/**
4043
* Internal class that provides base functionality for input field components,
4144
* such as {@link TextField}. Not intended to be used publicly.
@@ -47,7 +50,7 @@
4750
*/
4851
public abstract class TextFieldBase<TComponent extends TextFieldBase<TComponent, TValue>, TValue>
4952
extends AbstractSinglePropertyField<TComponent, TValue>
50-
implements CompositionNotifier, Focusable<TComponent>,
53+
implements CompositionNotifier, Focusable<TComponent>, HasAriaLabel,
5154
HasAutocapitalize, HasAutocomplete, HasAutocorrect, HasClearButton,
5255
HasClientValidation, HasHelper, HasLabel, HasPrefixAndSuffix, HasSize,
5356
HasStyle, HasTooltip, HasValidationProperties, HasValidator<TValue>,
@@ -196,6 +199,32 @@ public boolean isRequired() {
196199
return getElement().getProperty("required", false);
197200
}
198201

202+
@Override
203+
public void setLabel(String label) {
204+
HasLabel.super.setLabel(label);
205+
}
206+
207+
@Override
208+
public void setAriaLabel(String ariaLabel) {
209+
getElement().setProperty("accessibleName", ariaLabel);
210+
}
211+
212+
@Override
213+
public Optional<String> getAriaLabel() {
214+
return Optional.ofNullable(getElement().getProperty("accessibleName"));
215+
}
216+
217+
@Override
218+
public void setAriaLabelledBy(String labelledBy) {
219+
getElement().setProperty("accessibleNameRef", labelledBy);
220+
}
221+
222+
@Override
223+
public Optional<String> getAriaLabelledBy() {
224+
return Optional
225+
.ofNullable(getElement().getProperty("accessibleNameRef"));
226+
}
227+
199228
/**
200229
* Adds the given components as children of this component at the slot
201230
* 'prefix'.

‎vaadin-text-field-flow-parent/vaadin-text-field-flow/src/test/java/com/vaadin/flow/component/textfield/tests/BigDecimalFieldTest.java‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
*/
1616
package com.vaadin.flow.component.textfield.tests;
1717

18+
import com.vaadin.flow.component.HasAriaLabel;
1819
import com.vaadin.flow.component.shared.HasTooltip;
1920
import com.vaadin.flow.component.textfield.BigDecimalField;
2021
import com.vaadin.flow.component.textfield.TextFieldVariant;
@@ -123,4 +124,33 @@ private void assertValueFormatting(BigDecimal bigDecimal,
123124
field.getElement().getProperty("value"));
124125
}
125126

127+
@Test
128+
public void implementHasAriaLabel() {
129+
BigDecimalField field = new BigDecimalField();
130+
Assert.assertTrue(field instanceof HasAriaLabel);
131+
}
132+
133+
@Test
134+
public void setAriaLabel() {
135+
BigDecimalField field = new BigDecimalField();
136+
137+
field.setAriaLabel("aria-label");
138+
Assert.assertTrue(field.getAriaLabel().isPresent());
139+
Assert.assertEquals("aria-label", field.getAriaLabel().get());
140+
141+
field.setAriaLabel(null);
142+
Assert.assertTrue(field.getAriaLabel().isEmpty());
143+
}
144+
145+
@Test
146+
public void setAriaLabelledBy() {
147+
BigDecimalField field = new BigDecimalField();
148+
149+
field.setAriaLabelledBy("aria-labelledby");
150+
Assert.assertTrue(field.getAriaLabelledBy().isPresent());
151+
Assert.assertEquals("aria-labelledby", field.getAriaLabelledBy().get());
152+
153+
field.setAriaLabelledBy(null);
154+
Assert.assertTrue(field.getAriaLabelledBy().isEmpty());
155+
}
126156
}

‎vaadin-text-field-flow-parent/vaadin-text-field-flow/src/test/java/com/vaadin/flow/component/textfield/tests/EmailFieldTest.java‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
*/
1616
package com.vaadin.flow.component.textfield.tests;
1717

18+
import com.vaadin.flow.component.HasAriaLabel;
1819
import com.vaadin.flow.component.shared.HasAllowedCharPattern;
1920
import com.vaadin.flow.component.shared.HasTooltip;
2021
import com.vaadin.flow.component.textfield.EmailField;
@@ -95,4 +96,34 @@ public void implementsHasTooltip() {
9596
EmailField field = new EmailField();
9697
Assert.assertTrue(field instanceof HasTooltip);
9798
}
99+
100+
@Test
101+
public void implementHasAriaLabel() {
102+
EmailField field = new EmailField();
103+
Assert.assertTrue(field instanceof HasAriaLabel);
104+
}
105+
106+
@Test
107+
public void setAriaLabel() {
108+
EmailField field = new EmailField();
109+
110+
field.setAriaLabel("aria-label");
111+
Assert.assertTrue(field.getAriaLabel().isPresent());
112+
Assert.assertEquals("aria-label", field.getAriaLabel().get());
113+
114+
field.setAriaLabel(null);
115+
Assert.assertTrue(field.getAriaLabel().isEmpty());
116+
}
117+
118+
@Test
119+
public void setAriaLabelledBy() {
120+
EmailField field = new EmailField();
121+
122+
field.setAriaLabelledBy("aria-labelledby");
123+
Assert.assertTrue(field.getAriaLabelledBy().isPresent());
124+
Assert.assertEquals("aria-labelledby", field.getAriaLabelledBy().get());
125+
126+
field.setAriaLabelledBy(null);
127+
Assert.assertTrue(field.getAriaLabelledBy().isEmpty());
128+
}
98129
}

‎vaadin-text-field-flow-parent/vaadin-text-field-flow/src/test/java/com/vaadin/flow/component/textfield/tests/IntegerFieldTest.java‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
*/
1616
package com.vaadin.flow.component.textfield.tests;
1717

18+
import com.vaadin.flow.component.HasAriaLabel;
1819
import com.vaadin.flow.component.shared.HasTooltip;
1920
import com.vaadin.flow.component.textfield.IntegerField;
2021
import com.vaadin.flow.component.textfield.TextFieldVariant;
@@ -183,4 +184,33 @@ private void assertInvalidValues(Integer... values) {
183184
});
184185
}
185186

187+
@Test
188+
public void implementHasAriaLabel() {
189+
IntegerField field = new IntegerField();
190+
Assert.assertTrue(field instanceof HasAriaLabel);
191+
}
192+
193+
@Test
194+
public void setAriaLabel() {
195+
IntegerField field = new IntegerField();
196+
197+
field.setAriaLabel("aria-label");
198+
Assert.assertTrue(field.getAriaLabel().isPresent());
199+
Assert.assertEquals("aria-label", field.getAriaLabel().get());
200+
201+
field.setAriaLabel(null);
202+
Assert.assertTrue(field.getAriaLabel().isEmpty());
203+
}
204+
205+
@Test
206+
public void setAriaLabelledBy() {
207+
IntegerField field = new IntegerField();
208+
209+
field.setAriaLabelledBy("aria-labelledby");
210+
Assert.assertTrue(field.getAriaLabelledBy().isPresent());
211+
Assert.assertEquals("aria-labelledby", field.getAriaLabelledBy().get());
212+
213+
field.setAriaLabelledBy(null);
214+
Assert.assertTrue(field.getAriaLabelledBy().isEmpty());
215+
}
186216
}

‎vaadin-text-field-flow-parent/vaadin-text-field-flow/src/test/java/com/vaadin/flow/component/textfield/tests/NumberFieldTest.java‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
*/
1616
package com.vaadin.flow.component.textfield.tests;
1717

18+
import com.vaadin.flow.component.HasAriaLabel;
1819
import com.vaadin.flow.component.shared.HasAllowedCharPattern;
1920
import com.vaadin.flow.component.shared.HasTooltip;
2021
import com.vaadin.flow.component.textfield.NumberField;
@@ -225,4 +226,34 @@ public void implementsHasAllowedCharPattern() {
225226
HasAllowedCharPattern.class
226227
.isAssignableFrom(new NumberField().getClass()));
227228
}
229+
230+
@Test
231+
public void implementHasAriaLabel() {
232+
NumberField field = new NumberField();
233+
Assert.assertTrue(field instanceof HasAriaLabel);
234+
}
235+
236+
@Test
237+
public void setAriaLabel() {
238+
NumberField field = new NumberField();
239+
240+
field.setAriaLabel("aria-label");
241+
Assert.assertTrue(field.getAriaLabel().isPresent());
242+
Assert.assertEquals("aria-label", field.getAriaLabel().get());
243+
244+
field.setAriaLabel(null);
245+
Assert.assertTrue(field.getAriaLabel().isEmpty());
246+
}
247+
248+
@Test
249+
public void setAriaLabelledBy() {
250+
NumberField field = new NumberField();
251+
252+
field.setAriaLabelledBy("aria-labelledby");
253+
Assert.assertTrue(field.getAriaLabelledBy().isPresent());
254+
Assert.assertEquals("aria-labelledby", field.getAriaLabelledBy().get());
255+
256+
field.setAriaLabelledBy(null);
257+
Assert.assertTrue(field.getAriaLabelledBy().isEmpty());
258+
}
228259
}

‎vaadin-text-field-flow-parent/vaadin-text-field-flow/src/test/java/com/vaadin/flow/component/textfield/tests/PasswordFieldTest.java‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
*/
1616
package com.vaadin.flow.component.textfield.tests;
1717

18+
import com.vaadin.flow.component.HasAriaLabel;
1819
import com.vaadin.flow.component.shared.HasAllowedCharPattern;
1920
import com.vaadin.flow.component.textfield.PasswordField;
2021
import com.vaadin.flow.component.textfield.TextFieldVariant;
@@ -120,4 +121,34 @@ public void implementsHasAllowedCharPattern() {
120121
HasAllowedCharPattern.class
121122
.isAssignableFrom(new PasswordField().getClass()));
122123
}
124+
125+
@Test
126+
public void implementHasAriaLabel() {
127+
PasswordField field = new PasswordField();
128+
Assert.assertTrue(field instanceof HasAriaLabel);
129+
}
130+
131+
@Test
132+
public void setAriaLabel() {
133+
PasswordField field = new PasswordField();
134+
135+
field.setAriaLabel("aria-label");
136+
Assert.assertTrue(field.getAriaLabel().isPresent());
137+
Assert.assertEquals("aria-label", field.getAriaLabel().get());
138+
139+
field.setAriaLabel(null);
140+
Assert.assertTrue(field.getAriaLabel().isEmpty());
141+
}
142+
143+
@Test
144+
public void setAriaLabelledBy() {
145+
PasswordField field = new PasswordField();
146+
147+
field.setAriaLabelledBy("aria-labelledby");
148+
Assert.assertTrue(field.getAriaLabelledBy().isPresent());
149+
Assert.assertEquals("aria-labelledby", field.getAriaLabelledBy().get());
150+
151+
field.setAriaLabelledBy(null);
152+
Assert.assertTrue(field.getAriaLabelledBy().isEmpty());
153+
}
123154
}

‎vaadin-text-field-flow-parent/vaadin-text-field-flow/src/test/java/com/vaadin/flow/component/textfield/tests/TextAreaTest.java‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
*/
1616
package com.vaadin.flow.component.textfield.tests;
1717

18+
import com.vaadin.flow.component.HasAriaLabel;
1819
import com.vaadin.flow.component.shared.HasAllowedCharPattern;
1920
import com.vaadin.flow.component.shared.HasTooltip;
2021
import com.vaadin.flow.component.textfield.TextArea;
@@ -138,4 +139,34 @@ public void implementsHasTooltip() {
138139
TextArea textArea = new TextArea();
139140
Assert.assertTrue(textArea instanceof HasTooltip);
140141
}
142+
143+
@Test
144+
public void implementHasAriaLabel() {
145+
TextArea field = new TextArea();
146+
Assert.assertTrue(field instanceof HasAriaLabel);
147+
}
148+
149+
@Test
150+
public void setAriaLabel() {
151+
TextArea field = new TextArea();
152+
153+
field.setAriaLabel("aria-label");
154+
Assert.assertTrue(field.getAriaLabel().isPresent());
155+
Assert.assertEquals("aria-label", field.getAriaLabel().get());
156+
157+
field.setAriaLabel(null);
158+
Assert.assertTrue(field.getAriaLabel().isEmpty());
159+
}
160+
161+
@Test
162+
public void setAriaLabelledBy() {
163+
TextArea field = new TextArea();
164+
165+
field.setAriaLabelledBy("aria-labelledby");
166+
Assert.assertTrue(field.getAriaLabelledBy().isPresent());
167+
Assert.assertEquals("aria-labelledby", field.getAriaLabelledBy().get());
168+
169+
field.setAriaLabelledBy(null);
170+
Assert.assertTrue(field.getAriaLabelledBy().isEmpty());
171+
}
141172
}

‎vaadin-text-field-flow-parent/vaadin-text-field-flow/src/test/java/com/vaadin/flow/component/textfield/tests/TextFieldTest.java‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
*/
1616
package com.vaadin.flow.component.textfield.tests;
1717

18+
import com.vaadin.flow.component.HasAriaLabel;
1819
import com.vaadin.flow.component.shared.HasAllowedCharPattern;
1920
import com.vaadin.flow.component.shared.HasTooltip;
2021
import com.vaadin.flow.component.textfield.TextField;
@@ -127,4 +128,34 @@ public void implementsHasTooltip() {
127128
TextField field = new TextField();
128129
Assert.assertTrue(field instanceof HasTooltip);
129130
}
131+
132+
@Test
133+
public void implementHasAriaLabel() {
134+
TextField field = new TextField();
135+
Assert.assertTrue(field instanceof HasAriaLabel);
136+
}
137+
138+
@Test
139+
public void setAriaLabel() {
140+
TextField field = new TextField();
141+
142+
field.setAriaLabel("aria-label");
143+
Assert.assertTrue(field.getAriaLabel().isPresent());
144+
Assert.assertEquals("aria-label", field.getAriaLabel().get());
145+
146+
field.setAriaLabel(null);
147+
Assert.assertTrue(field.getAriaLabel().isEmpty());
148+
}
149+
150+
@Test
151+
public void setAriaLabelledBy() {
152+
TextField field = new TextField();
153+
154+
field.setAriaLabelledBy("aria-labelledby");
155+
Assert.assertTrue(field.getAriaLabelledBy().isPresent());
156+
Assert.assertEquals("aria-labelledby", field.getAriaLabelledBy().get());
157+
158+
field.setAriaLabelledBy(null);
159+
Assert.assertTrue(field.getAriaLabelledBy().isEmpty());
160+
}
130161
}

0 commit comments

Comments
 (0)