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

Format Library: add subscript and superscript #21819

Merged
merged 2 commits into from
Apr 27, 2020
Merged

Conversation

ellatrix
Copy link
Member

@ellatrix ellatrix commented Apr 23, 2020

Description

Fixes #3507. Since rich text buttons are now in a collapsed dropdown list and not visible by default, it doesn't hurt to add these buttons, even if usage would be relatively low. The buttons represent semantic elements.

https://www.w3.org/TR/html52/textlevel-semantics.html#the-sub-and-sup-elements

Most editors have buttons for this, e.g. Google Docs:

Screenshot 2020-04-23 at 12 48 46

How has this been tested?

Screenshots

Types of changes

Checklist:

  • My code is tested.
  • My code follows the WordPress code style.
  • My code follows the accessibility standards.
  • My code has proper inline documentation.
  • I've included developer documentation if appropriate.
  • I've updated all React Native files affected by any refactorings/renamings in this PR.

@github-actions
Copy link

github-actions bot commented Apr 23, 2020

Size Change: +315 B (0%)

Total Size: 835 kB

Filename Size Change
build/block-directory/index.js 6.23 kB -1 B
build/compose/index.js 6.66 kB +1 B
build/format-library/index.js 7.63 kB +315 B (4%)
ℹ️ View Unchanged
Filename Size Change
build/a11y/index.js 1.02 kB 0 B
build/annotations/index.js 3.62 kB 0 B
build/api-fetch/index.js 4.08 kB 0 B
build/autop/index.js 2.82 kB 0 B
build/blob/index.js 620 B 0 B
build/block-directory/style-rtl.css 760 B 0 B
build/block-directory/style.css 761 B 0 B
build/block-editor/index.js 106 kB 0 B
build/block-editor/style-rtl.css 10.2 kB 0 B
build/block-editor/style.css 10.2 kB 0 B
build/block-library/editor-rtl.css 7.05 kB 0 B
build/block-library/editor.css 7.05 kB 0 B
build/block-library/index.js 112 kB 0 B
build/block-library/style-rtl.css 7.14 kB 0 B
build/block-library/style.css 7.14 kB 0 B
build/block-library/theme-rtl.css 683 B 0 B
build/block-library/theme.css 685 B 0 B
build/block-serialization-default-parser/index.js 1.88 kB 0 B
build/block-serialization-spec-parser/index.js 3.1 kB 0 B
build/blocks/index.js 48.1 kB 0 B
build/components/index.js 198 kB 0 B
build/components/style-rtl.css 16.9 kB 0 B
build/components/style.css 16.9 kB 0 B
build/core-data/index.js 11.4 kB 0 B
build/data-controls/index.js 1.29 kB 0 B
build/data/index.js 8.43 kB 0 B
build/date/index.js 5.47 kB 0 B
build/deprecated/index.js 772 B 0 B
build/dom-ready/index.js 569 B 0 B
build/dom/index.js 3.1 kB 0 B
build/edit-navigation/index.js 3.54 kB 0 B
build/edit-navigation/style-rtl.css 485 B 0 B
build/edit-navigation/style.css 485 B 0 B
build/edit-post/index.js 27.7 kB 0 B
build/edit-post/style-rtl.css 12.3 kB 0 B
build/edit-post/style.css 12.3 kB 0 B
build/edit-site/index.js 11 kB 0 B
build/edit-site/style-rtl.css 5.26 kB 0 B
build/edit-site/style.css 5.25 kB 0 B
build/edit-widgets/index.js 8.33 kB 0 B
build/edit-widgets/style-rtl.css 5 kB 0 B
build/edit-widgets/style.css 5 kB 0 B
build/editor/editor-styles-rtl.css 428 B 0 B
build/editor/editor-styles.css 431 B 0 B
build/editor/index.js 43.3 kB 0 B
build/editor/style-rtl.css 3.27 kB 0 B
build/editor/style.css 3.27 kB 0 B
build/element/index.js 4.65 kB 0 B
build/escape-html/index.js 733 B 0 B
build/format-library/style-rtl.css 502 B 0 B
build/format-library/style.css 502 B 0 B
build/hooks/index.js 2.13 kB 0 B
build/html-entities/index.js 622 B 0 B
build/i18n/index.js 3.56 kB 0 B
build/is-shallow-equal/index.js 711 B 0 B
build/keyboard-shortcuts/index.js 2.51 kB 0 B
build/keycodes/index.js 1.94 kB 0 B
build/list-reusable-blocks/index.js 3.12 kB 0 B
build/list-reusable-blocks/style-rtl.css 226 B 0 B
build/list-reusable-blocks/style.css 226 B 0 B
build/media-utils/index.js 5.29 kB 0 B
build/notices/index.js 1.79 kB 0 B
build/nux/index.js 3.4 kB 0 B
build/nux/style-rtl.css 616 B 0 B
build/nux/style.css 613 B 0 B
build/plugins/index.js 2.67 kB 0 B
build/primitives/index.js 1.49 kB 0 B
build/priority-queue/index.js 789 B 0 B
build/redux-routine/index.js 2.84 kB 0 B
build/rich-text/index.js 14.8 kB 0 B
build/server-side-render/index.js 2.67 kB 0 B
build/shortcode/index.js 1.7 kB 0 B
build/token-list/index.js 1.28 kB 0 B
build/url/index.js 4.02 kB 0 B
build/viewport/index.js 1.84 kB 0 B
build/warning/index.js 1.14 kB 0 B
build/wordcount/index.js 1.17 kB 0 B

compressed-size-action

@jasmussen
Copy link
Contributor

This is what I see:

subsup

Lovely, people are going to love this. I think it's also a good use of a dropdown.

I'd put both options at the end below text color, though.

And yes, we do need some icons. I made these:

Screenshot 2020-04-24 at 12 00 23

I don't love them, but so long as we name them correctly, subscript and superscript, we can get them into the icon component and iterate. Here are SVGs:

Subscript:

<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M16.9 18.3l.8-1.2c.4-.6.7-1.2.9-1.6.2-.4.3-.8.3-1.2 0-.3-.1-.7-.2-1-.1-.3-.4-.5-.6-.7-.3-.2-.6-.3-1-.3s-.8.1-1.1.2c-.3.1-.7.3-1 .6l.2 1.3c.3-.3.5-.5.8-.6s.6-.2.9-.2c.3 0 .5.1.7.2.2.2.2.4.2.7 0 .3-.1.5-.2.8-.1.3-.4.7-.8 1.3L15 19.4h4.3v-1.2h-2.4zM14.1 7.2h-2L9.5 11 6.9 7.2h-2l3.6 5.3L4.7 18h2l2.7-4 2.7 4h2l-3.8-5.5 3.8-5.3z"/></svg>

Superscript:

<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M16.9 10.3l.8-1.3c.4-.6.7-1.2.9-1.6.2-.4.3-.8.3-1.2 0-.3-.1-.7-.2-1-.2-.2-.4-.4-.7-.6-.3-.2-.6-.3-1-.3s-.8.1-1.1.2c-.3.1-.7.3-1 .6l.1 1.3c.3-.3.5-.5.8-.6s.6-.2.9-.2c.3 0 .5.1.7.2.2.2.2.4.2.7 0 .3-.1.5-.2.8-.1.3-.4.7-.8 1.3l-1.8 2.8h4.3v-1.2h-2.2zm-2.8-3.1h-2L9.5 11 6.9 7.2h-2l3.6 5.3L4.7 18h2l2.7-4 2.7 4h2l-3.8-5.5 3.8-5.3z"/></svg>

@CalumChilds
Copy link

CalumChilds commented Apr 24, 2020

@jasmussen The icons look good, but I think that when text is selected, the subscript and superscript icons should appear to the right of the hyperlink button.

@jasmussen
Copy link
Contributor

when text is selected, the subscript and superscript icons should appear to the right of the hyperlink butto

This doesn't scale very well to narrow contexts, and since you have to select something to make it bold would be barely different from having them there all the time.

Putting them in the drop-down is an effort to strike the balance between having the feature available, but recognizing that it's a feature you'll use rarely, unlike bold and italic.

This is always a difficult balance to find, but I think it's the right balance.

@ellatrix
Copy link
Member Author

@jasmussen Perfect! Thanks for the icons!

@ellatrix ellatrix merged commit ef6efd7 into master Apr 27, 2020
@ellatrix ellatrix deleted the add/sub-sup-formats branch April 27, 2020 10:55
@github-actions github-actions bot added this to the Gutenberg 8.0 milestone Apr 27, 2020
@piettt
Copy link

piettt commented Apr 27, 2020

Wonderfull !.
And if I can, I would say that adding a "non breaking space -" " this will also be fine.

Regard.

PS: how can we test or help ?

@paaljoachim
Copy link
Contributor

Hey @piettt

One way I usually help/test is to open PR's in gutenberg.run and add the PR number. It usually takes 3-4 tries before I am able to enter the site to test what the PR does. There I might take screenshots, or just in general see how something works and then give feedback.

Do also join the WordPress slack #core-editor channel. See https://make.wordpress.org/core/ for more information.

Have a great day!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Buttons for superscript and subscript
5 participants