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.

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

Revamp Feed bar and Add/Edit description button to be consistent + correctly spaced #5664

Merged
merged 15 commits into from
Aug 23, 2021

Conversation

janfaracik
Copy link
Contributor

@janfaracik janfaracik commented Aug 14, 2021

Proposed changelog entries

  • Update appearance for feed bar and description button to be modern and consistent

Screenshots

Old
image

New
image

What's changed under the hood?

  • Added two new SVGs, one for the add/edit button and one for the feed button (both from Material Icons)
  • Added a buttons-row class which correctly spaces buttons in a row
  • The size buttons now read correctly when using a screenreader, eg button S will read as Small, M will read as Medium and L will read as Large
  • Breadcrumb bar chevron is now the same colour as the text that proceeds it, easier to see + accessibility

Proposed upgrade guidelines

N/A

Submitter checklist

  • (If applicable) Jira issue is well described
  • Changelog entries and upgrade guidelines are appropriate for the audience affected by the change (users or developer, depending on the change). Examples
    • Fill-in the Proposed changelog entries section only if there are breaking changes or other changes which may require extra steps from users during the upgrade
  • Appropriate autotests or explanation to why this change has no tests
  • For dependency updates: links to external changelogs and, if possible, full diffs

Maintainer checklist

Before the changes are marked as ready-for-merge:

  • There are at least 2 approvals for the pull request and no outstanding requests for change
  • Conversations in the pull request are over OR it is explicit that a reviewer does not block the change
  • Changelog entries in the PR title and/or Proposed changelog entries are correct
  • Proper changelog labels are set so that the changelog can be generated automatically
  • If the change needs additional upgrade steps from users, upgrade-guide-needed label is set and there is a Proposed upgrade guidelines section in the PR title. (example)
  • If it would make sense to backport the change to LTS, a Jira issue must exist, be a Bug or Improvement, and be labeled as lts-candidate to be considered (see query).

@oleg-nenashev oleg-nenashev added web-ui The PR includes WebUI changes which may need special expertise rfe For changelog: Minor enhancement. use `major-rfe` for changes to be highlighted labels Aug 14, 2021
Copy link
Member

@oleg-nenashev oleg-nenashev left a comment

Choose a reason for hiding this comment

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

Localizations will be affected. Maybe it is better to avoid patching the keys and update the default localization property file

@@ -194,7 +194,7 @@ THE SOFTWARE.
<div id="page-head">
<l:pageHeader title="${%title}"
logoAlt="${%jenkinshead.alt}"
searchPlaceholder="${%search}"
searchPlaceholder="${%Search}"
Copy link
Member

Choose a reason for hiding this comment

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

It will impact localizations. Would be nice to clean it up. You can also just update the english localization and keep the key in *.jelly intact

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good spot! I've moved any changed strings to the localisation files.

Copy link
Member

@timja timja left a comment

Choose a reason for hiding this comment

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

looks good, I've tested via core-pr-tester

one thing we could consider since we're in this area anyway is updating the text from 'Submit' to 'Save' when editing the description?

Any thoughts?

@timja timja requested review from fqueiruga, a team and oleg-nenashev August 14, 2021 17:42
@daniel-beck
Copy link
Member

Breadcrumb bar chevron is now the same colour as the text that proceeds it, easier to see + accessibility

Could someone provide before/after screenshots?

@timja
Copy link
Member

timja commented Aug 15, 2021

Breadcrumb bar chevron is now the same colour as the text that proceeds it, easier to see + accessibility

Could someone provide before/after screenshots?

The arrow is solid now rather than faded out

Before:
image

After:
image

On dark theme it looks identical

Copy link
Member

@oleg-nenashev oleg-nenashev left a comment

Choose a reason for hiding this comment

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

The change itself looks really good, +1 from me. No concerns about the arrow changes. We will need to update the changelog a bit, but there are no major obstacles IMHO

Requesting changes because of the license header in the new file, happy to approve once fixed

Co-authored-by: Oleg Nenashev <o.v.nenashev@gmail.com>
@timja timja requested review from uhafner and romenrg August 15, 2021 19:29
Copy link
Member

@oleg-nenashev oleg-nenashev left a comment

Choose a reason for hiding this comment

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

Looks good to me. Thanks @janfaracik !
We are missing the merge window for the tomorrow's weekly anyway. I suggest merging on Thursday after the Wednesday's UX SIG meeting if no negative feedback

@oleg-nenashev oleg-nenashev added the ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback label Aug 16, 2021
@timja
Copy link
Member

timja commented Aug 16, 2021

Looks good to me. Thanks @janfaracik !
We are missing the merge window for the tomorrow's weekly anyway. I suggest merging on Thursday after the Wednesday's UX SIG meeting if no negative feedback

There's no ux sig meeting till 1st of September, let's merge sometime in the next week, no rush

Copy link
Member

@uhafner uhafner left a comment

Choose a reason for hiding this comment

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

Thanks, the new layout looks much better!

(I still would prefer actual icons in the corresponding size as buttons rather than the letters S, M, and L but that is unrelated to your change and an existing usability problem.)

@@ -28,22 +28,22 @@ THE SOFTWARE.
<div align="right">
<a href="rss" class="yui-button link-button">
<span class="leading-icon">
<l:svgIcon class="icon-small" tooltip="Atom feed"
href="${imagesURL}/material-icons/svg-sprite-communication-symbol.svg#ic_rss_feed_24px"/>
<l:svgIcon class="icon-small" tooltip="Atom feed" viewBox="viewbox (default 0 0 16 16)"
Copy link
Member

Choose a reason for hiding this comment

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

Is there a way to avoid providing a fixed view box every time?

Copy link
Contributor

Choose a reason for hiding this comment

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

I think there should be an alternative to the viewbox changes here. Maybe a transform: scale

Copy link
Member

Choose a reason for hiding this comment

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

The syntax seems to be wrong, I now get several console errors;

https://issues.jenkins.io/browse/JENKINS-66472

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Noticed that whilst working on something else, I've got a fix for that in another feature PR - https://github.com/jenkinsci/jenkins/pull/5692/files - happy to pull the fix out into a separate bug PR if that makes things easier :)

Copy link
Contributor

@fqueiruga fqueiruga left a comment

Choose a reason for hiding this comment

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

Changing default padding for buttons is dangerous IMO. I'd suggest you create custom CSS for the feed bar.

I'm also not sure whether the .jenkins-buttons-row is generic enough that it can be used elsewhere. I wouldn't mind some component-specific naming like .feed-buttons-row or something like that.

@@ -123,7 +123,7 @@ a.yui-button:visited {
box-sizing: border-box;
// vertical padding:
// 0.375rem == 6px == 32px (target height) - 4px (borders) - 16 (line) / 2
padding: 0.375rem 1rem;
padding: 0.375rem 0.5rem;
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this change should not take place because it will affect all buttons and it can be have unexpected . Any specific modifications could be done using custom CSS.

@@ -167,11 +167,11 @@ a.yui-button:visited {
}

.leading-icon {
margin-right: 0.25rem;
margin-right: 0.5rem;
Copy link
Contributor

Choose a reason for hiding this comment

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

Ditto about custom CSS

}

.trailing-icon {
margin-left: 0.25rem;
margin-left: 0.5rem;
Copy link
Contributor

Choose a reason for hiding this comment

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

Ditto about custom CSS

@@ -28,22 +28,22 @@ THE SOFTWARE.
<div align="right">
<a href="rss" class="yui-button link-button">
<span class="leading-icon">
<l:svgIcon class="icon-small" tooltip="Atom feed"
href="${imagesURL}/material-icons/svg-sprite-communication-symbol.svg#ic_rss_feed_24px"/>
<l:svgIcon class="icon-small" tooltip="Atom feed" viewBox="viewbox (default 0 0 16 16)"
Copy link
Contributor

Choose a reason for hiding this comment

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

I think there should be an alternative to the viewbox changes here. Maybe a transform: scale

@timja timja merged commit 04a98ff into jenkinsci:master Aug 23, 2021
@janfaracik janfaracik deleted the prioritize-svgs branch January 5, 2022 15:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback rfe For changelog: Minor enhancement. use `major-rfe` for changes to be highlighted web-ui The PR includes WebUI changes which may need special expertise
Projects
None yet
6 participants