README.md

Workflowy Redux Notes

Basics

Workflowy is a structured text editor built around lists. Lists can have sublists and those sublists in turn can have their own lists. You can “focus” on a list by clicking on it, during which point that list becomes the root list in your view(much like clicking on a folder in a file explorer). The navbar shows where you are in the list hierarchy.

You can edit lists by clicking on their content and typing. You can add a new list by pressing enter while editing a list item. If you’re at the end of the item you’ll get a new item. If you’re in the middle you’ll split the list in two. If you’re at the start you’ll create a new list above the current list.

You can delete items by either clicking on the “delete” button in the item’s menu. Alternatively if the item is empty and you hit backspace, that will also delete the item.

Data

{
  nodes: {
    [uuid]: { content: [node's content] }
  }
  nodeOnNodes: {
    [uuid]: [array of node ids]
  }
  root: [id of the root node, where rendering starts]
  focus: {
    id: [id of currently focused node],
    cursorPosition: [integer representing where in the node's content we are at]
  }
}

Programming Tasks

Done:

• normalize data

• Use containers

• get rendering working

• handle new nodes

  • support splitting existing nodes by hitting return in the middle of their content
  • support adding new nodes by pressing enter at the end of the content of an existing node
  • when the current node has no children, the new node should be a child of the current node’s parent

• Editing node content

  • Restore cursor position when components are re-rendered
    • keep track of cursor position at all times
  • Allow insertion of whitespace correctly at end of node

• Move items left and right with tab and shift + tab

  • move right
  • move left
    • Figure out a good way to make grandparent discovery easy options:
      • child -> parent index
      • add parent attribute to each node in the state
        • I’m gonna go with this for now
  • shifting indentation when focused should limit movement to the current scope FIX: check if parent is root

• Backspace on an empty item with no children should delete that entry

  • focus changes to the item above it, with the cursor at the end
  • if there is no item above it, then change focus to the one below it, with the cursor at the start
  • if there are no items above or below, then we can’t delete
  • we also can’t delete when self is root

• Update the focused element in the state when an item is clicked on or a key is changed

• Move around with the up and down keys

• add bullet icon next to note

• bread crumbs

  • follow the trail of parents until we find the true root node, pushing each item to the top of an array
  • then render that array as the breadcrumb
  • when you click on a bread crumb link, the root will be set to the link’s id

• Move items around with Meta + Shift + Up

Ongoing:

• an empty list should have a + button at the bottom that adds an item on click
• Notes, added with shift + Return
• When you hit down at the end of a list, the cursor should go to the end of that item.
• Hiding and unhiding
• undo + redo
• dates
• - Fix backspace on selections
  • Use onInput
• search

Styling Tasks:

Done:

• Top level element should have a larger font
• top level element shouldn’t have a bullet
• bullet needs outline on hover

Ongoing:

• True root shouldn’t render anything

Ideas:

• Tables

Bugs

• For some reason new items have invisible \ns inside of them.
• When you add a new item, the cursor appears before the bullet point

Notes

Animation:

Workflowy has nice animations that make sure the user understands what is happening. The important ones are:

• Hiding/Showing an item slowly reveals the sub-tree of items
• Zooming into an item visually moves its entire hierarchy to the top level.

Arrow Up:

To move up in the list hierarchy, you want the cursor focus to change to the node visually above the current node.

IF the current node is the first child of its parent
THEN move the focus to the parent node

ELSE 
SET CurrentRelative = the immediately preceding sibling of the current node
UNTIL CurrentRelative has no children {
  currentRelative = currentRelative.children.last
}
Change Focus to current relative

• alternatively we can create a data structure that keeps track of node order across parent/child boundaries and update it when the state changes

Arrow Down:

To move down in the list hierarchy, you want the cursor focus to change to the node visually below the current node

IF the current node has any children, then move focus to the first child

IF the current node is the last child, then see if the current node's parent has any children which are not the last child amongst their siblings. if such a child exists, change the focus. Otherwise change the current node to the current node's parent and repeat.

Moving an item up/Moving an item down:

In workflowy this only changes the order amongst siblings. So we don’t need to worry about the list hierarchy.