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

Insert Summary block #7115

Closed
paaljoachim opened this issue Jun 4, 2018 · 2 comments
Closed

Insert Summary block #7115

paaljoachim opened this issue Jun 4, 2018 · 2 comments

Comments

@paaljoachim
Copy link
Contributor

paaljoachim commented Jun 4, 2018

I am not able to locate a summary issue even though I have seen one earlier, so that I am adding a new here.

The plugin Advanced Gutenberg https://www.joomunited.com/wordpress-products/advanced-gutenberg has included an "insert summary" block. It looks like this:

insert-summary-joomunited

summary-inserted-joomunited

@mtias
Copy link
Member

mtias commented Jun 4, 2018

The issue has been closed as not being considered for now for v1:
#1760
#2871

If someone wants to do a branch and show how it'd work — the screenshot there seems to suggest you click on the toolbar button to refresh the content, which might be a bit awkward.

@mtias mtias closed this as completed Jun 4, 2018
@anevins12
Copy link
Contributor

anevins12 commented Jun 6, 2018

I've installed this plugin (it's on the plugin repo): https://wordpress.org/plugins/advanced-gutenberg/

The behaviour of the Insert Summary button is as follows:

  • The button has this markup:
    <button class="button" style="position: absolute; bottom: 10px; right: 15px">Insert Summary</button>
  • On pressing the button;
  1. The Document Outline component disappears;
  2. Focus is moved to a new block added for the summary;
  3. This new block is pre-populated with links. These links are coupled with the heading level structure outlined in the Document Outline component.

There are a few improvements we could make when integrating this:

  • The Document Outline component should remain expanded when focus is moved to the newly inserted block;
  • We should include hidden text that describes its action of moving the focus to the newly inserted block;
  • Maybe we need to take a step back and envisage how best this would be used from a UX perspective. The functionality is almost there, but I still think the journey isn't clear to a user. The journey that pressing "Insert Summary" creates a new block at the top of content, in which has links that represent heading levels - and when links are pressed they do X, Y and Z.
  • The newly created block (by pressing "Insert Summary) is essentially another navigational aid to the user and should be marked up with a NAV and (aria-)label . I understand this is also an issue on the Document Outline component.
  • The newly inserted block needs a button to delete the block and not just rely on the Escape key;
  • The newly inserted block does not identify itself as a Summary block and may not be identifiable as such to people in general;
  • The "Insert Summary" button gets disabled after a summary has been inserted. This should be explained in plain text instead of relying on the user to know this - again some UX work needed.

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

No branches or pull requests

3 participants