Skip to content

Commit 91c8261

Browse files
delvhsilverwind
andauthored
Add tooltips for MD editor buttons and add muted class for buttons (#23896)
Followup of #23876 according to my unreleased review demanding tooltips. Additionally - add a `muted` equivalent for buttons - convert `switch to legacy` to an actual button - enroll `switch to legacy` in the builtin pseudo focus cycle - remove spaces between the buttons The effect of the `muted` class is what you would expect: The button loses all of its normal styling, and is defined only by its content instead. This will help reduce a11y infractions in the future, as that was one of the major points why people didn't use `<button>` tags and decided on a bad fix (i.e. through `<div>`s) instead. ## Appearance ![image](https://user-images.githubusercontent.com/51889757/229510842-337378e5-faa5-4886-a910-08614c0c233d.png) --------- Co-authored-by: silverwind <[email protected]>
1 parent 7a8a4f5 commit 91c8261

File tree

4 files changed

+44
-18
lines changed

4 files changed

+44
-18
lines changed

Diff for: options/locale/locale_en-US.ini

+14
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,20 @@ footer = Footer
120120
footer.software = About Software
121121
footer.links = Links
122122

123+
[editor]
124+
buttons.heading.tooltip = Add heading
125+
buttons.bold.tooltip = Add bold text
126+
buttons.italic.tooltip = Add italic text
127+
buttons.quote.tooltip = Quote text
128+
buttons.code.tooltip = Add code
129+
buttons.link.tooltip = Add a link
130+
buttons.list.unordered.tooltip = Add a bullet list
131+
buttons.list.ordered.tooltip = Add a numbered list
132+
buttons.list.task.tooltip = Add a list of tasks
133+
buttons.mention.tooltip = Mention a user or team
134+
buttons.ref.tooltip = Reference an issue or pull request
135+
buttons.switch_to_legacy.tooltip = Use the legacy editor instead
136+
123137
[filter]
124138
string.asc = A - Z
125139
string.desc = Z - A

Diff for: templates/shared/combomarkdowneditor.tmpl

+14-15
Original file line numberDiff line numberDiff line change
@@ -19,29 +19,28 @@ Template Attributes:
1919
</div>
2020
{{end}}
2121
<div class="ui tab active" data-tab-panel="markdown-writer">
22-
<markdown-toolbar class="gt-df">
22+
<markdown-toolbar class="gt-df gt-ac gt-gap-3">
2323
<div class="markdown-toolbar-group">
24-
<md-header class="markdown-toolbar-button">{{svg "octicon-heading"}}</md-header>
25-
<md-bold class="markdown-toolbar-button">{{svg "octicon-bold"}}</md-bold>
26-
<md-italic class="markdown-toolbar-button">{{svg "octicon-italic"}}</md-italic>
24+
<md-header role="button" class="markdown-toolbar-button btn-link muted" data-tooltip-content="{{.locale.Tr "editor.buttons.heading.tooltip"}}">{{svg "octicon-heading"}}</md-header>
25+
<md-bold role="button" class="markdown-toolbar-button btn-link muted" data-tooltip-content="{{.locale.Tr "editor.buttons.bold.tooltip"}}">{{svg "octicon-bold"}}</md-bold>
26+
<md-italic role="button" class="markdown-toolbar-button btn-link muted" data-tooltip-content="{{.locale.Tr "editor.buttons.italic.tooltip"}}">{{svg "octicon-italic"}}</md-italic>
2727
</div>
2828
<div class="markdown-toolbar-group">
29-
<md-quote class="markdown-toolbar-button">{{svg "octicon-quote"}}</md-quote>
30-
<md-code class="markdown-toolbar-button">{{svg "octicon-code"}}</md-code>
31-
<md-link class="markdown-toolbar-button">{{svg "octicon-link"}}</md-link>
29+
<md-quote role="button" class="markdown-toolbar-button btn-link muted" data-tooltip-content="{{.locale.Tr "editor.buttons.quote.tooltip"}}">{{svg "octicon-quote"}}</md-quote>
30+
<md-code role="button" class="markdown-toolbar-button btn-link muted" data-tooltip-content="{{.locale.Tr "editor.buttons.code.tooltip"}}">{{svg "octicon-code"}}</md-code>
31+
<md-link role="button" class="markdown-toolbar-button btn-link muted" data-tooltip-content="{{.locale.Tr "editor.buttons.link.tooltip"}}">{{svg "octicon-link"}}</md-link>
3232
</div>
3333
<div class="markdown-toolbar-group">
34-
<md-unordered-list class="markdown-toolbar-button">{{svg "octicon-list-unordered"}}</md-unordered-list>
35-
<md-ordered-list class="markdown-toolbar-button">{{svg "octicon-list-ordered"}}</md-ordered-list>
36-
<md-task-list class="markdown-toolbar-button">{{svg "octicon-tasklist"}}</md-task-list>
34+
<md-unordered-list role="button" class="markdown-toolbar-button btn-link muted" data-tooltip-content="{{.locale.Tr "editor.buttons.list.unordered.tooltip"}}">{{svg "octicon-list-unordered"}}</md-unordered-list>
35+
<md-ordered-list role="button" class="markdown-toolbar-button btn-link muted" data-tooltip-content="{{.locale.Tr "editor.buttons.list.ordered.tooltip"}}">{{svg "octicon-list-ordered"}}</md-ordered-list>
36+
<md-task-list role="button" class="markdown-toolbar-button btn-link muted" data-tooltip-content="{{.locale.Tr "editor.buttons.list.task.tooltip"}}">{{svg "octicon-tasklist"}}</md-task-list>
3737
</div>
3838
<div class="markdown-toolbar-group">
39-
<md-mention class="markdown-toolbar-button">{{svg "octicon-mention"}}</md-mention>
40-
<md-ref class="markdown-toolbar-button">{{svg "octicon-cross-reference"}}</md-ref>
39+
<md-mention role="button" class="markdown-toolbar-button btn-link muted" data-tooltip-content="{{.locale.Tr "editor.buttons.mention.tooltip"}}">{{svg "octicon-mention"}}</md-mention>
40+
<md-ref role="button" class="markdown-toolbar-button btn-link muted" data-tooltip-content="{{.locale.Tr "editor.buttons.ref.tooltip"}}">{{svg "octicon-cross-reference"}}</md-ref>
4141
</div>
42-
<div class="markdown-toolbar-group gt-f1"></div>
43-
<div class="markdown-toolbar-group">
44-
<span class="markdown-toolbar-button markdown-switch-easymde">{{svg "octicon-arrow-switch"}}</span>
42+
<div class="markdown-toolbar-group gt-f1 gt-je">
43+
<button class="markdown-toolbar-button markdown-switch-easymde btn-link muted" data-tooltip-content="{{.locale.Tr "editor.buttons.switch_to_legacy.tooltip"}}">{{svg "octicon-arrow-switch"}}</button>
4544
</div>
4645
</markdown-toolbar>
4746
<text-expander keys=": @">

Diff for: web_src/css/base.css

+15-1
Original file line numberDiff line numberDiff line change
@@ -328,21 +328,35 @@ progress::-moz-progress-bar {
328328
user-select: none;
329329
}
330330

331+
.btn-link {
332+
background: none;
333+
border: none;
334+
color: var(--color-primary);
335+
}
336+
337+
a:hover,
338+
.btn-link:hover {
339+
text-decoration: underline;
340+
}
341+
331342
a,
332-
.ui.breadcrumb a {
343+
.ui.breadcrumb a,
344+
.btn-link {
333345
color: var(--color-primary);
334346
cursor: pointer;
335347
text-decoration-skip-ink: all;
336348
}
337349

338350
a.muted,
351+
.btn-link.muted,
339352
.muted-links a {
340353
color: inherit;
341354
}
342355

343356
a:hover,
344357
a.muted:hover,
345358
a.muted:hover [class*="color-text"],
359+
.btn-link.muted:hover,
346360
.muted-links a:hover,
347361
.ui.breadcrumb a:hover {
348362
color: var(--color-primary);

Diff for: web_src/css/editor-markdown.css

+1-2
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,12 @@
99
}
1010

1111
.combo-markdown-editor .markdown-toolbar-group {
12-
display: inline-block;
12+
display: flex;
1313
}
1414

1515
.combo-markdown-editor .markdown-toolbar-button {
1616
user-select: none;
1717
padding: 5px;
18-
cursor: pointer;
1918
}
2019

2120
.ui.form .combo-markdown-editor textarea.markdown-text-editor,

0 commit comments

Comments
 (0)