Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add tooltips for MD editor buttons and add muted class for buttons #23896

Merged
merged 10 commits into from
Apr 11, 2023
Merged

Add tooltips for MD editor buttons and add muted class for buttons #23896

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
77b949a
Add tooltips for MD editor buttons
delvh Apr 3, 2023
e4de1ac
Remove unused CSS selector
delvh Apr 3, 2023
4aa5286
Merge branch 'main' into feature/tooltips-for-md-editor
silverwind Apr 3, 2023
10186e7
Change tooltip translation keys and simplify not showing spaces
delvh Apr 10, 2023
6154f21
add button roles, color, hover effect, remove div
silverwind Apr 10, 2023
bbd9f1b
Describe `` `text` `` as `code` instead of `code/highlighted text`
delvh Apr 10, 2023
e6864ca
add btn-link and apply muted
silverwind Apr 10, 2023
68d99ae
add underline style to btn-link as well
silverwind Apr 10, 2023
f7d8fb7
Merge branch 'main' into feature/tooltips-for-md-editor
lunny Apr 11, 2023
7f096e8
Merge branch 'main' into feature/tooltips-for-md-editor
lunny Apr 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions options/locale/locale_en-US.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,20 @@ footer = Footer
footer.software = About Software
footer.links = Links

[editor]
buttons.heading.tooltip = Add heading
buttons.bold.tooltip = Add bold text
buttons.italic.tooltip = Add italic text
buttons.quote.tooltip = Quote text
buttons.code.tooltip = Add code
buttons.link.tooltip = Add a link
buttons.list.unordered.tooltip = Add a bullet list
buttons.list.ordered.tooltip = Add a numbered list
buttons.list.task.tooltip = Add a list of tasks
buttons.mention.tooltip = Mention a user or team
buttons.ref.tooltip = Reference an issue or pull request
buttons.switch_to_legacy.tooltip = Use the legacy editor instead

[filter]
string.asc = A - Z
string.desc = Z - A
Expand Down
29 changes: 14 additions & 15 deletions templates/shared/combomarkdowneditor.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,29 +19,28 @@ Template Attributes:
</div>
{{end}}
<div class="ui tab active" data-tab-panel="markdown-writer">
<markdown-toolbar class="gt-df">
<markdown-toolbar class="gt-df gt-ac gt-gap-3">
<div class="markdown-toolbar-group">
<md-header class="markdown-toolbar-button">{{svg "octicon-heading"}}</md-header>
<md-bold class="markdown-toolbar-button">{{svg "octicon-bold"}}</md-bold>
<md-italic class="markdown-toolbar-button">{{svg "octicon-italic"}}</md-italic>
<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>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I really dislike this btn-link muted, it just duplicates a lot.

Why can't we put the styles in .markdown-toolbar-button ?

Copy link
Contributor

@wxiaoguang wxiaoguang Apr 11, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I won't say blocker for this change, but I will refactor such usage in next PR.

I do not see why we should add a CSS class then mute some of the styles, and I do not think the duplicated class names are maintainable.

As I explained above, we are styling the toolbar buttons, we only need a .markdown-toolbar-button {} style for them.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why can't we put the styles in .markdown-toolbar-button ?

That was my initial approach as well but then @delvh requested more generic classes to achieve the effect. I'm indifferrent, but those classes do might prove useful in the future.

<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>
<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>
</div>
<div class="markdown-toolbar-group">
<md-quote class="markdown-toolbar-button">{{svg "octicon-quote"}}</md-quote>
<md-code class="markdown-toolbar-button">{{svg "octicon-code"}}</md-code>
<md-link class="markdown-toolbar-button">{{svg "octicon-link"}}</md-link>
<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>
<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>
<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>
</div>
<div class="markdown-toolbar-group">
<md-unordered-list class="markdown-toolbar-button">{{svg "octicon-list-unordered"}}</md-unordered-list>
<md-ordered-list class="markdown-toolbar-button">{{svg "octicon-list-ordered"}}</md-ordered-list>
<md-task-list class="markdown-toolbar-button">{{svg "octicon-tasklist"}}</md-task-list>
<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>
<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>
<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>
</div>
<div class="markdown-toolbar-group">
<md-mention class="markdown-toolbar-button">{{svg "octicon-mention"}}</md-mention>
<md-ref class="markdown-toolbar-button">{{svg "octicon-cross-reference"}}</md-ref>
<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>
<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>
</div>
<div class="markdown-toolbar-group gt-f1"></div>
<div class="markdown-toolbar-group">
<span class="markdown-toolbar-button markdown-switch-easymde">{{svg "octicon-arrow-switch"}}</span>
<div class="markdown-toolbar-group gt-f1 gt-je">
<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>
</div>
</markdown-toolbar>
<text-expander keys=": @">
Expand Down
16 changes: 15 additions & 1 deletion web_src/css/base.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -328,21 +328,35 @@ progress::-moz-progress-bar {
user-select: none;
}

.btn-link {
background: none;
border: none;
color: var(--color-primary);
}

a:hover,
.btn-link:hover {
text-decoration: underline;
}

a,
.ui.breadcrumb a {
.ui.breadcrumb a,
.btn-link {
color: var(--color-primary);
cursor: pointer;
text-decoration-skip-ink: all;
}

a.muted,
.btn-link.muted,
.muted-links a {
color: inherit;
}

a:hover,
a.muted:hover,
a.muted:hover [class*="color-text"],
.btn-link.muted:hover,
.muted-links a:hover,
.ui.breadcrumb a:hover {
color: var(--color-primary);
Expand Down
3 changes: 1 addition & 2 deletions web_src/css/editor-markdown.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,12 @@
}

.combo-markdown-editor .markdown-toolbar-group {
display: inline-block;
display: flex;
}

.combo-markdown-editor .markdown-toolbar-button {
user-select: none;
padding: 5px;
cursor: pointer;
}

.ui.form .combo-markdown-editor textarea.markdown-text-editor,
Expand Down