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

Iterations on options modal #25837

Merged
merged 19 commits into from
Oct 15, 2020
Merged

Iterations on options modal #25837

merged 19 commits into from
Oct 15, 2020

Conversation

karmatosed
Copy link
Member

A few iterations to the options modal in line with #24965 as a step for this release, whilst the new design is being worked on.

This PR is starting to focus on the points highlighted in the comment by @mtias:

Improve the copy of each setting, make them more concrete and cohesive (some are many words long, some just a few)
Utilize longer descriptions when necessary (similar to "Top Toolbar") to provide more context.
Reorganize the main sections.

Changes

I have done some copy changes and worked on bringing in the same style for help text, however, for now, kept the checkboxes. One point to note that could be done if copy is agreed in time is moving also to toggles for this release.

Here you can see a visual of what this PR results in:

image

Feedback

I don't consider this to be a final PR, I would love feedback and here are a few areas to focus that, although general feedback is as always welcome.

  • Clarity: do the changes bring clearer definitions? What changes are missing and should be brought in?
  • Uniformity of text: does this help with the variations?

I would also love a code review as there is some style adding and I need to be sure doing that correctly in this case. Work will continue with the design over on the issue, but let's get something in for this release as an iterative step. Thanks in advance.

Next steps

Once I have feedback, I want to work to within a few days getting something merged for this as we can always iterate from this point.

Thanks

Props to @jasmussen and @ItsJonQ for helping me working through some code hunting and setup fun to get this PR brewed.

@karmatosed karmatosed added Needs Design Feedback Needs general design feedback. Needs Copy Review Needs review of user-facing copy (language, phrasing) labels Oct 5, 2020
@karmatosed karmatosed self-assigned this Oct 5, 2020
@github-actions
Copy link

github-actions bot commented Oct 5, 2020

Size Change: -3.45 kB (0%)

Total Size: 1.19 MB

Filename Size Change
build/a11y/index.js 1.14 kB +1 B
build/annotations/index.js 3.54 kB -2 B (0%)
build/block-directory/index.js 8.6 kB +51 B (0%)
build/block-editor/index.js 130 kB +1.21 kB (0%)
build/block-editor/style-rtl.css 10.9 kB +28 B (0%)
build/block-editor/style.css 10.9 kB +28 B (0%)
build/block-library/editor-rtl.css 8.65 kB -2 B (0%)
build/block-library/editor.css 8.65 kB -4 B (0%)
build/block-library/index.js 142 kB -2.77 kB (1%)
build/block-library/style-rtl.css 7.71 kB +55 B (0%)
build/block-library/style.css 7.71 kB +56 B (0%)
build/blocks/index.js 47.6 kB -6 B (0%)
build/components/index.js 169 kB +98 B (0%)
build/components/style-rtl.css 15.4 kB -47 B (0%)
build/components/style.css 15.4 kB -46 B (0%)
build/compose/index.js 9.63 kB +200 B (2%)
build/core-data/index.js 12.1 kB +2 B (0%)
build/data-controls/index.js 684 B -1 B
build/data/index.js 8.63 kB +25 B (0%)
build/dom-ready/index.js 569 B +1 B
build/dom/index.js 4.43 kB +2 B (0%)
build/edit-navigation/index.js 10.6 kB -2 B (0%)
build/edit-post/index.js 306 kB +232 B (0%)
build/edit-post/style-rtl.css 6.35 kB +58 B (0%)
build/edit-post/style.css 6.33 kB +55 B (0%)
build/edit-site/index.js 21.1 kB +130 B (0%)
build/edit-site/style-rtl.css 3.77 kB +38 B (1%)
build/edit-site/style.css 3.77 kB +41 B (1%)
build/edit-widgets/index.js 21.4 kB +216 B (1%)
build/edit-widgets/style-rtl.css 2.97 kB -50 B (1%)
build/edit-widgets/style.css 2.97 kB -51 B (1%)
build/editor/editor-styles-rtl.css 480 B -12 B (2%)
build/editor/editor-styles.css 482 B -11 B (2%)
build/editor/index.js 42.5 kB -2.99 kB (7%)
build/editor/style-rtl.css 3.85 kB +4 B (0%)
build/editor/style.css 3.84 kB +2 B (0%)
build/element/index.js 4.45 kB +1 B
build/escape-html/index.js 733 B -1 B
build/format-library/index.js 7.49 kB +1 B
build/html-entities/index.js 622 B +1 B
build/is-shallow-equal/index.js 709 B -1 B
build/list-reusable-blocks/index.js 3.02 kB +1 B
build/media-utils/index.js 5.12 kB +2 B (0%)
build/notices/index.js 1.69 kB +1 B
build/plugins/index.js 2.44 kB +1 B
build/primitives/index.js 1.34 kB +1 B
build/priority-queue/index.js 789 B -1 B
build/redux-routine/index.js 2.85 kB +2 B (0%)
build/rich-text/index.js 13 kB +5 B (0%)
build/server-side-render/index.js 2.6 kB +1 B
build/shortcode/index.js 1.7 kB -1 B
build/url/index.js 4.07 kB +3 B (0%)
build/viewport/index.js 1.75 kB +1 B
build/warning/index.js 1.13 kB -1 B
ℹ️ View Unchanged
Filename Size Change
build/api-fetch/index.js 3.35 kB 0 B
build/autop/index.js 2.72 kB 0 B
build/blob/index.js 668 B 0 B
build/block-directory/style-rtl.css 943 B 0 B
build/block-directory/style.css 942 B 0 B
build/block-library/theme-rtl.css 741 B 0 B
build/block-library/theme.css 741 B 0 B
build/block-serialization-default-parser/index.js 1.78 kB 0 B
build/block-serialization-spec-parser/index.js 3.1 kB 0 B
build/date/index.js 31.9 kB 0 B
build/deprecated/index.js 772 B 0 B
build/edit-navigation/style-rtl.css 868 B 0 B
build/edit-navigation/style.css 871 B 0 B
build/format-library/style-rtl.css 547 B 0 B
build/format-library/style.css 548 B 0 B
build/hooks/index.js 1.74 kB 0 B
build/i18n/index.js 3.54 kB 0 B
build/keyboard-shortcuts/index.js 2.39 kB 0 B
build/keycodes/index.js 1.85 kB 0 B
build/list-reusable-blocks/style-rtl.css 476 B 0 B
build/list-reusable-blocks/style.css 476 B 0 B
build/nux/index.js 3.27 kB 0 B
build/nux/style-rtl.css 671 B 0 B
build/nux/style.css 668 B 0 B
build/reusable-blocks/index.js 3.04 kB 0 B
build/token-list/index.js 1.24 kB 0 B
build/wordcount/index.js 1.17 kB 0 B

compressed-size-action

@ItsJonQ
Copy link

ItsJonQ commented Oct 5, 2020

@karmatosed Thanks for working on this!

The code implementation looks good to me 👍

Adding the .scss code for direct targeting of the helpText is probably the best solution we have at the moment.

Zoom into the UI a bit... I feel like maybe the margins could be tweaked just a tiny bit?

I have a screenshot of the helpText margins tweaked:

Screen Shot 2020-10-05 at 11 48 29 AM

The final style was margin: -8px 0 8px 42px (it was something I did quickly in Chrome).

What do you think :)

@karmatosed
Copy link
Member Author

karmatosed commented Oct 5, 2020

Great idea, I iterated a little and pushed to PR. Thanks for taking a look @ItsJonQ. Here is where I came to:

image

@karmatosed karmatosed added this to the Gutenberg 9.2 milestone Oct 5, 2020
@ItsJonQ
Copy link

ItsJonQ commented Oct 5, 2020

@karmatosed Great :)

Peeking at the CSS variables, my initial suggestion was for something like this:

margin: -$grid-unit-10 0 $grid-unit-10 ( $grid-unit-50 + 2px );

That aside... The tests seem a bit unhappy 🙈 .
I'm not sure about the E2E one. But I can help with the JavaScript unit ones.

Lemme know if you some help with those 🙏

@jasmussen
Copy link
Contributor

Nicely done. Looking at this one:

Screenshot 2020-10-06 at 08 34 37

The spacing below the help text looks more correct in the previous screenshot shared, not sure which one is the latest:

Screenshot 2020-10-06 at 08 34 14

Also should the helptext be not italic, like in the dropdown?

Screenshot 2020-10-06 at 08 34 10

Nice bit of constency to be found in unifying those two. Cool!

@karmatosed
Copy link
Member Author

Thanks @ItsJonQ and @jasmussen - you are both really helping this take shape!

@jasmussen you rightly pointed out after this PR there's a win to be had here in another one for a fix on help text to unify, there's an italic being picked up that for now I've set an override on, but can fix upstream in another PR (I'll get that begun outside this).

Here is the current state of PR:

image

@ItsJonQ that calculation works nicely, thank you for that refinement. I would love help sorting the tests, I'm not totally convinced all are valid either which is perplexing, so would love to work through those. Thank you for offering to help there.

@karmatosed
Copy link
Member Author

Linking in #25851 as that has the root fix for the font styling so once in can remove the work around in this PR.

@ItsJonQ
Copy link

ItsJonQ commented Oct 6, 2020

Taking a look at the E2E test failures... I'm really not sure why they're breaking 🤔

@ItsJonQ
Copy link

ItsJonQ commented Oct 6, 2020

@karmatosed I rebased it with latest master to see if that will help with tests 🙏

@enriquesanchez
Copy link
Contributor

Took this for a spin:

Screen Shot 2020-10-06 at 14 02 19

I really like this direction and the changes you've made to the margins and style of the helper text 👍

I have some suggestions for some of the helper texts. Please feel free to ignore if these don't make sense to you:

For "Pre-publish checklist", how about "Allows review of document settings before publishing."?

For "Contain the text cursor", how about "Keeps keyboard cursor inside active block."?

For 'Compact interface', how about "Reduces options in toolbar and outlines."?

Copy link
Contributor

@ntsekouras ntsekouras left a comment

Choose a reason for hiding this comment

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

Hey @karmatosed - thanks! I pushed a couple of commits to fix the failing tests.

@karmatosed
Copy link
Member Author

Thanks so much @ntsekouras for your help there.

@enriquesanchez those look like some great suggestions, let me work on an iteration. Thank you.

@karmatosed
Copy link
Member Author

One other potential iteration I have been working on is to change up the sections. @enriquesanchez I would love your input here if that is possible as I know you are working on a keyboard shortcut section, that to me feels like this option doesn't fit there (although it might). In the explorations for the iterated options panel, the sections included 'blocks' and this could be something explored here:

image

@jasmussen
Copy link
Contributor

Not bad. Not for this PR, but what would it look like without those borders, perhaps slightly more space instead?

@enriquesanchez
Copy link
Contributor

I agree that a whole section just for the option of 'Contain the text cursor' feels like too much, but I also don't find that it fits with any of the others.

Have we considered having an 'Accessibility' section in here? I think both 'Contain the text cursor' and 'Display button text labels' could fit well under it.

@karmatosed
Copy link
Member Author

@jasmussen I think you have a great point there and maybe a middle ground is to remove the borders for now in the content area, leave the header? I have pushed a version of that to the PR just to see, happy for feedback around that as it's something we can always reverse out if want to.

Here is what I ended up with adding a small amount of spacing increase:

image

@jasmussen
Copy link
Contributor

I like the reduced borders there! Seems good to me 👍 👍

Copy link

@ItsJonQ ItsJonQ left a comment

Choose a reason for hiding this comment

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

🚀 from me! Thanks for helping with this @karmatosed + @jasmussen

@karmatosed
Copy link
Member Author

Noting that above is rebasing so it's in sync. Thanks for reminder @ZebulanStanphill.

@carolinan
Copy link
Contributor

carolinan commented Oct 10, 2020

Just looking at the images presented here, I don't understand what "Most used blocks in library" is
...Do what with the most used blocks? What happens when I check this?

@ZebulanStanphill
Copy link
Member

@carolinan Yeah, the wording seems a bit unclear to me as well. I think "Show Most Used section in block library" or something like that would be clearer.

@karmatosed
Copy link
Member Author

karmatosed commented Oct 12, 2020

@carolinan thanks for the suggestion. The idea was the checkbox would be the activator there. I am very happy to add back in 'show' but do you feel the same for the button text label also? I think both of those being consistent makes sense. Mostly, I think avoiding a sea of 'shows' is key here so let's explore further.

@kellychoffman
Copy link
Contributor

kellychoffman commented Oct 13, 2020

Much cleaner look without the borders.

The copy is still rather hard to parse tho. I would take another pass to make the labels more descriptive, and where its needed, add helper text. I also think you could consider adding helper text to some or all of the section headers. (For example, I don't think everyone knows what or where the "Document panel" is.)

I'd be careful that the helper text is not just rephrasing the label. "Contain the text cursor" is one example of this where the helper text is not necessarily clarifying. Maybe the helper text could instead say why you'd show/hide this.

@karmatosed
Copy link
Member Author

I took the feedback and iterated, here you can see the results:

image

Things I changed:

  • A new class and descriptive text to section component.
  • Iterated almost all text.
  • Changed some headings.

Huge thanks to @enriquesanchez for working with me on the copy and to @ItsJonQ for guidance on adding to the component descriptive text, running tests.

@kellychoffman I would love to get your opinion on this as feel it's in a place to at least get in for release. Would love your thoughts there.

@ItsJonQ would love a code review once the tests have finished if that is possible.

@ZebulanStanphill
Copy link
Member

I think "preventing text caret leaving blocks" reads weirdly... I think "preventing text caret from leaving blocks" would be better.

We should probably note that "Use theme styles" may have no effect if the theme doesn't support the feature.

The term "post panel" isn't used anywhere else, and may not make as much sense on other post types.

Other than those three things, I like this. It's certainly an improvement over master.

@ItsJonQ
Copy link

ItsJonQ commented Oct 13, 2020

👍 for the new description prop implementation for the Section component

@karmatosed
Copy link
Member Author

@ZebulanStanphill Thanks for your input. Regarding:

We should probably note that "Use theme styles" may have no effect if the theme doesn't support the feature.

I wonder if we should then not even show this if the theme doesn't support it? It seems unexpected to me to have a feature that you might not be able to use? I wonder if there already is a check though?

@karmatosed
Copy link
Member Author

I just did one more iteration based on last round of feedback. You can see the changes here:

image

@kellychoffman
Copy link
Contributor

:shipit:

Copy link
Contributor

@youknowriad youknowriad left a comment

Choose a reason for hiding this comment

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

LGTM code wise

@karmatosed
Copy link
Member Author

karmatosed commented Oct 15, 2020

As the tests seem to have now passed after @youknowriad's help, thanks to everyone for all the feedback and work in getting here. I am going to merge this! Excited to get this iteration in.

@karmatosed karmatosed merged commit 17f4120 into master Oct 15, 2020
@karmatosed karmatosed deleted the try/options-iterations branch October 15, 2020 16:36
@ZebulanStanphill
Copy link
Member

ZebulanStanphill commented Oct 15, 2020

@karmatosed

@ZebulanStanphill Thanks for your input. Regarding:

We should probably note that "Use theme styles" may have no effect if the theme doesn't support the feature.

I wonder if we should then not even show this if the theme doesn't support it? It seems unexpected to me to have a feature that you might not be able to use? I wonder if there already is a check though?

Perhaps we could put aria-disabled on the control when it has no effect? Then again, it might be slightly annoying to not be able to enable/disable the feature until after you've switched to a theme that supports it. Perhaps we could just update the wording to something like "Use theme styles (if supported)".

@mtias
Copy link
Member

mtias commented Oct 16, 2020

Nice to see this iteration! I think we need to look at better grouping next — for example, button labels in "General" doesn't make much sense. It could be better in "Appearance". Also the "Keyboard" grouping seems awkward to me. Also "theme styles" should be at the bottom in that group.

@karmatosed
Copy link
Member Author

@mtias no problem I can spin up an iterative PR to bring that in now this is in. I'll do that now.

karmatosed pushed a commit that referenced this pull request Oct 16, 2020
This responds to feedback on #25837 and iterates the grouping.
karmatosed pushed a commit that referenced this pull request Oct 16, 2020
This responds to feedback on #25837 and iterates the grouping.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs Copy Review Needs review of user-facing copy (language, phrasing) Needs Design Feedback Needs general design feedback.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants