Skip to content
Plim
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Live demo
Live
Guides
Introduction
Installation
Quickstart
Input box (single-block)
Custom blocks
Custom marks
Actions & triggers
Extensions
Mojis (custom emoji)
History
Snapshots
Ledger & sync
Collaboration
Comments & replies
Markdown
HTML & SSR
Storage & autosave
Testing
API Reference
@plim/core
Classes
History
PlimDriver
Snapshot
Transaction
Interfaces
EditorHandle
Type Aliases
ActionContext
ActionDescriptor
ActionPerform
AsyncEventHandler
BlockDescriptor
BlockMarkdownContext
BlockMarkdownParseContext
BlockMarkdownParseResult
BlockNode
BlockPath
BlockPayload
CursorPosition
DocumentNode
EditorState
ExtensionFactory
ExtensionShape
HistoryEntry
HistoryListener
MarkDescriptor
MarkInstance
MarkPayload
ModifierKey
PlimDriverConfig
Selection
SnapshotData
TextSpan
Theme
ToolbarItem
ToolbarItemContext
TransactionMeta
TransactionOp
Trigger
ValidationBuilders
ValidationContext
ValidationRule
ValidationRuleName
Variables
ACTION_TAG
boldMark
builders
builtInBlocks
builtInMarks
bulletedListBlock
codeBlock
codeMark
embeddedMediaBlock
headingBlock
highlightMark
horizontalRuleBlock
imageBlock
italicMark
linkMark
mentionMark
numberedListBlock
paragraphBlock
quoteBlock
rawHTMLBlock
strikethroughMark
tableBlock
todoListBlock
toggleBlock
triggers
underlineMark
Functions
applyMarkToRange
applyOp
applyTransaction
blockPlainText
blockTextLength
clonePath
clonePosition
cloneSelection
comparePaths
defineAction
defineBlock
defineExtension
defineMark
emptyText
evalRule
findBlockPathById
flattenBlocks
getBlockAt
getBlockParent
hasMark
invertOp
invertOps
isMacLike
marksAtOffset
marksEqual
matchKeyboardEvent
newId
nextBlockPath
normalizeText
prevBlockPath
processExtension
replaceTextRange
samePath
selectionIsEmpty
sliceText
@plim/editor
Type Aliases
AgnosticEditor
ContainerAdapter
DeriveEditorOptions
Functions
attachContainer
deriveEditor
@plim/react
Interfaces
Snapshot
Type Aliases
ActionPanelAnchor
ActionPanelProps
AgnosticEditor
AsyncEventHandler
AsyncListenerRegistration
CommentCardProps
CommentComposerProps
CommentsLayerProps
CommentThreadCardProps
EditorHandle
HoverMenuProps
MentionExtensionOptions
MentionMenuProps
MentionUser
PlimEditorProps
PlimInputBoxProps
SlashCommandApplyContext
SlashCommandExtensionOptions
SlashCommandItem
SlashCommandMenuProps
Variables
DEFAULT_MENTION_USERS
DEFAULT_SLASH_ITEMS
Functions
ActionPanel
CommentCard
CommentComposer
CommentsLayer
CommentThreadCard
ContentSlot
currentSelectionRect
formatRelativeTime
HoverMenu
mentionExtension
MentionMenu
PlimEditor
PlimInputBox
slashCommandExtension
SlashCommandMenu
useAsyncEventListener
useComments
useEditorHandle
@plim/markdown
Functions
contentFromMarkdown
contentToMarkdown
parseMarkdown
@plim/mojis
Interfaces
CreateResolverOptions
MojiCache
MojiDefinition
MojiExtensionOptions
Type Aliases
AsyncMojiResolver
MojiResolver
Variables
DEFAULT_MOJIS
MOJI_IMAGE_PLACEHOLDER
MOJI_MARK_NAME
mojiMark
Functions
blockAtPath
charHasMojiAt
createMojiCache
createMojiResolver
flatText
followedByMoji
mojiExtension
mojiSpan
nextGraphemeEnd
normalizeMojis
pathsEqual
precededByMoji
previousGraphemeStart
@plim/html
Type Aliases
BlockRenderer
HTMLInput
HTMLSerializerOptions
MarkRenderer
RenderContext
Variables
defaultBlockRenderers
defaultMarkRenderers
Functions
attr
escape
serializeToHTML
toDocumentNode
@plim/ledger
Classes
TransactionLedger
Type Aliases
AttachOptions
ConflictStrategy
LedgerDiff
LedgerListener
LedgerOptions
LedgerRecord
LedgerSnapshot
MapBias
RebaseManyResult
RebaseResult
RecordFromTransactionOptions
RecordSummary
RecordTouch
ResolveResult
Variables
firstWriteWins
lastWriteWins
ROOT_ID
Functions
applyLedgerRecord
compareRecords
computeTouches
diffLedgers
findConflicts
mergeLedgers
preferSource
rebaseBlockPath
rebaseRecord
rebaseRecords
rebaseTextPoint
recordFromTransaction
recordsConflict
resolveConflicts
summarizeRecord
@plim/transports
Classes
BroadcastChannelTransport
MemoryBus
WebSocketTransport
Interfaces
BroadcastChannelLike
BroadcastChannelTransportOptions
MemoryBusOptions
Transport
WebSocketCtor
WebSocketLike
WebSocketTransportOptions
Type Aliases
WebSocketStatus
Functions
createMemoryTransportPair
mapTransport
@plim/collaboration
Classes
CollabHub
Collaborator
CommentStore
CommentSync
InMemoryAuthority
MemoryNetwork
PresenceTracker
Interfaces
CollaboratorOptions
CollabStatus
HubClient
MemoryNetworkOptions
Peer
PeerPresence
PresenceBroadcast
PresenceState
PresenceTrackerOptions
SubmitResult
Type Aliases
AddCommentInput
CollabChangeListener
CollabEditor
CollabMessage
Comment
CommentAuthor
CommentComposeDetail
CommentEvent
CommentEventBase
CommentEventKind
CommentMessage
CommentStoreOptions
CommentThread
CreateThreadInput
DocRange
PeerId
PresenceEvent
PresenceListener
Transport
VersionVector
Variables
COMMENT_COMPOSE_EVENT
COMMENT_MARK_NAME
COMMENT_THREAD_ATTR
commentMark
Functions
addCommentMark
allCommentThreadIds
commentMarkRanges
commentThreadIdsInSelection
coversRecord
createCommentSync
createMemoryNetwork
findCommentRanges
mergeVersionVectors
recordsAfter
removeCommentMark
versionVectorOf
@plim/storage
Interfaces
Autosave
AutosaveOptions
IndexedDBAdapterOptions
LocalStorageAdapterOptions
StorageAdapter
TransportAdapterOptions
Type Aliases
DocumentStore
PersistableEditor
StorageTransportLoadedMessage
StorageTransportLoadMessage
StorageTransportMessage
StorageTransportRemoveMessage
StorageTransportSaveMessage
Functions
createAutosave
createDocumentStore
createIndexedDBAdapter
createLocalStorageAdapter
createMemoryAdapter
createTransportAdapter
@plim/test-utils
Type Aliases
BlockOptions
IdFactory
IdFactoryOptions
InlineChild
NormalizedBlock
NormalizedDoc
NormalizedTextSpan
StateOrDoc
TestEditor
TestEditorOptions
TextBlockOptions
Functions
apply
applyTx
assertBlockText
assertBlockType
assertDocEquals
assertHasMark
assertNoMark
assertPlainText
block
blockText
bold
bulletItem
code
codeBlock
createIdFactory
createTestEditor
debugTree
divider
doc
getBlock
heading
highlight
inline
italic
link
mark
marksAt
normalizeDoc
numberedItem
paragraph
plainText
quote
strike
text
todoItem
toggle
underline
GitHub
Select theme
Dark
Light
Auto
builders
const
builders
:
ValidationBuilders
;
Defined in: validation.ts:60