FPO.Components.TOC

data Action

Constructors

• Init
• Both Action Action
• Receive (Connected Store Input)
• DoNothing
• JumpToLeafSection Int Path String
• JumpToNodeSection Path String String
• ToggleAddMenu Path
• ToggleHistoryMenu Path Int
• ToggleHistoryMenuOff Path
• ToggleHistorySubmenu (Maybe Int)
• CreateNewMSection FullTypeName ProperTypeMeta Path
• OpenVersion Int (Maybe Int)
• CompareVersion Int (Maybe Int)
• UpdateVersions (Maybe Date) (Maybe Date) Int
• RequestDeleteSection EntityToDelete

  Section deletion

• CancelDeleteSection
• ConfirmDeleteSection Path
• StartDrag Path (Disjunction FullTypeName)

  Drag and Drop

• HighlightDropZone Path (Disjunction FullTypeName) DragEvent
• ClearDropZones
• CompleteDrop Path
• SearchVersions Int

  UpdateSearchBarInputs Int String String ClearSearchData Int

• ModifyDateInput Boolean Int String
• UpdateUpToDateVersion
• OpenParagraphHistoryModal Int String

  Modal actions

• OpenDocumentHistoryModal
• CloseParagraphHistoryModal
• CloseDocumentHistoryModal
• HandleParagraphHistoryOutput Output
• HandleDocumentHistoryOutput Output
• OpenEditModal
• CloseEditModal
• UpdateTitles

data EntityKind

Constructors

• Section
• Paragraph

type EntityToDelete = { kind :: EntityKind, path :: Path, title :: String }

type Input = DocumentID

data Output

Constructors

• ChangeToLeaf Int (Maybe String)

  Opens the editor for some leaf node, that is, a subsection or paragraph.

• ChangeToNode Path String (Maybe String)

  Opens the editor for some non-leaf node. Used to rename sections

• UpdateNodePosition Path

  Used to tell the editor to update the path of the selected node

• AddNode Path (Tree TOCEntry)
• DeleteNode Path
• ReorderItems { from :: Path, to :: Path }
• ModifyVersion Int (Maybe Int)
• CompareTo Int (Maybe Int)
• RenameNode { newName :: String, path :: Path }

type Path = Array Int

data Query a

Constructors

• ReceiveTOCs TOCTree MetaMap a
• RequestCurrentTocEntryTitle (Maybe String -> a)
• RequestCurrentTocEntry (Maybe SelectedEntity -> a)
• RequestUpToDateVersion (Maybe Version -> a)
• RequestFullTitle (Maybe String -> a)
• SelectFirstEntry a
• SelectEntry Int a
• UpdateMSelectedTocEntry SelectedEntity (Maybe String) a

data SelectedEntity

Leafs can be identified by their ID, while nodes must unfortunately

Constructors

• SelLeaf Int
• SelNode Path String

Instances

• Show SelectedEntity
• Eq SelectedEntity

type Version = { author :: User, identifier :: Maybe Int, timestamp :: DocDate }

findLeafTitleInTree :: Int -> Tree TOCEntry -> Maybe String

tocview :: forall m. MonadAff m => Navigate m => MonadStore Action Store m => Component Query Input Output m