Skip to content

Prototypes: Requirements #190

Closed
Closed

Description

@mtias

All technical prototypes need to accomplish the following:

  • Use post-content.js data.
  • Infer blocks from content structure.
  • Should follow design of UI prototype and mockups for blocks.
  • Have “selected”, “writing”, and “hover” states.
    • Selected state shows all controls.
    • Writing state fades out UI.
    • Hover state shows block outline and move-arrows.
  • Moving a block should select the block.
  • Moving a block should scroll the window to focus on the block.
  • Implement block type switcher that works for text/heading/quote.
  • Implement block level attributes for text, image, and quote.
  • Implement insert-block menu toggled by the (+).
  • Any new line outside of blocks should show the (+) and if you start writing should default to text block.
  • Insert-block menu should allow to insert any of the post-content blocks.
  • When a block is at the top or bottom and they cannot be moved further, the corresponding arrow should be grayed out.
  • Integrate basic API for defining a block markup and inferring block data from it.

Text

  • Should support alignment options at block level.
  • Should support TinyMCE formatting.
  • Enter creates new text block.

Heading

  • Should show band with different headings.

Image

  • All alignment needs to work (floated and full-bleed).
  • Implement caption and handle markup variations.
  • Caption field should appear only when block is selected.

Quote

  • Needs to support two styles.
  • Should support cite attribute that is edited in place.
  • Cite field should appear only when block is selected.
  • It should not be possible to mess the cite or quote markup in visual mode.

Activity

  1. anna-harrison commented on Mar 7, 2017

    @anna-harrison

    @mtias should we add "Design" label to this issue? Thx

  2. added
    [Type] TaskIssues or PRs that have been broken down into an individual action to take
    on Mar 7, 2017
  3. jasmussen commented on Mar 7, 2017

    @jasmussen
    Contributor

    should we add "Design" label to this issue? Thx

    Since all the prototypes should look virtually the same, it's probably best to keep the discussion on the visuals on the individual tickets for the design.

  4. added
    [Type] Technical PrototypeOffers a technical exploration into an idea as an example of what's possible
    and removed on Mar 7, 2017
  5. mtias commented on Mar 7, 2017

    @mtias
    MemberAuthor

    Yes, this is a list of requirements for the technical prototypes to have a comparable set of features. If there are things here that we don't yet have in the UI Prototype we should make mockups for them separately.

  6. ellatrix commented on Mar 7, 2017

    @ellatrix
    Member

    Sounds good, I'll work on this for single.

    Enter should do single line break; double enter should create new text block.

    Are we settled on this? Has there been any discussion? Could someone describe the behaviour a bit better? Should other blocks still create a new paragraph (e.g. heading)?

  7. mtias commented on Mar 7, 2017

    @mtias
    MemberAuthor

    Good question. Not settled, but we need to pick one behaviour now to have a comparable experience. I'd be ok with punting this and having a simpler "enter creates new text block". Does that sound more reasonable?

  8. jasmussen commented on Mar 7, 2017

    @jasmussen
    Contributor

    Are we settled on this? Has there been any discussion? Could someone describe the behaviour a bit better? Should other blocks still create a new paragraph (e.g. heading)?

    Not settled. But we also haven't really tried it yet, given it a fair shake. So feels worth trying. And if it's a bit-flip in TinyMCE, seems worth a shot, with the goal being to make informed decisions.

  9. jasmussen commented on Mar 7, 2017

    @jasmussen
    Contributor

    See also #198 for mockups for every base block.

  10. mtias commented on Mar 7, 2017

    @mtias
    MemberAuthor

    Adding them to the description.

  11. ellatrix commented on Mar 8, 2017

    @ellatrix
    Member

    Single MCE tracking comment:

    • Use post-content.js data.
    • Infer blocks from content structure.
    • Should follow design of UI prototype and mockups for blocks.
    • Have “selected”, “writing”, and “hover” states.
      • Selected state shows all controls.
      • Writing state fades out UI.
      • Hover state shows block outline and move-arrows.
    • Moving a block should select the block.
    • Moving a block should scroll the window to focus on the block.
    • [Similar functionality.] Implement block type switcher that works for text/heading/quote.
    • Implement block level attributes for text, image, and quote.
    • [Needs search.] Implement insert-block menu toggled by the (+).
    • Any new line outside of blocks should show the (+) and if you start writing should default to text block.
    • Insert-block menu should allow to insert any of the post-content blocks.
    • When a block is at the top or bottom and they cannot be moved further, the corresponding arrow should be grayed out.
    • Integrate basic API for defining a block markup and inferring block data from it.

    Text

    • Should support alignment options at block level.
    • Should support TinyMCE formatting.
    • Enter should do single line break; double enter should create new text block.

    Heading

    • Should show band with different headings.

    Image

    • All alignment needs to work (floated and full-bleed).
    • Implement caption and handle markup variations.

    Quote

    • Needs to support two styles.
    • Should support cite attribute that is edited in place.
    • It should not be possible to mess the cite or quote markup in visual mode.
  12. ellatrix commented on Mar 8, 2017

    @ellatrix
    Member

    If anyone likes to work on these, let me know, just so we're not working on the same. Trying to get the inserter in today.

  13. youknowriad commented on Mar 8, 2017

    @youknowriad
    Contributor

    Multi-Instance MCE tracking comment:

    • Use post-content.js data.
    • Infer blocks from content structure.
    • Should follow design of UI prototype and mockups for blocks. (Not perfect)
    • Have “selected”, “writing”, and “hover” states.
      • Selected state shows all controls.
      • Writing state fades out UI.
      • Hover state shows block outline and move-arrows.
    • Moving a block should select the block.
    • Moving a block should scroll the window to focus on the block.
    • Implement block type switcher that works for text/heading/quote.
    • Implement block level attributes for text, image, and quote.
    • Implement insert-block menu toggled by the (+).
    • Any new line outside of blocks should show the (+) and if you start writing should default to text block.
    • Insert-block menu should allow to insert any of the post-content blocks.
    • When a block is at the top or bottom and they cannot be moved further, the corresponding arrow should be grayed out.
    • Integrate basic API for defining a block markup and inferring block data from it.

    Text

    • Should support alignment options at block level.
    • Should support TinyMCE formatting.
    • Enter should do single line break; double enter should create new text block.

    Heading

    • Should show band with different headings.

    Image

    • All alignment needs to work (floated and full-bleed).
    • Implement caption and handle markup variations.

    Quote

    • Needs to support two styles.
    • Should support cite attribute that is edited in place.
    • It should not be possible to mess the cite or quote markup in visual mode.
  14. aduth commented on Mar 9, 2017

    @aduth
    Member

    What of #179 should we integrate into the requirements here? Many of these text interactions will be important to preserve.

    cc @azaozz

  15. intronic commented on Mar 12, 2017

    @intronic
    Contributor

    @iseulde - fyi we are working today on:

    • making drag&drop work with hover
    • 'Moving a block should select the block.'
  16. mimo84 commented on Mar 13, 2017

    @mimo84
    Contributor

    @iseulde: @intronic and I have just opened a new PR #249 which provides

    • Hover shows block outlines
    • Hovered blocks can be dragged and dropped
    • Blocks not currently selected can be dragged and dropped (on hover)

    blockdraganddrop

  17. youknowriad commented on Mar 13, 2017

    @youknowriad
    Contributor

    I checked all the requirements for the "Multi" prototype. I'm sure I've missed some use-cases or introduced some regressions. Please let me know if you notice something missing.

  18. jasmussen commented on Mar 14, 2017

    @jasmussen
    Contributor

    I checked all the requirements for the "Multi" prototype. I'm sure I've missed some use-cases or introduced some regressions. Please let me know if you notice something missing.

    Looks amazing. Very very good work 👏👏👏

    There are some little things UI wise, but nothing critical for evaluating the prototype at all. I'll see if I can take a stab at them, but as it stands this prototype works excellently, in fact better than I'd expected it to!

  19. azaozz commented on Mar 14, 2017

    @azaozz
    Contributor

    What of #179 should we integrate into the requirements here? Many of these text interactions will be important to preserve.

    Ideally, all of them. I realize most of these behaviors are not used commonly. Personally I use only 2-3 on a regular basis. However the so called "power users" will probably use many. Also all of them are important for accessibility, some are critical. They are at approximately the same "level of importance" as using Cmd+C and Cmd+V for copy/paste.

    There is a very easy way to test :) Unplug your mouse (literally) and try to create some content in few different editors, including both prototypes and the current editor.

  20. jasmussen commented on May 10, 2017

    @jasmussen
    Contributor

    Closing this one as it seems no longer relevant.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    [Type] TaskIssues or PRs that have been broken down into an individual action to take[Type] Technical PrototypeOffers a technical exploration into an idea as an example of what's possible

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions