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

Tune design doc a bit #1714

Merged
merged 1 commit into from
Jul 5, 2017
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Tune design doc a bit
This adds a note on the selected and unselected state of a block.
  • Loading branch information
jasmussen authored Jul 5, 2017
commit 31e55b94f1b55d45ac8d4a707b4abe9a13f6e4c9
11 changes: 8 additions & 3 deletions docs/design.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,16 @@ The content area holds the document itself, and optionally a sidebar for context

The block itself is the most basic unit of the editor. Everything is a block, and you build them together mimicking the vertical flow of the underlying HTML markup. By surfacing each section of the document as a block we can manipulate, we can attach features that are unique to each block, contextually. Inspired by desktop layout apps, it's a way to add a breadth of advanced features without weighing down the UI.

As you scroll down a page on long blocks, the quick toolbar unsticks from the block, and sticks to the top of the screen.

The block interface holds _basic actions_. Through ensuring good defaults, and only the most common actions, you should be able to get all your blogging done without ever having to use the Post Settings sidebar.

If you need to do advanced configuration, though, you should keep the post settings sidebar open. The sidebar is contextual to what is selected:
The block itself has multiple states:

- An unselected block is the closest thing to a live preview of the contents itself.
- A selected block shows quick controls attached to the block itself, notably the quick toolbar. But a selected image block surfaces a caption field, a quote surfaces a citation field, and dynamic blocks could potentially surface quick configuration form fields right then and there.

As you scroll down a page on long blocks, the quick toolbar unsticks from the block, and sticks to the top of the screen.

If your block needs advanced configuration, though, you should keep the post settings sidebar open. The sidebar is contextual to what is selected:

- if nothing is selected, you are at the _document scope_, and see document metadata
- if a block is selected, you are at the _block scope_, and you see block metadata
Expand Down