Contents

Data

Essential Classes

States

Actions

Data Access

Components

layouts

An app state of component layouts. To get the layouts state:

const { layouts } = inkdrop.store.getState()

Or, to connect with your React component:

import { useSelector } from 'react-redux'

const selector = ({ layouts }) => layouts

const MyComponent = props => {
  const layouts = useSelector(selector)
  // render
}

Data Structure

A map of [layout_name]: LayoutComponents where:

  • layout_name: String
  • LayoutComponents: A class name of React component

main:full

The main layout that consists of 3 columns.

Default value

["ModalLayout", "SideBarLayout", "NoteListBarLayout", "EditorLayout"]

main:slim

The main layout that consists of 2 columns.

Default value

["ModalLayout", "NoteListBarLayout", "EditorLayout"]

main:distraction-free

The main layout for distraction-free mode.

Default value

["ModalLayout", "EditorLayout"]

The sidebar layout

Default value

[
  "SideBarHeader",
  "SideBarNavigation",
  "SideBarSyncStatusView",
  "SideBarPluginUpdatesNotificationView"
]

The menu layout of sidebar

Default value

[
  "SideBarMenuItemAllNotes",
  "SideBarMenuSectionNotebooks",
  "SideBarMenuBookListRoot",
  "SideBarMenuItemTrash",
  "SideBarMenuSectionStatus",
  "SideBarMenuStatusList",
  "SideBarMenuSectionTags",
  "SideBarMenuTagList"
]

The menu layout of sidebar workspace menu

Default value

[
  "SidebarWorkspaceMenuTitle",
  "SideBarWorkspaceMenuAllNotes",
  "SideBarMenuSectionNotebooks",
  "SideBarWorkspaceMenuBookList",
  "SideBarMenuSectionStatus",
  "SidebarWorkspaceMenuStatusList",
  "SideBarMenuSectionTags",
  "SidebarWorkspaceMenuTagList"
]

note-list-bar

The menu layout of note list bar

Default value

["NoteListHeader", "NoteListSearchBar", "NoteListBarContainer"]

note-list-bar:trash

The trash menu layout of note list bar

Default value

["NoteListHeader", "NoteListBarContainer"]

mde

The mde layout

Default value

["Editor"]

editor

The editor layout

Default value

[
  "EditorDrawer",
  "EditorFloatingActions",
  "EditorHeaderLayout",
  "EditorMetaLayout",
  "EditorToolbar",
  "MDELayout",
  "MDESearchBar",
  "EditorStatusBarLayout"
]

editor-header

The header layout of the editor

Default value

["EditorHeaderTitleInput", "EditorHeaderMore"]

editor-meta

The meta pane layout of the editor

Default value

["EditorMetaNotebook", "EditorMetaStatusPicker", "EditorMetaTags"]

The layout for modal components

Default value

[
  "NewNotebookDialog",
  "DeleteNotebookDialog",
  "RenameNotebookDialog",
  "TagSettingsDialog",
  "DeleteTagDialog",
  "AssistiveErrorDialog",
  "MoveNotesDialog",
  "MoveNotebookDialog",
  "EmptyTrashDialog",
  "ShareNoteDialog",
  "NoteRevisionsDialog"
]

editor-toolbar

The toolbar layout of the editor

Default value

[]

editor-drawer-menu

The editor drawer menu items

Default value

[
  "EditorDrawerSectionHeaderNoteInformation",
  "EditorDrawerMenuItemNotebook",
  "EditorDrawerItemStatus",
  "EditorDrawerItemTags",
  "EditorDrawerItemCreatedDate",
  "EditorDrawerItemUpdatedDate",
  "EditorDrawerSeparator-1",
  "EditorDrawerSectionHeaderActions",
  "EditorDrawerActionButtonDuplicate",
  "EditorDrawerActionButtonCopyNoteLink",
  "EditorDrawerActionButtonPinToTop",
  "EditorDrawerActionButtonOpenNoteInSeparateWindow",
  "EditorDrawerSeparator-2",
  "EditorDrawerActionButtonDeleteNote",
  "EditorDrawerActionButtonRevisionHistory",
  "EditorDrawerSeparator-3",
  "EditorDrawerActionButtonShare"
]

editor-status-bar

The status bar layout of the editor

Default value

[]

editor-floating-actions

The floating action buttons on the editor

["EditorFloatingActionTogglePreview", "EditorFloatingActionToggleSideBySide"]

Can you help us improve these docs?

The source of these docs is here on GitHub. If you see a way these docs can be improved, please fork us!