Vizel API / core/src

core/src

Classes

Class	Description
VizelError	Structured error class for Vizel operations.
VizelPluginManager	Manages Vizel plugins: registration, lifecycle, extensions, and styles.

Interfaces

Interface	Description
CreateVizelEditorInstanceOptions	Options for creating a Vizel editor instance. Extends VizelEditorOptions with additional framework-specific parameters.
CreateVizelEditorInstanceResult	Result of creating a Vizel editor instance.
Editor	-
SlashItemText	Title and description for a slash menu item
VizelAdapterSymbol	Public symbol that an adapter exports for a feature.
VizelAriaContract	Accessibility contract for a feature's root element.
VizelAutoSaveOptions	Auto-save configuration options
VizelAutoSaveState	Auto-save state
VizelBlockClipboardOptions	Options for the block-aware clipboard extension.
VizelBlockMenuAction	A single block menu action definition.
VizelBlockMenuFromCommandsOptions	Options accepted by buildVizelBlockMenuSpecFromCommands.
VizelBlockMenuItemView	Item-data shape surfaced to the framework VizelBlockMenu component for each block action.
VizelBlockMenuOpenDetail	Event detail for block menu open requests. Dispatched when the drag handle is clicked (not dragged).
VizelBlockMenuSpec	The complete block-menu skeleton: main menu + submenu trigger + submenu.
VizelBlockMenuSubmenuTriggerSpec	The submenu trigger metadata. The trigger is a role="menuitem" button rendered after the action groups, opens the "Turn into" submenu, and advertises that via aria-haspopup + aria-expanded.
VizelBlockMenuTriggerController	Returned by createVizelBlockMenuTriggerController.
VizelBlockMenuTriggerControllerOptions	Options for createVizelBlockMenuTriggerController.
VizelBlockMenuTurnIntoItemView	Item-data shape surfaced for each "Turn into" submenu entry.
VizelBlockPathSegment	A single segment of a block path produced by getVizelBlockPath.
VizelBubbleMenuAction	A single bubble-menu action definition.
VizelBubbleMenuEscapeController	Returned by createVizelBubbleMenuEscapeController.
VizelBubbleMenuEscapeControllerOptions	Options for createVizelBubbleMenuEscapeController.
VizelBubbleMenuSpecOptions	Options accepted by buildVizelBubbleMenuSpec.
VizelCalloutOptions	Options for the Callout extension.
VizelCharacterCountOptions	-
VizelCharacterCountStorage	Character count storage interface for accessing count values.
VizelCodeBlockLanguage	Language definition for the code block language selector
VizelCodeBlockOptions	Options for creating the code block lowlight extension
VizelCollaborationOptions	Options for collaboration state management
VizelCollaborationProvider	Minimal collaboration-provider interface.
VizelCollaborationState	Collaboration connection state
VizelCollaborationUser	User information for collaboration cursor display
VizelColorDefinition	Color definition for text color and highlight
VizelCommand	Unified runtime-bearing command shared across editor surfaces.
VizelCommandShortcutsOptions	Options accepted by createVizelCommandShortcutsExtension.
VizelCommandSpec	Actionable item shared across command surfaces.
VizelCommandSurfaceSet	Set of surfaces a VizelCommand participates in.
VizelComment	A comment annotation on the document
VizelCommentMarkOptions	Options for the comment mark extension
VizelCommentOptions	Configuration options for comment management
VizelCommentPluginState	Plugin state for tracking the active comment
VizelCommentReply	A reply to a comment
VizelCommentState	Comment state
VizelContentNode	JSON content type for Tiptap documents
VizelCreateEditorOptions	Options for creating a Vizel editor instance with framework hooks/composables/runes. Extends VizelEditorOptions with ability to add custom Tiptap extensions.
VizelCreateUploadEventHandlerOptions	Options for creating an image upload event handler.
VizelDetailsContentOptions	Options for the VizelDetailsContent extension
VizelDetailsNodeOptions	Options for the Details container extension
VizelDetailsOptions	Combined options for all VizelDetails extensions
VizelDetailsSummaryOptions	Options for the VizelDetailsSummary extension
VizelDiagramOptions	Options for the Diagram extension
VizelDragHandleOptions	-
VizelEditorOptions	Editor configuration options
VizelEditorState	Editor state for external consumption
VizelEditorSubscriptionOptions	Options for createVizelEditorSubscription.
VizelEditorTransactionStore	Framework-agnostic store that exposes editor transaction notifications.
VizelEmbedData	Embed metadata returned from fetch
VizelEmbedOptions	Embed extension options
VizelEmbedProvider	oEmbed provider definition
VizelErrorOptions	Options accepted by the VizelError constructor.
VizelExtensionsOptions	-
VizelFeatureAdapters	Per-framework adapter declaration for a single feature.
VizelFeatureDefinition	Single feature definition consumed by pnpm check:feature-parity.
VizelFeatureOptions	Feature configuration for Vizel editor.
VizelFileHandlerError	File handler error
VizelFileHandlerOptions	Options for file handler extension
VizelFindMatch	Represents a single match in the document
VizelFindReplaceOptions	Options for the Find & Replace extension
VizelFindReplaceSpec	Derived display state for the VizelFindReplace panel. Each framework component recomputes this whenever the plugin state changes, then drives rendering off the boolean / string fields instead of duplicating the matchCount > 0 ? "${i}/${n}" : noResults ternary in three places.
VizelFindReplaceState	Internal state for the Find & Replace plugin
VizelFlavorConfig	Markdown flavor configuration consumed by extensions that need flavor-specific serialization tuning (callout output style, wiki-link bracket style).
VizelFormFieldAttrs	ARIA attributes for a single form field.
VizelFormFieldSpec	Spec for a single form field.
VizelFormRootAttrs	ARIA attributes for the form root.
VizelFormSpec	Spec for an inline input form.
VizelGridCellAttrs	ARIA attributes for a single grid cell.
VizelGridCellSpec	Spec for a single cell inside a grid.
VizelGridRootAttrs	ARIA attributes for a grid root.
VizelGridSpec	Spec for a two-dimensional grid (color picker, future emoji picker).
VizelHighlightOptions	Options for the highlight extension.
VizelIconContextValue	Context value for icon customization. Used by framework-specific icon providers.
VizelIconRendererOptions	Icon renderer options for customization.
VizelImageFeatureOptions	Image feature options.
VizelImageFileHandlerOptions	Create file handler handlers for image upload integration.
VizelImageFileHandlers	-
VizelImageOptions	-
VizelImageResizeOptions	Options for image resize functionality
VizelImageUploadOptions	Options for image upload extension
VizelImageUploadPluginOptions	Image upload plugin options
VizelImageUploadWithFileHandlerOptions	Options for image upload with file handler
VizelImageValidationError	Image validation error
VizelKeyboardMap	Keyboard bindings keyed by canonical command name.
VizelLinkEditorLabels	Localized labels for the VizelLinkEditor form, resolved from a VizelLocale (with sensible English fallbacks).
VizelLinkEditorSpec	Derived display state for the VizelLinkEditor form. The framework component recomputes this whenever url (or the editor selection) changes, then drives conditional rendering from the boolean flags.
VizelLinkOptions	-
VizelLinkSubmitParams	Parameters accepted by applyVizelLinkEdit.
VizelLocale	Locale definition for all Vizel UI strings.
VizelMarkdownEncodingOptions	Per-node encoding mode map.
VizelMarkdownFlavor	First-class Markdown flavor plugin.
VizelMarkdownItInstance	Minimal subset of the markdown-it parser instance that flavor plugins interact with at registration time.
VizelMarkdownOptions	Configuration options for the Vizel Markdown extension.
VizelMarkdownSyncHandlers	Create debounced markdown sync handlers. This is a framework-agnostic helper that frameworks can use to implement their own hooks.
VizelMarkdownSyncOptions	Options for Markdown synchronization
VizelMarkdownSyncResult	Result of Markdown synchronization.
VizelMathematicsOptions	Options for the Mathematics extension
VizelMentionItem	A single mention item for the suggestion list.
VizelMentionItemView	Item-data shape surfaced to the framework VizelMentionMenu component.
VizelMentionOptions	Options for the mention extension.
VizelMenuItemAttrs	ARIA attributes accepted on each item element inside the menu.
VizelMenuItemSpec	A single item slot in the menu spec.
VizelMenuRootAttrs	ARIA attributes accepted on the menu root element.
VizelMenuSectionSpec	A group of items rendered together, optionally preceded by a header.
VizelMenuSpec	The complete menu spec: root container attrs + sections.
VizelMountPortalOptions	Options for mounting portal content.
VizelMultiBlockSelectionOptions	Options for the multi-block range selection extension.
VizelMultiBlockSelectionState	Public plugin state for the multi-block range selection extension.
VizelNodeSelectorItemView	Item-data shape surfaced for each block-type option in the VizelNodeSelector popover.
VizelNodeSelectorSpec	The complete node-selector skeleton: trigger + popover.
VizelNodeSelectorTriggerSpec	Trigger button metadata. The trigger displays the currently-active block type's icon + label, falls back to the locale-aware "Text" label when no node type matches, and advertises the popover as a listbox.
VizelNodeTypeOption	Node type option for the node selector dropdown
VizelOutlineItemSpec	One entry in a document outline tree.
VizelOutlineSpec	Framework-neutral spec for the VizelOutline component.
VizelPlugin	Plugin interface for extending Vizel with third-party functionality.
VizelPopoverBodySpec	ARIA attributes for the floating body element of a popover.
VizelPopoverController	Returned by createVizelPopoverController.
VizelPopoverControllerOptions	Options for createVizelPopoverController.
VizelPopoverSpec	Spec for an anchored popover.
VizelPopoverTriggerSpec	ARIA attributes for the trigger element of a popover.
VizelPresenceAwareness	Minimal awareness interface that Vizel's presence extension consumes.
VizelPresenceOptions	Configuration for the presence extension.
VizelPresenceUser	A collaborator's identity for presence rendering.
VizelPresenceUserState	Per-user awareness state shared with other collaborators.
VizelRelativeTimeTicker	Returned by createVizelRelativeTimeTicker.
VizelRelativeTimeTickerOptions	Options for createVizelRelativeTimeTicker.
VizelResizableImageOptions	Configuration options for the VizelResizableImage extension. These are passed to VizelResizableImage.configure().
VizelResolveFeaturesOptions	Options for resolving features with a custom slash menu renderer.
VizelRoundtripSample	A single Markdown round-trip sample.
VizelSaveIndicatorView	Resolved view-model for the framework VizelSaveIndicator components.
VizelShortcut	Platform-specific keyboard shortcut.
VizelShortcutSpec	Platform-specific keyboard shortcut.
VizelSlashCommandExtensionOptions	-
VizelSlashCommandOptions	Slash command feature options
VizelSlashCommandStorage	Reactive storage published to framework suggestion renderers.
VizelSlashMenuFromCommandsOptions	Options accepted by buildVizelSlashMenuSpecFromCommands.
VizelSuggestionContainer	A managed suggestion container with positioning support.
VizelSuggestionRendererOptions	Options shared by every Tiptap suggestion renderer (slash menu, mention menu, future suggestion-driven surfaces).
VizelSystemThemeListener	Returned by createVizelSystemThemeListener.
VizelTableControlsUIOptions	Options for table controls UI (column/row insert buttons, row handle menu).
VizelTableMenuItem	-
VizelTableOfContentsOptions	Options for the Table of Contents extension.
VizelTableOptions	-
VizelTaskItemOptions	-
VizelTaskListExtensionsOptions	-
VizelTaskListOptions	-
VizelTextColorOptions	Options for text color extensions.
VizelTextSegment	A segment of text that may or may not be highlighted.
VizelThemeInitScriptOptions	Options for vizelThemeInitScript.
VizelThemeProviderOptions	Theme provider options
VizelThemeState	Theme state returned by useTheme hooks
VizelTOCHeading	A heading entry in the Table of Contents.
VizelToolbarAction	A single toolbar action definition.
VizelToolbarDropdownAction	A dropdown toolbar action that groups multiple sub-actions. When clicked, displays a popover with the nested options.
VizelToolbarDropdownItemView	Item-data shape surfaced to the framework VizelToolbarDropdown component for each option in the popover listbox.
VizelToolbarDropdownSpec	The complete toolbar-dropdown skeleton: trigger + popover.
VizelToolbarDropdownTriggerSpec	Trigger button metadata. The trigger advertises the popover as a listbox via aria-haspopup="listbox" and reflects the open state in aria-expanded. The visible icon + label follow the currently-active option (when getActiveOption is supplied) — for an unset state the dropdown's own icon + label are used.
VizelToolbarSpecOptions	Options accepted by buildVizelToolbarSpec.
VizelVersionHistoryOptions	Configuration options for version history
VizelVersionHistoryState	Version history state
VizelVersionSnapshot	A snapshot of the document at a point in time
VizelWikiLinkOptions	Options for the Wiki Link extension
VizelWikiLinkSuggestion	Suggestion item for wiki link autocomplete
VizelYjsAwareness	Interface matching the Yjs Awareness API. Compatible with y-protocols/awareness Awareness class.
VizelYjsProvider	Interface matching Yjs WebSocket provider API. Compatible with y-websocket WebsocketProvider and similar providers that emit "status" and "sync" events.
WrapAsVizelErrorOptions	Options for wrapping an unknown error as a VizelError.

Type Aliases

Type Alias	Description
CustomIconMap	Custom icon mappings to override default Iconify icon IDs. Keys are semantic icon names, values are Iconify icon IDs.
GraphvizEngine	GraphViz layout engine options
VizelBlockMenuIconName	Icon names used in Block Menu.
VizelBubbleMenuIconName	Icon names used in BubbleMenu toolbar.
VizelCalloutMarkdownFormat	Callout / admonition output format for Markdown serialization.
VizelCalloutType	Available callout types
VizelCommentStorage	Storage backend for comments.
VizelDiagramType	Supported diagram types
VizelDOMRectGetter	A function that returns a DOMRect or null. Used by Tiptap's suggestion system for positioning.
VizelEditorEventName	Editor event names that createVizelEditorSubscription can attach to.
VizelEmbedType	Embed type based on available metadata
VizelEmbedViewModel	Discriminated view-model for the framework VizelEmbedView components.
VizelErrorCode	Error codes for Vizel operations.
VizelErrorSeverity	Severity of a VizelError.
VizelFeatureCategory	Category that groups features by their UI role.
VizelFeatureId	Stable identifier for every advertised Vizel feature.
VizelFetchEmbedDataFn	Function to fetch embed data from URL This should be provided by the user to handle CORS
VizelFileHandlerErrorType	File handler error types
VizelIconName	All icon names used in Vizel.
VizelIconRenderer	Icon renderer function type. Framework packages inject their implementation to render icons as SVG strings.
VizelIconRendererWithOptions	Extended icon renderer function type with options support.
VizelImageValidationErrorType	Image validation error types
VizelInternalIconName	Icon names used internally in NodeView rendering (drag handle, table controls). These icons are rendered via the injected VizelIconRenderer from framework packages.
VizelLocalePartial	-
VizelMarkdownLossyEncodingMode	Encoding mode for nodes that lack a clean markdown representation.
VizelMarkSerializer	Serializer hook for a Tiptap mark type.
VizelNodeSerializer	Serializer hook for a Tiptap node type.
VizelNodeTypeIconName	Icon names used in node type selector.
VizelPopoverPlacement	Side the body prefers to sit on relative to the anchor.
VizelPortalLayer	Portal layer type
VizelResolvedTheme	Resolved theme (actual applied theme)
VizelSaveStatus	Save status type
VizelSlashCommandIconName	Icon names used in slash commands and menus. These are semantic names that map to actual icons in framework packages.
VizelStorageBackend	Storage backend abstraction shared by auto-save, comment, and version-history features.
VizelTableCellAlignment	Text alignment options for table cells.
VizelTableControlsOptions	Combined options for table with controls - extends Table's options with UI controls.
VizelTableIconName	Icon names used in table controls.
VizelTheme	Available theme options
VizelToolbarActionItem	Union type for any toolbar item — either a simple action or a dropdown.
VizelToolbarIconName	Icon names used in Toolbar.
VizelTypographyOptions	Options for the typography extension.
VizelUIIconName	Icon names used in UI components (SaveIndicator, etc.).
VizelUploadImageFn	Image upload function type
VizelVersionStorage	Storage backend for version history.

Variables

Variable	Description
VIZEL_BLOCK_MENU_EVENT	Custom event name for block menu open requests
VIZEL_DEFAULT_AUTO_SAVE_OPTIONS	Default auto-save options
VIZEL_DEFAULT_COLLABORATION_OPTIONS	Default collaboration options
VIZEL_DEFAULT_COMMENT_OPTIONS	Default comment options
VIZEL_DEFAULT_FILE_MIME_TYPES	Default allowed MIME types (images only)
VIZEL_DEFAULT_FLAVOR	Default Markdown flavor (GitHub Flavored Markdown).
VIZEL_DEFAULT_IMAGE_MAX_FILE_SIZE	Default maximum file size for images (20MB)
VIZEL_DEFAULT_MARKDOWN_DEBOUNCE_MS	Default debounce delay for markdown export in milliseconds.
VIZEL_DEFAULT_THEME	Default theme configuration
VIZEL_DEFAULT_THEME_STORAGE_KEY	Default storage key for persisting theme preference
VIZEL_DEFAULT_VERSION_HISTORY_OPTIONS	Default version history options
VIZEL_FEATURE_MANIFEST	The authoritative feature catalogue. Add, modify, and remove entries here together with the corresponding adapter and scenario changes; the parity check fails the build when an adapter omits a declared symbol.
VIZEL_HIGHLIGHT_COLORS	Extended highlight color palette (lighter/pastel colors)
VIZEL_PORTAL_ID	Portal container ID
VIZEL_PORTAL_Z_INDEX	Portal layer z-index values
VIZEL_SUGGESTION_Z_INDEX	Default z-index for suggestion containers.
VIZEL_TABLE_MENU_ITEMS	Combined menu items (legacy, for reference)
VIZEL_TEXT_COLORS	Extended text color palette with gradient-like arrangement
VIZEL_THEME_DATA_ATTRIBUTE	Data attribute used for theme application
VIZEL_UPLOAD_IMAGE_EVENT	The custom event name for image uploads from slash commands.
vizelBlockClipboardPluginKey	Plugin key for the block-aware clipboard plugin. The plugin holds no persistent state — the key exists so consumers can detect that the plugin is installed.
vizelBlockCommands	Block-level commands that change the current block's node type (headings, lists, quote, code block, divider, details, callout).
VizelBlockMoveKeymap	Extension for keyboard shortcuts to move blocks up/down. Alt+ArrowUp moves block up, Alt+ArrowDown moves block down. Supports moving list items within their parent list.
vizelBlockOperationCommands	Built-in block-operation commands.
VizelCallout	The Callout node extension.
VizelCommentMark	Comment mark extension for highlighting annotated text.
vizelCommentPluginKey	Plugin key for accessing comment plugin state
vizelCommonMarkFlavor	CommonMark flavor — the lowest-common-denominator spec.
vizelDefaultBlockMenuActions	Default block menu actions providing common block operations.
vizelDefaultBubbleMenuActions	Default bubble-menu actions, locale-resolved.
vizelDefaultCommands	Concatenation of the four built-in command registries.
vizelDefaultEditorProps	Default editor props for Vizel editors.
vizelDefaultEmbedProviders	Default oEmbed providers.
vizelDefaultIconIds	Default Iconify icon IDs for each icon name. Uses Lucide icons as the default set. Users can override these by providing their own icon mappings.
vizelDefaultNodeTypes	Default node types available in the node selector
vizelDefaultSlashMenuCommands	Default slash command list: the subset of vizelDefaultCommands that opts into the slash menu surface.
vizelDefaultToolbarActions	Default toolbar actions providing common formatting operations.
VizelDiagram	Diagram extension for block diagrams
vizelDocusaurusFlavor	Docusaurus / VitePress / Zenn / Qiita flavor.
VizelEmbed	Embed node extension
vizelEmbedPastePluginKey	Plugin key for embed paste handler
vizelEnLocale	Default English locale for Vizel editor.
vizelFindReplacePluginKey	Plugin key for accessing Find & Replace state
vizelFormatCommands	Mark-level format commands (bold, italic, strike, etc.).
vizelGfmFlavor	GitHub Flavored Markdown.
VizelImageResize	ResizableImage Extension
vizelInsertCommands	Insert commands that create new nodes (table, image, embed, math, diagram, table of contents).
VizelMarkdown	Pre-configured Markdown extension with default settings.
VizelMathBlock	Mathematics extension for block math expressions
VizelMathInline	Mathematics extension for inline math expressions
vizelMultiBlockSelectionPluginKey	Plugin key for the multi-block range selection extension. Use vizelMultiBlockSelectionPluginKey.getState(state) to read the current block range from a Tiptap or ProseMirror editor state.
vizelObsidianFlavor	Obsidian-style Markdown.
vizelPandocFlavor	Pandoc-flavored Markdown.
vizelPresencePluginKey	-
VizelSlashCommand	-
VizelTable	Extended Table with Markdown serialization support.
VizelTableCell	Extended TableCell with textAlign attribute support.
VizelTableHeader	Extended TableHeader with textAlign attribute support.
VizelTableWithControls	VizelTableWithControls - Table extension with interactive controls
VizelWikiLink	Wiki Link mark extension for Vizel editor.
vizelWikiLinkPluginKey	Plugin key for accessing Wiki Link plugin state

Functions

Function	Description
addVizelRecentColor	Add a color to recent colors
applyVizelColorToEditor	Apply a color to the current selection.
applyVizelLinkEdit	Apply the link-editor submission to the editor.
applyVizelTheme	Apply theme to target element
assertMarkdownRoundtrip	Assert that every sample round-trips losslessly through the given flavor.
buildVizelBlockMenuSpec	Build a VizelBlockMenuSpec for the block context menu.
buildVizelBlockMenuSpecFromCommands	Build the block-menu action list from a VizelCommand array.
buildVizelBubbleMenuSpec	Build the bubble-menu spec from a VizelCommand array.
buildVizelFindReplaceSpec	Compute the find-replace panel display state.
buildVizelFindReplaceSpecFromLocale	Convenience overload that resolves the noResults label from a full locale. Equivalent to calling buildVizelFindReplaceSpec(state, locale?.findReplace?.noResults ?? "No matches").
buildVizelLinkEditorSpec	Compute the link-editor display state from the live editor + URL input.
buildVizelMentionMenuSpec	Build a VizelMenuSpec for the mention autocomplete menu.
buildVizelNodeSelectorSpec	Build a VizelNodeSelectorSpec for the node-type selector.
buildVizelOutlineSpec	Build the outline spec from an editor's current document.
buildVizelSlashMenuSpecFromCommands	Build a VizelMenuSpec for the slash menu from a VizelCommand array.
buildVizelToolbarDropdownSpec	Build a VizelToolbarDropdownSpec for the toolbar dropdown.
buildVizelToolbarSpec	Build the toolbar spec from a VizelCommand array.
composeVizelMarkdownFlavors	Combine multiple flavors into a single derived flavor.
convertVizelCodeBlocksToDiagrams	Convert all diagram code blocks in a document to diagram nodes. This command should be called after importing markdown content. Supports mermaid, dot, and graphviz code blocks.
createLazyLoader	Creates a lazy loader for an optional dependency. Caches the loaded module to avoid repeated dynamic imports.
createVizelAutoSaveHandlers	Creates auto-save handlers for an editor
createVizelBlockClipboardExtension	Create the block-aware clipboard extension. The extension is part of the always-on core and is wired into createBaseExtensions.
createVizelBlockMenuActions	Create block menu actions with locale-specific labels.
createVizelBlockMenuTriggerController	Build a controller that subscribes to VIZEL_BLOCK_MENU_EVENT.
createVizelBubbleMenuActions	Create bubble-menu actions with locale-specific labels.
createVizelBubbleMenuEscapeController	Build a controller that collapses the editor's selection when the user presses Escape while the bubble menu is open.
createVizelCalloutExtension	Create a configured Callout extension.
createVizelCharacterCountExtension	Creates the character count extension for tracking content statistics.
createVizelCodeBlockExtension	Create the CodeBlockLowlight extension with syntax highlighting.
createVizelCollaborationHandlers	Create collaboration handlers for tracking provider state and managing lifecycle.
createVizelCommandShortcutsExtension	Create a Tiptap extension that binds the keyboard shortcuts declared by a VizelCommand array.
createVizelCommentExtension	Create the comment mark extension with configured options
createVizelCommentHandlers	Creates comment handlers for an editor.
createVizelDefaultFetchEmbedData	Create default fetchEmbedData function that works client-side
createVizelDetailsExtensions	Creates details extensions for collapsible content blocks.
createVizelDiagramExtension	Create the Diagram extension
createVizelDragHandleExtension	Creates a DragHandle extension with default styling. The drag handle appears on the left side of blocks when hovering. Clicking (not dragging) the handle opens the block menu.
createVizelDragHandleExtensions	Creates the complete drag handle extension set including: - Visual drag handle on block hover - Keyboard shortcuts for block movement (Alt+Up/Down)
createVizelEditorInstance	Create a configured Vizel editor instance.
createVizelEditorSubscription	Attach an editor event listener with a clean disposer.
createVizelEditorTransactionStore	Create a VizelEditorTransactionStore that observes whichever editor getEditor currently returns. The factory is framework-agnostic; each framework wraps the store in its native reactivity primitive.
createVizelEmbedExtension	Create embed extension with options
createVizelError	Create a VizelError instance. Convenience wrapper around new VizelError(...).
createVizelExtensions	Create the default set of extensions for Vizel editor. All features are enabled by default. Set any feature to false to disable it.
createVizelFileHandlerExtension	Create a file handler extension with unified drop/paste handling.
createVizelFindReplaceExtension	Create the Find & Replace extension
createVizelHighlightExtension	Create the highlight mark extension.
createVizelImageExtension	Create a configured Image extension for Vizel editor.
createVizelImageFileHandlers	-
createVizelImageUploader	Create an image uploader function
createVizelImageUploadExtensions	Create Image extension with upload support (drag-and-drop, paste, file picker).
createVizelImageUploadPlugin	Create an image upload plugin with decoration-based placeholders
createVizelImageUploadWithFileHandler	Create Image extension with upload support using @tiptap/extension-file-handler.
createVizelLinkExtension	Create a link extension for Vizel editor.
createVizelLocale	Create a complete locale by deep-merging partial translations with the default English locale. Supports overriding individual strings at any nesting depth.
createVizelMarkdownExtension	Create a configured Markdown extension.
createVizelMarkdownSyncHandlers	Create markdown sync handlers for framework implementations.
createVizelMathematicsExtensions	Create the Mathematics extensions
createVizelMentionExtension	Create the Vizel mention extension.
createVizelMultiBlockSelectionExtension	Create the multi-block range selection extension. The extension is part of the always-on core and carries no opt-in feature flag.
createVizelNodeTypes	Create node type options with locale-specific labels.
createVizelPopoverController	Build a controller for an anchored popover.
createVizelPortalElement	Create a portal element with proper styling.
createVizelPresenceExtension	Create the presence extension.
createVizelRelativeTimeTicker	Build a relative-time interval ticker.
createVizelSuggestionContainer	Create a positioned container for suggestion popups.
createVizelSystemThemeListener	Build a controller for system theme (prefers-color-scheme) changes.
createVizelTableExtensions	Create table extensions for Vizel editor. Returns an array of extensions: Table, TableRow, TableHeader, TableCell.
createVizelTableOfContentsExtension	Create the Vizel Table of Contents extension.
createVizelTaskListExtensions	Creates task list extensions for checkbox/todo functionality.
createVizelTextColorExtensions	Create text color mark extensions (TextStyle + Color).
createVizelToolbarActions	Create toolbar actions with locale-specific labels.
createVizelTypographyExtension	Create the typography extension.
createVizelUploadEventHandler	Creates an event handler for the vizel:upload-image custom event. This handler is used by the slash command to trigger image uploads.
createVizelVersionHistoryHandlers	Creates version history handlers for an editor.
createVizelWikiLinkExtension	Create a configured Wiki Link extension for Vizel editor.
deriveVizelCommandSpec	Derive a VizelCommandSpec for a single editor instance.
detectVizelEmbedProvider	Detect provider from URL
emitVizelError	Emit a VizelError through the consumer-supplied onError callback, falling back to console.error when no callback is set and the severity is "error". Warnings without a callback stay silent.
filterVizelBubbleMenuActions	Filter bubble-menu actions down to the ones whose requiresExtension precondition is satisfied by the supplied editor. Returns the original list when no actions declare a precondition.
filterVizelFilesByMimeType	Filter files by allowed MIME types
findVizelLanguage	Find a language by ID. Returns undefined if the code block extension has not been initialized yet.
formatRelativeTimeWithLocale	Format a relative time string using locale templates. Replaces {n} placeholder with the numeric value.
formatVizelRelativeTime	Format relative time for display.
formatVizelShortcut	Format a keyboard shortcut for the current platform.
formatVizelTooltip	Format a tooltip string with an optional keyboard shortcut.
getAllVizelLanguageIds	Get all language IDs. Returns an empty array if the code block extension has not been initialized yet.
getNextVizelSlashMenuGroupIndex	Compute the next-group jump target for Tab-key navigation.
getStoredVizelTheme	Get stored theme from storage
getVizelActiveNodeType	Get the currently active node type
getVizelBlockPath	Walk from the document root to the cursor block and return the path.
getVizelCommentPluginState	Get the current comment plugin state from the editor
getVizelCommentStorageBackend	-
getVizelEditorState	Extracts the current editor state from an editor instance. This provides a snapshot of common editor state values including focus, empty status, undo/redo availability, and character/word counts.
getVizelFindReplaceState	Get the current Find & Replace state from the editor
getVizelIconId	Get the Iconify icon ID for a given icon name.
getVizelImageUploadPluginKey	Get the image upload plugin key (for external access)
getVizelMarkdown	Get markdown content from the editor.
getVizelMultiBlockSelectionState	Read the current multi-block range from an editor state. Returns null when the selection spans zero or one top-level block.
getVizelPortalContainer	Get or create the portal container element.
getVizelRecentColors	Get recent colors from localStorage
getVizelRegisteredLanguages	Get the list of all registered languages (sorted alphabetically). Returns an empty array if the code block extension has not been initialized yet.
getVizelSlashCommandLocale	Return the locale the slash-command extension resolved at creation time.
getVizelStorageBackend	Resolve the auto-save storage backend for a document.
getVizelSystemTheme	Get the system theme preference
getVizelThemeInitScript	Initialize theme on page load (for SSR/hydration)
getVizelTurnIntoOptions	Get the "Turn into" node type options, filtering out the currently active type.
getVizelVersionStorageBackend	-
groupVizelBlockMenuActions	Group block menu actions by their group identifier.
groupVizelBubbleMenuActions	Group bubble-menu actions by their group identifier for visual separation.
groupVizelToolbarActions	Get toolbar actions grouped by their group identifier. Supports both simple actions and dropdown actions.
handleVizelImageDrop	Handle image drop from drag-and-drop
handleVizelImagePaste	Handle image paste from clipboard
handleVizelSuggestionEscape	Handle the Escape key for suggestion popups.
hasVizelPortalContainer	Check if the portal container exists.
initializeVizelMarkdownContent	Initialize editor with markdown content. This should be called in onCreate callback when using initialMarkdown.
initVizelIconRenderer	Initialize the Vizel icon renderer with the default Lucide implementation. Call this once when your framework package is loaded.
isVizelError	Type guard to check if a value is a VizelError.
isVizelMacPlatform	Detect if the current platform is macOS. Returns false during SSR (no navigator).
isVizelToolbarDropdownAction	Type guard to check if a toolbar item is a dropdown action.
isVizelValidHexColor	Validate if a string is a valid hex color.
loadVizelEmbedScripts	Re-parent any <script> tags inside an oEmbed container so the browser actually executes them (innerHTML-inserted scripts are inert).
mountToVizelPortal	Mount an element to the portal container.
mountVizelEditorView	Mount a Tiptap editor's view.dom into a container element and return a disposer that removes it.
normalizeVizelHexColor	Normalize a hex color string to standard format (#RRGGBB uppercase). Handles shorthand (#RGB) conversion and adds # prefix if missing.
parseVizelMarkdown	Parse markdown to JSON content.
registerVizelUploadEventHandler	Registers the image upload event handler. Returns a cleanup function to remove the event listener.
removeVizelPortalContainer	Remove the portal container from the document.
renderVizelIcon	Render an internal icon as an SVG string. Uses the injected renderer from framework packages.
renderVizelIconSvg	Render an Iconify icon as an SVG string using Lucide icons. This is the default implementation used by framework packages.
resolveVizelEmbedView	Resolve an VizelEmbedData into the variant-shaped view-model.
resolveVizelFeatures	Resolves feature options with a default slash menu renderer. If interaction.slashMenu is enabled but no suggestion renderer is provided, attaches the supplied default.
resolveVizelFindReplaceLabels	Resolve FindReplace locale labels with English defaults.
resolveVizelFlavorConfig	Resolve the VizelFlavorConfig carried inside a flavor's config field.
resolveVizelLinkEditorLabels	Resolve the link-editor labels from a locale (or fall back to English).
resolveVizelPluginDependencies	Resolves plugin dependencies via topological sort. Throws if a circular dependency or missing dependency is detected.
resolveVizelSaveIndicatorView	Resolve the icon, text, and timestamp visibility for a VizelSaveStatus.
resolveVizelTheme	Resolve theme to actual applied theme
setVizelIconRenderer	Set the icon renderer function. Called by framework packages (react, vue, svelte) to inject their Iconify-based implementation.
setVizelMarkdown	Set markdown content to the editor.
shallowEqualArray	Return true when two arrays carry identical references in the same order and the same length.
shallowEqualObject	Return true when two plain objects share the same own enumerable string keys and identical references for every value.
shouldFlipSubmenu	Determines whether a submenu should open to the left instead of the right.
splitVizelTextByMatches	Split text into segments based on match indices from fuzzy search.
storeVizelTheme	Store theme to storage
transformVizelDiagramCodeBlocks	Transform content to convert diagram code blocks to diagram nodes. This is useful when importing markdown content that contains diagrams. Supports mermaid, dot, and graphviz code blocks.
unmountFromVizelPortal	Unmount an element from the portal container.
validateVizelImageFile	Validate an image file
validateVizelPlugin	Validate a plugin's required fields and format.
vizelCancelAnimationFrame	Cancel a previously scheduled animation-frame callback. Becomes a no-op when the underlying API is unavailable or when the handle is the sentinel 0 returned by the SSR fallback path.
vizelCommandsFromNodeTypes	Derive a VizelCommand array from a VizelNodeTypeOption array.
vizelDefaultBase64Upload	Default base64 image uploader (converts file to data URL). Use this as the default onUpload handler when no custom uploader is provided.
vizelDefaultFeatures	Curated VizelFeatureOptions value that enables every opt-in feature Vizel ships with reasonable defaults. Use this when you want the full Notion-like surface without enumerating each toggle yourself.
vizelRequestAnimationFrame	Schedule callback for the next animation frame, or — when the environment does not implement rAF — for the next microtask. Returns a numeric handle that vizelCancelAnimationFrame accepts.
vizelThemeInitScript	Build a synchronous theme-initialization script for embedding in the document <head>.
wrapAsVizelError	Wrap an unknown error as a VizelError.

References

VizelResizableImage

Renames and re-exports VizelImageResize