Skip to content

Commit cb82965

Browse files
authored
feat: replace toolbar buttons title with tooltips (#4423)
1 parent 01f76e7 commit cb82965

5 files changed

Lines changed: 57 additions & 46 deletions

File tree

‎packages/rich-text-editor/package.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@
4444
"@vaadin/component-base": "23.3.0-alpha0",
4545
"@vaadin/confirm-dialog": "23.3.0-alpha0",
4646
"@vaadin/text-field": "23.3.0-alpha0",
47+
"@vaadin/tooltip": "23.3.0-alpha0",
4748
"@vaadin/vaadin-lumo-styles": "23.3.0-alpha0",
4849
"@vaadin/vaadin-material-styles": "23.3.0-alpha0",
4950
"@vaadin/vaadin-themable-mixin": "23.3.0-alpha0"

‎packages/rich-text-editor/src/vaadin-rich-text-editor.js‎

Lines changed: 48 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
import '@vaadin/button/src/vaadin-button.js';
77
import '@vaadin/confirm-dialog/src/vaadin-confirm-dialog.js';
88
import '@vaadin/text-field/src/vaadin-text-field.js';
9+
import '@vaadin/tooltip/src/vaadin-tooltip.js';
910
import '../vendor/vaadin-quill.js';
1011
import './vaadin-rich-text-editor-toolbar-styles.js';
1112
import { html, PolymerElement } from '@polymer/polymer/polymer-element.js';
@@ -156,166 +157,168 @@ class RichTextEditor extends ElementMixin(ThemableMixin(PolymerElement)) {
156157
<div part="toolbar">
157158
<span part="toolbar-group toolbar-group-history">
158159
<!-- Undo and Redo -->
159-
<button
160-
type="button"
161-
part="toolbar-button toolbar-button-undo"
162-
on-click="_undo"
163-
title$="[[i18n.undo]]"
164-
></button>
165-
<button
166-
type="button"
167-
part="toolbar-button toolbar-button-redo"
168-
on-click="_redo"
169-
title$="[[i18n.redo]]"
170-
></button>
160+
<button id="btn-undo" type="button" part="toolbar-button toolbar-button-undo" on-click="_undo"></button>
161+
<vaadin-tooltip for="btn-undo" text="[[i18n.undo]]"></vaadin-tooltip>
162+
163+
<button id="btn-redo" type="button" part="toolbar-button toolbar-button-redo" on-click="_redo"></button>
164+
<vaadin-tooltip for="btn-redo" text="[[i18n.redo]]"></vaadin-tooltip>
171165
</span>
172166
173167
<span part="toolbar-group toolbar-group-emphasis">
174168
<!-- Bold -->
175-
<button class="ql-bold" part="toolbar-button toolbar-button-bold" title$="[[i18n.bold]]"></button>
169+
<button id="btn-bold" class="ql-bold" part="toolbar-button toolbar-button-bold"></button>
170+
<vaadin-tooltip for="btn-bold" text="[[i18n.bold]]"></vaadin-tooltip>
176171
177172
<!-- Italic -->
178-
<button class="ql-italic" part="toolbar-button toolbar-button-italic" title$="[[i18n.italic]]"></button>
173+
<button id="btn-italic" class="ql-italic" part="toolbar-button toolbar-button-italic"></button>
174+
<vaadin-tooltip for="btn-italic" text="[[i18n.italic]]"></vaadin-tooltip>
179175
180176
<!-- Underline -->
181-
<button
182-
class="ql-underline"
183-
part="toolbar-button toolbar-button-underline"
184-
title$="[[i18n.underline]]"
185-
></button>
177+
<button id="btn-underline" class="ql-underline" part="toolbar-button toolbar-button-underline"></button>
178+
<vaadin-tooltip for="btn-underline" text="[[i18n.underline]]"></vaadin-tooltip>
186179
187180
<!-- Strike -->
188-
<button class="ql-strike" part="toolbar-button toolbar-button-strike" title$="[[i18n.strike]]"></button>
181+
<button id="btn-strike" class="ql-strike" part="toolbar-button toolbar-button-strike"></button>
182+
<vaadin-tooltip for="btn-strike" text="[[i18n.strike]]"></vaadin-tooltip>
189183
</span>
190184
191185
<span part="toolbar-group toolbar-group-heading">
192186
<!-- Header buttons -->
193187
<button
188+
id="btn-h1"
194189
type="button"
195190
class="ql-header"
196191
value="1"
197192
part="toolbar-button toolbar-button-h1"
198-
title$="[[i18n.h1]]"
199193
></button>
194+
<vaadin-tooltip for="btn-h1" text="[[i18n.h1]]"></vaadin-tooltip>
200195
<button
196+
id="btn-h2"
201197
type="button"
202198
class="ql-header"
203199
value="2"
204200
part="toolbar-button toolbar-button-h2"
205-
title$="[[i18n.h2]]"
206201
></button>
202+
<vaadin-tooltip for="btn-h2" text="[[i18n.h2]]"></vaadin-tooltip>
207203
<button
204+
id="btn-h3"
208205
type="button"
209206
class="ql-header"
210207
value="3"
211208
part="toolbar-button toolbar-button-h3"
212-
title$="[[i18n.h3]]"
213209
></button>
210+
<vaadin-tooltip for="btn-h3" text="[[i18n.h3]]"></vaadin-tooltip>
214211
</span>
215212
216213
<span part="toolbar-group toolbar-group-glyph-transformation">
217214
<!-- Subscript and superscript -->
218215
<button
216+
id="btn-subscript"
219217
class="ql-script"
220218
value="sub"
221219
part="toolbar-button toolbar-button-subscript"
222-
title$="[[i18n.subscript]]"
223220
></button>
221+
<vaadin-tooltip for="btn-subscript" text="[[i18n.subscript]]"></vaadin-tooltip>
224222
<button
223+
id="btn-superscript"
225224
class="ql-script"
226225
value="super"
227226
part="toolbar-button toolbar-button-superscript"
228-
title$="[[i18n.superscript]]"
229227
></button>
228+
<vaadin-tooltip for="btn-superscript" text="[[i18n.superscript]]"></vaadin-tooltip>
230229
</span>
231230
232231
<span part="toolbar-group toolbar-group-list">
233232
<!-- List buttons -->
234233
<button
234+
id="btn-ol"
235235
type="button"
236236
class="ql-list"
237237
value="ordered"
238238
part="toolbar-button toolbar-button-list-ordered"
239-
title$="[[i18n.listOrdered]]"
240239
></button>
240+
<vaadin-tooltip for="btn-ol" text="[[i18n.listOrdered]]"></vaadin-tooltip>
241241
<button
242+
id="btn-ul"
242243
type="button"
243244
class="ql-list"
244245
value="bullet"
245246
part="toolbar-button toolbar-button-list-bullet"
246-
title$="[[i18n.listBullet]]"
247247
></button>
248+
<vaadin-tooltip for="btn-ul" text="[[i18n.listBullet]]"></vaadin-tooltip>
248249
</span>
249250
250251
<span part="toolbar-group toolbar-group-alignment">
251252
<!-- Align buttons -->
252253
<button
254+
id="btn-left"
253255
type="button"
254256
class="ql-align"
255257
value=""
256258
part="toolbar-button toolbar-button-align-left"
257-
title$="[[i18n.alignLeft]]"
258259
></button>
260+
<vaadin-tooltip for="btn-left" text="[[i18n.alignLeft]]"></vaadin-tooltip>
259261
<button
262+
id="btn-center"
260263
type="button"
261264
class="ql-align"
262265
value="center"
263266
part="toolbar-button toolbar-button-align-center"
264-
title$="[[i18n.alignCenter]]"
265267
></button>
268+
<vaadin-tooltip for="btn-center" text="[[i18n.alignCenter]]"></vaadin-tooltip>
266269
<button
270+
id="btn-right"
267271
type="button"
268272
class="ql-align"
269273
value="right"
270274
part="toolbar-button toolbar-button-align-right"
271-
title$="[[i18n.alignRight]]"
272275
></button>
276+
<vaadin-tooltip for="btn-right" text="[[i18n.alignRight]]"></vaadin-tooltip>
273277
</span>
274278
275279
<span part="toolbar-group toolbar-group-rich-text">
276280
<!-- Image -->
277281
<button
282+
id="btn-image"
278283
type="button"
279284
part="toolbar-button toolbar-button-image"
280-
title$="[[i18n.image]]"
281285
on-touchend="_onImageTouchEnd"
282286
on-click="_onImageClick"
283287
></button>
288+
<vaadin-tooltip for="btn-image" text="[[i18n.image]]"></vaadin-tooltip>
284289
<!-- Link -->
285290
<button
291+
id="btn-link"
286292
type="button"
287293
part="toolbar-button toolbar-button-link"
288-
title$="[[i18n.link]]"
289294
on-click="_onLinkClick"
290295
></button>
296+
<vaadin-tooltip for="btn-link" text="[[i18n.link]]"></vaadin-tooltip>
291297
</span>
292298
293299
<span part="toolbar-group toolbar-group-block">
294300
<!-- Blockquote -->
295301
<button
302+
id="btn-blockquote"
296303
type="button"
297304
class="ql-blockquote"
298305
part="toolbar-button toolbar-button-blockquote"
299-
title$="[[i18n.blockquote]]"
300306
></button>
301-
307+
<vaadin-tooltip for="btn-blockquote" text="[[i18n.blockquote]]"></vaadin-tooltip>
302308
<!-- Code block -->
303309
<button
310+
id="btn-code"
304311
type="button"
305312
class="ql-code-block"
306313
part="toolbar-button toolbar-button-code-block"
307-
title$="[[i18n.codeBlock]]"
308314
></button>
315+
<vaadin-tooltip for="btn-code" text="[[i18n.codeBlock]]"></vaadin-tooltip>
309316
</span>
310317
311318
<span part="toolbar-group toolbar-group-format">
312319
<!-- Clean -->
313-
<button
314-
type="button"
315-
class="ql-clean"
316-
part="toolbar-button toolbar-button-clean"
317-
title$="[[i18n.clean]]"
318-
></button>
320+
<button id="btn-clean" type="button" class="ql-clean" part="toolbar-button toolbar-button-clean"></button>
321+
<vaadin-tooltip for="btn-clean" text="[[i18n.clean]]"></vaadin-tooltip>
319322
</span>
320323
321324
<input
@@ -940,7 +943,10 @@ class RichTextEditor extends ElementMixin(ThemableMixin(PolymerElement)) {
940943
timeOut.after(timeout),
941944
() => {
942945
const formatting = Array.from(this.shadowRoot.querySelectorAll('[part="toolbar"] .ql-active'))
943-
.map((button) => button.getAttribute('title'))
946+
.map((button) => {
947+
const tooltip = this.shadowRoot.querySelector(`[for="${button.id}"]`);
948+
return tooltip.text;
949+
})
944950
.join(', ');
945951
announcer.textContent = formatting;
946952
},

‎packages/rich-text-editor/test/a11y.test.js‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,15 @@ describe('accessibility', () => {
2323
});
2424

2525
describe('screen readers', () => {
26-
it('should have default titles for the buttons', () => {
26+
it('should have default tooltips for the buttons', () => {
2727
buttons.forEach((button, index) => {
2828
const expectedLabel = rte.i18n[Object.keys(rte.i18n)[index]];
29-
expect(button.getAttribute('title')).to.equal(expectedLabel);
29+
const tooltip = rte.shadowRoot.querySelector(`[for="${button.id}"]`);
30+
expect(tooltip.text).to.equal(expectedLabel);
3031
});
3132
});
3233

33-
it('should localize titles for the buttons', () => {
34+
it('should localize tooltips for the buttons', () => {
3435
const defaultI18n = rte.i18n;
3536

3637
const localized = {};
@@ -41,7 +42,8 @@ describe('accessibility', () => {
4142

4243
buttons.forEach((button, index) => {
4344
const expectedLabel = `${defaultI18n[Object.keys(defaultI18n)[index]]} localized`;
44-
expect(button.getAttribute('title')).to.equal(expectedLabel);
45+
const tooltip = rte.shadowRoot.querySelector(`[for="${button.id}"]`);
46+
expect(tooltip.text).to.equal(expectedLabel);
4547
});
4648
});
4749

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import '@vaadin/button/theme/lumo/vaadin-button.js';
22
import '@vaadin/confirm-dialog/theme/lumo/vaadin-confirm-dialog.js';
33
import '@vaadin/text-field/theme/lumo/vaadin-text-field.js';
4+
import '@vaadin/tooltip/theme/lumo/vaadin-tooltip.js';
45
import './vaadin-rich-text-editor-styles.js';
56
import '../../src/vaadin-rich-text-editor.js';
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import '@vaadin/button/theme/material/vaadin-button.js';
22
import '@vaadin/confirm-dialog/theme/material/vaadin-confirm-dialog.js';
33
import '@vaadin/text-field/theme/material/vaadin-text-field.js';
4+
import '@vaadin/tooltip/theme/material/vaadin-tooltip.js';
45
import './vaadin-rich-text-editor-styles.js';
56
import '../../src/vaadin-rich-text-editor.js';

0 commit comments

Comments
 (0)