BlockSuite API Documentation / @blocksuite/blocks
@blocksuite/blocks
References
insertLinkedNode
Re-exports insertLinkedNode
matchFlavours
Re-exports matchFlavours
Enumerations
- AIErrorType
- CanvasElementType
- ColorScheme
- ConnectorEndpoint
- ConnectorLabelOffsetAnchor
- ConnectorMode
- FontFamily
- FontStyle
- FontWeight
- FrameBackgroundColor
- LayoutType
- LineColor
- LineWidth
- MindmapStyle
- NoteBackgroundColor
- NoteCorners
- NoteDisplayMode
- NoteShadow
- PointStyle
- ShapeFillColor
- ShapeStyle
- ShapeTextFontSize
- ShapeType
- StrokeStyle
- TextAlign
- TextResizing
- TextVerticalAlign
Classes
- AffineAIPanelWidget
- AffineCodeLanguageListWidget
- AffineCodeToolbarWidget
- AffineDocRemoteSelectionWidget
- AffineDragHandleWidget
- AffineEdgelessZoomToolbarWidget
- AffineFormatBarWidget
- AffineImageToolbarWidget
- AffineInnerModalWidget
- AffineLink
- AffineLinkedDocWidget
- AffineModalWidget
- AffinePageDraggingAreaWidget
- AffinePieMenuWidget
- AffineReference
- AffineSlashMenuWidget
- AffineSurfaceRefToolbar
- AIItemList
- AStarRunner
- AttachmentAdapter
- AttachmentBlockComponent
- AttachmentBlockModel
- AttachmentBlockService
- AttachmentBlockTransformer
- BookmarkBlockComponent
- BookmarkBlockModel
- BookmarkBlockService
- BrushElementModel
- CanvasRenderer
- CodeBlockComponent
- ConnectionOverlay
- ConnectorElementModel
- ConnectorPathGenerator
- CopilotSelectionController
- DatabaseBlockComponent
- DatabaseBlockModel
- DatabaseBlockService
- DataViewBlockComponent
- DataViewBlockModel
- DividerBlockComponent
- DocModeService
- EdgelessBlockModel
- EdgelessCopilotToolbarEntry
- EdgelessCopilotWidget
- EdgelessElementToolbarWidget
- EdgelessFrameTitle
- EdgelessNoteBlockComponent
- EdgelessNoteMask
- EdgelessRemoteSelectionWidget
- EdgelessRootBlockComponent
- EdgelessRootService
- EdgelessSurfaceRefBlockComponent
- EdgelessTemplatePanel
- EdgelessTextBlockComponent
- EdgelessTextBlockModel
- EdgelessToolController
- EditPropsStore
- EmbedBlockComponent
- EmbedCardToolbar
- EmbedFigmaBlockComponent
- EmbedFigmaModel
- EmbedGithubBlockComponent
- EmbedGithubBlockService
- EmbedGithubModel
- EmbedHtmlBlockComponent
- EmbedHtmlModel
- EmbedLinkedDocBlockComponent
- EmbedLinkedDocModel
- EmbedLoomBlockComponent
- EmbedLoomBlockService
- EmbedLoomModel
- EmbedOptionService
- EmbedSyncedDocBlockComponent
- EmbedSyncedDocModel
- EmbedYoutubeBlockComponent
- EmbedYoutubeBlockService
- EmbedYoutubeModel
- ExportManager
- FontLoaderService
- FrameBlockComponent
- FrameBlockModel
- FramePreview
- GeneralNetworkError
- GroupElementModel
- HoverController
- HtmlAdapter
- ImageAdapter
- ImageBlockComponent
- ImageBlockModel
- ImageBlockService
- ImageBlockTransformer
- ImageEdgelessBlockComponent
- ImageSelection
- InlineManager
- LatexBlockComponent
- LatexBlockModel
- ListBlockComponent
- ListBlockService
- LocalConnectorElementModel
- MarkdownAdapter
- MenuContext
- MindmapElementModel
- MindmapSurfaceBlock
- MiniMindmapPreview
- MixTextAdapter
- NoteBlockComponent
- NoteBlockModel
- NoteBlockService
- NotionHtmlAdapter
- Overlay
- PageClipboard
- PageRootBlockComponent
- PageRootService
- ParagraphBlockComponent
- ParagraphBlockService
- PaymentRequiredError
- PeekableController
- PlainTextAdapter
- PreviewRootBlockComponent
- ReferenceNodeConfigProvider
- RichText
- RootBlockModel
- RootService
- RoughCanvas
- ShapeElementModel
- SpecBuilder
- SpecProvider
- SurfaceBlockComponent
- SurfaceBlockModel
- SurfaceBlockService
- SurfaceBlockTransformer
- SurfaceElementModel
- SurfaceGroupLikeModel
- SurfaceRefBlockComponent
- SurfaceRefBlockService
- TestUtils
- TextElementModel
- ThemeObserver
- Tooltip
- UnauthorizedError
Interfaces
- AffineAIPanelWidgetConfig
- AffineTextAttributes
- AIItemConfig
- AIItemGroupConfig
- AISubItemConfig
- AttachmentBlockEdgelessProps
- BookmarkBlockEdgelessProps
- CodeBlockConfig
- Column
- DatabaseOptionsConfig
- DocCreatedEvent
- DocModeProvider
- ElementCreationEvent
- EmbedOptionProvider
- FontConfig
- IModelCoord
- ListProps
- NotificationService
- Options
- ParseDocUrlService
- PeekViewService
- QuickSearchService
- ReferenceNodeConfig
- RootBlockConfig
- SurfaceContext
- TelemetryEvent
- TelemetryEventMap
- TelemetryService
- TemplateManager
- ToolbarMoreMenuConfig
Type Aliases
- AbstractEditor
- AdvancedMenuItem
- AffineAIPanelState
- AffineInlineEditor
- AffineInlineRootElement
- AffineSlashMenuActionItem
- AffineSlashMenuContext
- AffineSlashMenuGroupDivider
- AffineSlashMenuItem
- AffineSlashMenuItemGenerator
- AffineSlashSubMenu
- AIError
- Attachment
- AttachmentBlockProps
- BookmarkBlockProps
- BrushProps
- CanvasElementWithText
- Cell
- CodeBlockModel
- Color
- ColumnUpdater
- Connection
- ConnectorElementProps
- ConnectorLabelConstraintsProps
- ConnectorLabelOffsetProps
- ConnectorLabelProps
- DatabaseBlockProps
- DividerBlockModel
- DocMode
- DragHandleOption
- DropType
- EdgelessRootBlockWidgetName
- EdgelessTool
- EditorSetting
- ElementCreationSource
- ElementRenderer
- EmbedBlockModel
- EmbedCardStyle
- EmbedFigmaBlockProps
- EmbedFigmaBlockUrlData
- EmbedGithubBlockProps
- EmbedGithubBlockUrlData
- EmbedHtmlBlockProps
- EmbedLinkedDocBlockProps
- EmbedLoomBlockProps
- EmbedLoomBlockUrlData
- EmbedOptions
- EmbedProps
- EmbedSyncedDocBlockProps
- EmbedYoutubeBlockProps
- EmbedYoutubeBlockUrlData
- FatMenuItems
- FrameBlockProps
- GfxCompatibleProps
- Html
- Image
- ImageBlockProps
- InlineManagerExtensionConfig
- InlineMarkdownMatch
- InlineMarkdownMatchAction
- InlineSpecs
- LastProps
- LastPropsKey
- LinkPreviewData
- ListBlockModel
- ListType
- Markdown
- MenuItem
- MenuItemGroup
- MenuOptions
- MindmapNode
- MixText
- NavigatorMode
- NodeDetail
- NoteEdgelessProps
- NoteProps
- NotionHtml
- OnDragEndProps
- OnDragMoveProps
- OnDragStartProps
- PageRootBlockWidgetName
- ParagraphBlockModel
- ParagraphProps
- ParagraphType
- PeekableOptions
- PieMenuId
- PlainText
- QuickSearchResult
- ReferenceInfo
- ReferenceParams
- RefNodeSlots
- RootBlockComponent
- RootBlockProps
- SerializedCells
- SerializedConnection
- SerializedConnectorElement
- SerializedGroupElement
- SerializedMindmapElement
- ShapeName
- ShapeProps
- SurfaceRefBlockModel
- Template
- TemplateCategory
- TextElementProps
- TextStyleProps
- ViewBasicDataType
Variables
- AddCursorIcon
- AddTextIcon
- AFFINE_AI_PANEL_WIDGET
- AFFINE_EDGELESS_COPILOT_WIDGET
- AFFINE_EMBED_CARD_TOOLBAR_WIDGET
- AFFINE_FORMAT_BAR_WIDGET
- AffineCanvasTextFonts
- AffineSchemas
- AIDoneIcon
- AIStarIcon
- AIStarIconWithAnimation
- AIStopIcon
- AlignBottomIcon
- AlignDistributeHorizontallyIcon
- AlignDistributeVerticallyIcon
- AlignHorizontallyIcon
- AlignLeftIcon
- AlignRightIcon
- AlignTopIcon
- AlignVerticallyIcon
- ArrowDownBigIcon
- ArrowDownIcon
- ArrowDownSmallIcon
- ArrowIcon
- ArrowLeftBigIcon
- ArrowLeftSmallIcon
- ArrowRightBigIcon
- ArrowRightIcon
- ArrowRightSmallIcon
- ArrowUpBigIcon
- ArrowUpIcon
- AttachmentBlockSchema
- AttachmentBlockSpec
- AttachmentBlockStyles
- AttachmentDragHandleOption
- AttachmentIcon
- AttachmentIcon16
- AutoCompleteArrowIcon
- AutoConnectLeftIcon
- AutoConnectRightIcon
- BackgroundInlineSpecExtension
- BanIcon
- BlockLinkIcon
- BlocksUtils
- BoldIcon
- BoldInlineSpecExtension
- BoldItalicMarkdown
- BoldMarkdown
- BookmarkBlockSchema
- BookmarkBlockSpec
- BookmarkDragHandleOption
- BookmarkIcon
- BookmarkStyles
- BringForwardIcon
- BringToFrontIcon
- BulletedListIcon
- BulletIcons
- CancelWrapIcon
- CaptionIcon
- CenterPeekIcon
- ChangeShapeIcon
- CheckBoxIcon
- CheckIcon
- CloseIcon
- CodeBlockIcon
- CodeBlockSchema
- CodeBlockSpec
- CodeExtension
- CodeIcon
- CodeInlineSpecExtension
- ColorInlineSpecExtension
- ColorVariables
- commands
- CommonUtils
- CommunityCanvasTextFonts
- ConfirmIcon
- CONNECTOR_LABEL_MAX_WIDTH
- ConnectorCWithArrowIcon
- ConnectorEndpointLocations
- ConnectorEndpointLocationsOnTriangle
- ConnectorEndpointNoneIcon
- ConnectorIcon
- ConnectorLWithArrowIcon
- ConnectorUtils
- ConnectorXWithArrowIcon
- CopyAsPngIcon
- CopyIcon
- CrossIcon
- CurveLineIcon
- DarkLoadingIcon
- DashLineIcon
- databaseBlockColumns
- DatabaseBlockSchema
- DatabaseBlockSpec
- DatabaseKanbanViewIcon
- DatabaseKanbanViewIcon20
- DatabaseTableViewIcon
- DatabaseTableViewIcon20
- DataViewBlockSchema
- DataViewBlockSpec
- DEFAULT_BRUSH_COLOR
- DEFAULT_CENTRAL_AREA_RATIO
- DEFAULT_CONNECTOR_COLOR
- DEFAULT_CONNECTOR_TEXT_COLOR
- DEFAULT_DOC_NAME
- DEFAULT_FRONT_END_POINT_STYLE
- DEFAULT_NOTE_BACKGROUND_COLOR
- DEFAULT_NOTE_BORDER_SIZE
- DEFAULT_NOTE_BORDER_STYLE
- DEFAULT_NOTE_CORNER
- DEFAULT_NOTE_SHADOW
- DEFAULT_REAR_END_POINT_STYLE
- DEFAULT_ROUGHNESS
- DEFAULT_SHAPE_FILL_COLOR
- DEFAULT_SHAPE_STROKE_COLOR
- DEFAULT_SHAPE_TEXT_COLOR
- DEFAULT_TEXT_COLOR
- defaultAttachmentProps
- defaultEmbedSyncedDocBlockProps
- DefaultInlineManagerExtension
- DeleteIcon
- DiamondIcon
- diamondSvg
- DividerBlockSchema
- DividerBlockSpec
- DividerIcon
- DocIcon
- DocModes
- DownloadIcon
- DualLinkIcon16
- DuplicateIcon
- EDGELESS_ELEMENT_TOOLBAR_WIDGET
- EDGELESS_TEXT_BLOCK_MIN_HEIGHT
- EDGELESS_TEXT_BLOCK_MIN_WIDTH
- EdgelessEditorBlockSpecs
- EdgelessEraserDarkIcon
- EdgelessEraserLightIcon
- EdgelessGeneralShapeIcon
- EdgelessIcon
- EdgelessModeIcon
- EdgelessNoteBlockSpec
- EdgelessPenDarkIcon
- EdgelessPenLightIcon
- EdgelessRootBlockSpec
- edgelessRootWigetViewMap
- EdgelessSurfaceBlockSpec
- EdgelessSurfaceRefBlockSpec
- EdgelessTextBlockSchema
- EdgelessTextBlockSpec
- EditIcon
- EditorSettingSchema
- ElbowedLineIcon
- elementRenderers
- EllipseIcon
- ellipseSvg
- EmbedCardDarkBannerIcon
- EmbedCardDarkCubeIcon
- EmbedCardDarkHorizontalIcon
- EmbedCardDarkListIcon
- EmbedCardDarkVerticalIcon
- EmbedCardLightBannerIcon
- EmbedCardLightCubeIcon
- EmbedCardLightHorizontalIcon
- EmbedCardLightListIcon
- EmbedCardLightVerticalIcon
- EmbedEdgelessIcon
- EmbedFigmaBlockSchema
- EmbedFigmaBlockSpec
- EmbedFigmaStyles
- EmbedGithubBlockSchema
- EmbedGithubBlockSpec
- EmbedGithubStyles
- EmbedHtmlBlockSchema
- EmbedHtmlBlockSpec
- EmbedHtmlStyles
- EmbedLinkedDocBlockSchema
- EmbedLinkedDocBlockSpec
- EmbedLinkedDocStyles
- EmbedLoomBlockSchema
- EmbedLoomBlockSpec
- EmbedLoomStyles
- EmbedPageIcon
- EmbedSyncedDocBlockSchema
- EmbedSyncedDocBlockSpec
- EmbedSyncedDocStyles
- EmbedWebIcon
- EmbedYoutubeBlockSchema
- EmbedYoutubeBlockSpec
- EmbedYoutubeStyles
- EnterIcon
- ExpandCloseIcon
- ExpandFullIcon
- ExpandFullSmallIcon
- ExpandIcon
- ExpandWideIcon
- ExportManagerExtension
- ExportToHTMLIcon
- ExportToMarkdownIcon
- figmaUrlRegex
- FileIcon
- FillColorsSchema
- FlipDirectionIcon
- FontDocIcon
- FontFamilyIcon
- FontFamilyList
- FontFamilyMap
- FontFamilyVariables
- FontLinkedDocIcon
- FontWeightMap
- FORMAT_BLOCK_SUPPORT_FLAVOURS
- FORMAT_NATIVE_SUPPORT_FLAVOURS
- FORMAT_TEXT_SUPPORT_FLAVOURS
- FRAME_BACKGROUND_COLORS
- FrameBackgroundColorsSchema
- FrameBlockSchema
- FrameBlockSpec
- FrameIcon
- FrameNavigatorIcon
- FrameNavigatorNextIcon
- FrameNavigatorPrevIcon
- FrameOrderAdjustmentIcon
- frameTitleStyleVars
- FrontEndpointArrowIcon
- FrontEndpointCircleIcon
- FrontEndpointDiamondIcon
- FrontEndpointTriangleIcon
- GeneralStyleIcon
- GRID_GAP_MAX
- GRID_GAP_MIN
- GROUP_TITLE_FONT
- GROUP_TITLE_FONT_SIZE
- GROUP_TITLE_OFFSET
- GROUP_TITLE_PADDING
- GroupIcon
- HandIcon
- Heading1Icon
- Heading2Icon
- Heading3Icon
- Heading4Icon
- Heading5Icon
- Heading6Icon
- HeadingIcon
- HelpIcon
- HiddenIcon
- HighLightDuotoneIcon
- HtmlTransformer
- ImageBlockSchema
- ImageBlockSpec
- ImageDragHandleOption
- ImageIcon
- ImageIcon20
- ImageUploadIcon
- ImportIcon
- InlineSpecExtensions
- InsertBelowIcon
- ItalicExtension
- ItalicIcon
- ItalicInlineSpecExtension
- LargeFrameIcon
- LassoFreeHandIcon
- LassoPolygonalIcon
- LatexBlockSchema
- LatexBlockSpec
- LatexEditorUnitSpecExtension
- LatexExtension
- LatexInlineSpecExtension
- LightLoadingIcon
- LINE_COLORS
- LineColorMap
- LineColorsSchema
- LineStyleIcon
- LinkedDocIcon
- LinkedEdgelessIcon
- LinkedWidgetUtils
- LinkExtension
- LinkIcon
- LinkInlineSpecExtension
- ListBlockSchema
- ListBlockSpec
- ListDragHandleOption
- loomUrlRegex
- MarkdownExtensions
- MarkdownTransformer
- MindmapBalanceLayoutIcon
- MindMapChildIcon
- MindmapLeftLayoutIcon
- MindmapRightLayoutIcon
- MindMapSiblingIcon
- MindmapStyleFour
- MindmapStyleIcon
- MindmapStyleOne
- MindmapStyleThree
- MindmapStyleTwo
- MindmapUtils
- MinusIcon
- MoreCopyIcon
- MoreDeleteIcon
- MoreDuplicateIcon
- MoreHorizontalIcon
- MoreIcon
- MoreIndicatorIcon
- MoreVerticalIcon
- MoveLeftIcon
- MoveRightIcon
- NavigatorExitFullScreenIcon
- NavigatorFullScreenIcon
- NavigatorSettingsIcon
- NewDocIcon
- NewIcon
- noContentPlaceholder
- NOTE_BACKGROUND_COLORS
- NOTE_CORNERS
- NOTE_SHADOWS
- NOTE_WIDTH
- NoteAutoCompleteIcon
- NoteBackgroundColorMap
- NoteBackgroundColorsSchema
- NoteBlockSchema
- NoteBlockSpec
- NoteCornerIcon
- NoteCornersMap
- NoteCornersSchema
- NoteDragHandleOption
- NoteIcon
- NoteNoShadowIcon
- NoteShadowIcon
- NoteShadowMap
- NoteShadowSampleIcon
- NoteShadowsSchema
- NoteSmallIcon
- NotionIcon
- NowIcon
- NumberedListIcon
- OpenIcon
- PageEditorBlockSpecs
- PageIcon
- PageRootBlockSpec
- pageRootWidgetViewMap
- PageSurfaceBlockSpec
- PageSurfaceRefBlockSpec
- PaletteIcon
- ParagraphBlockSchema
- ParagraphBlockSpec
- PasteIcon
- PenIcon
- PlusIcon
- PointStyleMap
- PreviewEdgelessEditorBlockSpecs
- PreviewEdgelessRootBlockSpec
- PreviewEditorBlockSpecs
- QuoteIcon
- RearEndpointArrowIcon
- RearEndpointCircleIcon
- RearEndpointDiamondIcon
- RearEndpointTriangleIcon
- REFERENCE_NODE
- ReferenceInfoSchema
- ReferenceInlineSpecExtension
- ReferenceParamsSchema
- RefreshIcon
- ReleaseFromGroupButtonIcon
- ReloadIcon
- RemoteCursor
- RenameIcon
- ReplaceIcon
- ResetIcon
- RichTextExtensions
- RootBlockSchema
- RoundedRectangleIcon
- roundedSvg
- ScissorsIcon
- ScribbledDiamondIcon
- ScribbledEllipseIcon
- ScribbledRoundedRectangleIcon
- ScribbledSquareIcon
- ScribbledStyleIcon
- ScribbledTriangleIcon
- SearchIcon
- SelectIcon
- SendBackwardIcon
- SendToBackIcon
- SettingsIcon
- SHAPE_FILL_COLORS
- SHAPE_STROKE_COLORS
- SHAPE_TEXT_PADDING
- SHAPE_TEXT_VERTICAL_PADDING
- shapeMethods
- ShrinkIcon
- SizeVariables
- SmallArrowDownIcon
- SmallDocIcon
- SmallNoteIcon
- SmallScissorsIcon
- SplitViewIcon
- SquareIcon
- StopAIIcon
- StraightLineIcon
- StrikeInlineSpecExtension
- StrikethroughExtension
- StrikethroughIcon
- StrokeColorsSchema
- StrokeStyleMap
- StyleVariables
- SurfaceBlockSchema
- SurfaceRefBlockSchema
- TagsIcon
- TextAlignCenterIcon
- TextAlignLeftIcon
- TextAlignMap
- TextAlignRightIcon
- TextBackgroundDuotoneIcon
- textCommands
- TextForegroundDuotoneIcon
- textFormatConfigs
- TextIcon
- TextUtils
- TodayIcon
- toggleDown
- toggleRight
- TomorrowIcon
- ToolsIcon
- TransparentIcon
- TriangleIcon
- triangleSvg
- UnderlineIcon
- UnderlineInlineSpecExtension
- UnderthroughExtension
- UngroupButtonIcon
- UnlinkIcon
- ViewBarIcon
- ViewIcon
- WarningIcon
- WebIcon16
- WrapIcon
- YesterdayIcon
- youtubeUrlRegex
- ZipTransformer
- ZOOM_MAX
- ZOOM_MIN
- ZOOM_STEP
Functions
- asyncGetRichText
- asyncSetInlineRange
- calculateNearestLocation
- checkboxChecked
- checkboxUnchecked
- clearMarksOnDiscontinuousInput
- copyMiddleware
- createButtonPopper
- createDefaultDoc
- createEmbedBlockSchema
- createEnumMap
- createLitPortal
- createSimplePortal
- createText
- customImageProxyMiddleware
- defaultImageProxyMiddleware
- defineEmbedModel
- DocModeExtension
- DocModeProvider
- DragHandleConfigExtension
- DragHandleConfigIdentifier
- EditorSettingExtension
- EditorSettingProvider
- effects
- EmbedOptionProvider
- embedSyncedDocMiddleware
- fetchable
- fetchImage
- findNoteBlockModel
- fitContent
- focusTextModel
- FontConfigExtension
- FontConfigIdentifier
- getAttachmentFileIcons
- getConnectorModeName
- getInlineEditorByModel
- getMoreMenuConfig
- getRichTextByModel
- getSelectedPeekableBlocksCommand
- getShapeName
- getShapeRadius
- getShapeType
- getSurfaceBlock
- GfxCompatible
- groupsToActions
- icon
- InlineManagerExtension
- InlineManagerIdentifier
- InlineMarkdownExtension
- InlineSpecExtension
- InlineSpecIdentifier
- insertContent
- isFormatSupported
- isInsideEdgelessEditor
- isInsidePageEditor
- isPeekable
- markdownInput
- MarkdownMatcherIdentifier
- markdownToMindmap
- nanoidReplacement
- normalizeShapeBound
- NotificationExtension
- NotificationProvider
- on
- once
- onModelElementUpdated
- onModelTextUpdated
- openFileOrFiles
- ParseDocUrlExtension
- ParseDocUrlProvider
- pasteMiddleware
- peek
- Peekable
- peekSelectedBlockCommand
- PeekViewExtension
- PeekViewProvider
- playCheckAnimation
- printToPdf
- QuickSearchExtension
- QuickSearchProvider
- ReferenceNodeConfigExtension
- ReferenceNodeConfigIdentifier
- RefNodeSlotsExtension
- RefNodeSlotsProvider
- renderActions
- renderGroups
- renderToolbarSeparator
- replaceIdMiddleware
- scrollbarStyle
- selectTextModel
- setImageProxyMiddlewareURL
- showImportModal
- sortIndex
- TelemetryProvider
- textKeymap
- titleMiddleware
- toast
- toggleLinkPopup
- toolbarDefaultConfig
- whenHover