BlockSuite API Documentation / @blocksuite/blocks
@blocksuite/blocks
References
matchFlavours
Re-exports matchFlavours
Enumerations
- AIErrorType
- CanvasElementType
- ColorScheme
- ConnectorEndpoint
- ConnectorLabelOffsetAnchor
- ConnectorMode
- FontFamily
- FontStyle
- FontWeight
- LayoutType
- LineColor
- LineWidth
- MindmapStyle
- NoteBackgroundColor
- NoteCorners
- NoteDisplayMode
- NoteShadow
- PointStyle
- ShapeFillColor
- ShapeStyle
- ShapeTextFontSize
- ShapeType
- SortOrder
- StrokeStyle
- TextAlign
- TextResizing
- TextVerticalAlign
Classes
- AIItemList
- AStarRunner
- AffineAIPanelWidget
- AffineCodeLanguageListWidget
- AffineCodeToolbarWidget
- AffineDocRemoteSelectionWidget
- AffineDragHandleWidget
- AffineEdgelessZoomToolbarWidget
- AffineFormatBarWidget
- AffineImageToolbarWidget
- AffineInnerModalWidget
- AffineLinkedDocWidget
- AffineModalWidget
- AffinePageDraggingAreaWidget
- AffinePieMenuWidget
- AffineReference
- AffineSlashMenuWidget
- AffineSurfaceRefToolbar
- AttachmentAdapter
- AttachmentBlockComponent
- AttachmentBlockModel
- AttachmentBlockService
- AttachmentBlockTransformer
- BookmarkBlockComponent
- BookmarkBlockModel
- BookmarkBlockService
- BrushElementModel
- CanvasRenderer
- CodeBlockComponent
- ConnectionOverlay
- ConnectorElementModel
- ConnectorPathGenerator
- CopilotSelectionController
- DataViewBlockComponent
- DataViewBlockModel
- DatabaseBlockComponent
- DatabaseBlockModel
- DatabaseBlockService
- DividerBlockComponent
- DocModeService
- EdgelessBlockModel
- EdgelessCopilotToolbarEntry
- EdgelessCopilotWidget
- EdgelessElementToolbarWidget
- EdgelessFrameTitle
- EdgelessNoteBlockComponent
- EdgelessNoteMask
- EdgelessRemoteSelectionWidget
- EdgelessRootBlockComponent
- EdgelessRootService
- EdgelessSurfaceRefBlockComponent
- EdgelessTemplatePanel
- EdgelessTextBlockComponent
- EdgelessTextBlockModel
- EdgelessTextBlockService
- EdgelessToolController
- EmbedBlockComponent
- EmbedCardToolbar
- EmbedFigmaBlockComponent
- EmbedFigmaModel
- EmbedGithubBlockComponent
- EmbedGithubBlockService
- EmbedGithubModel
- EmbedHtmlBlockComponent
- EmbedHtmlBlockService
- EmbedHtmlModel
- EmbedLinkedDocBlockComponent
- EmbedLinkedDocModel
- EmbedLoomBlockComponent
- EmbedLoomBlockService
- EmbedLoomModel
- EmbedOptionService
- EmbedSyncedDocBlockComponent
- EmbedSyncedDocBlockService
- EmbedSyncedDocModel
- EmbedYoutubeBlockComponent
- EmbedYoutubeBlockService
- EmbedYoutubeModel
- FontLoaderService
- FrameBlockComponent
- FrameBlockModel
- FramePreview
- GeneralNetworkError
- GroupElementModel
- HoverController
- HtmlAdapter
- ImageAdapter
- ImageBlockComponent
- ImageBlockModel
- ImageBlockService
- ImageBlockTransformer
- ImageEdgelessBlockComponent
- ImageSelection
- InlineManager
- LatexBlockModel
- LayerManager
- ListBlockComponent
- ListBlockService
- LocalConnectorElementModel
- MarkdownAdapter
- MenuContext
- MindmapElementModel
- MiniMindmapPreview
- MixTextAdapter
- NoteBlockComponent
- NoteBlockModel
- NoteBlockService
- NotionHtmlAdapter
- Overlay
- PageClipboard
- PageRootBlockComponent
- PageRootService
- ParagraphBlockComponent
- ParagraphBlockService
- PaymentRequiredError
- PeekableController
- PlainTextAdapter
- PreviewRootBlockComponent
- ReferenceNodeConfig
- RichText
- RootBlockModel
- RootService
- RoughCanvas
- ShapeElementModel
- SpecBuilder
- SpecProvider
- SurfaceBlockComponent
- SurfaceBlockModel
- SurfaceBlockService
- SurfaceBlockTransformer
- SurfaceElementModel
- SurfaceGroupLikeModel
- SurfaceRefBlockComponent
- SurfaceRefBlockService
- TestUtils
- TextElementModel
- ThemeObserver
- Tooltip
- UnauthorizedError
Interfaces
- AIItemConfig
- AIItemGroupConfig
- AISubItemConfig
- AffineAIPanelWidgetConfig
- AffineTextAttributes
- AttachmentBlockEdgelessProps
- BookmarkBlockEdgelessProps
- CodeBlockConfig
- Column
- DatabaseOptionsConfig
- DocCreatedEvent
- DocModeProvider
- ElementCreationEvent
- EmbedOptionProvider
- FontConfig
- IModelCoord
- IShape
- ListProps
- NotificationService
- Options
- PeekViewService
- QuickSearchService
- RootBlockConfig
- SurfaceContext
- TelemetryEvent
- TelemetryEventMap
- TelemetryService
- TemplateManager
- ToolbarMoreMenuConfig
Type Aliases
- AIError
- AbstractEditor
- AdvancedMenuItem
- AffineAIPanelState
- AffineInlineEditor
- AffineSlashMenuActionItem
- AffineSlashMenuContext
- AffineSlashMenuGroupDivider
- AffineSlashMenuItem
- AffineSlashMenuItemGenerator
- AffineSlashSubMenu
- Attachment
- AttachmentBlockProps
- BlockLayer
- BookmarkBlockProps
- BrushProps
- CanvasElementWithText
- Cell
- CodeBlockModel
- Color
- ColumnUpdater
- Connection
- ConnectorElementProps
- ConnectorLabelConstraintsProps
- ConnectorLabelOffsetProps
- ConnectorLabelProps
- DatabaseBlockProps
- DividerBlockModel
- DocMode
- 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
- InlineMarkdownMatch
- InlineSpecs
- LinkPreviewData
- ListBlockModel
- ListType
- Markdown
- MenuItem
- MenuItemGroup
- MenuOptions
- MindmapNode
- MixText
- NavigatorMode
- NodeDetail
- NotionHtml
- PageRootBlockWidgetName
- ParagraphBlockModel
- ParagraphType
- PieMenuId
- PlainText
- QuickSearchResult
- ReferenceInfo
- ReorderingDirection
- RootBlockComponent
- SerializedCells
- SerializedConnection
- SerializedConnectorElement
- SerializedGroupElement
- SerializedMindmapElement
- ShapeName
- ShapeProps
- SurfaceRefBlockModel
- Template
- TemplateCategory
- TextElementProps
- TextStyleProps
- ViewBasicDataType
Variables
- AFFINE_AI_PANEL_WIDGET
- AFFINE_EDGELESS_COPILOT_WIDGET
- AFFINE_EMBED_CARD_TOOLBAR_WIDGET
- AFFINE_FORMAT_BAR_WIDGET
- AIDoneIcon
- AIStarIcon
- AIStarIconWithAnimation
- AIStopIcon
- AddCursorIcon
- AddTextIcon
- AffineCanvasTextFonts
- AffineSchemas
- AlignBottomIcon
- AlignDistributeHorizontallyIcon
- AlignDistributeVerticallyIcon
- AlignHorizontallyIcon
- AlignLeftIcon
- AlignRightIcon
- AlignTopIcon
- AlignVerticallyIcon
- ArrowDownBigIcon
- ArrowDownIcon
- ArrowDownSmallIcon
- ArrowIcon
- ArrowLeftBigIcon
- ArrowLeftSmallIcon
- ArrowRightBigIcon
- ArrowRightIcon
- ArrowRightSmallIcon
- ArrowUpBigIcon
- ArrowUpIcon
- AttachmentBlockSchema
- AttachmentBlockSpec
- AttachmentBlockStyles
- AttachmentIcon
- AttachmentIcon16
- AutoCompleteArrowIcon
- AutoConnectLeftIcon
- AutoConnectRightIcon
- BanIcon
- BlockLinkIcon
- BlocksUtils
- BoldIcon
- BookmarkBlockSchema
- BookmarkBlockSpec
- BookmarkIcon
- BookmarkStyles
- BringForwardIcon
- BringToFrontIcon
- BulletIcons
- BulletedListIcon
- CONNECTOR_LABEL_MAX_WIDTH
- CancelWrapIcon
- CaptionIcon
- CenterPeekIcon
- ChangeShapeIcon
- CheckBoxIcon
- CheckIcon
- CloseIcon
- CodeBlockIcon
- CodeBlockSchema
- CodeBlockSpec
- CodeIcon
- ColorVariables
- CommonUtils
- CommunityCanvasTextFonts
- ConfirmIcon
- ConnectorCWithArrowIcon
- ConnectorEndpointLocations
- ConnectorEndpointLocationsOnTriangle
- ConnectorEndpointNoneIcon
- ConnectorIcon
- ConnectorLWithArrowIcon
- ConnectorUtils
- ConnectorXWithArrowIcon
- CopyAsPngIcon
- CopyIcon
- CrossIcon
- CurveLineIcon
- DEFAULT_BRUSH_COLOR
- DEFAULT_CENTRAL_AREA_RATIO
- DEFAULT_CONNECTOR_COLOR
- 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
- DarkLoadingIcon
- DashLineIcon
- DataViewBlockSchema
- DataViewBlockSpec
- DatabaseBlockSchema
- DatabaseBlockSpec
- DatabaseKanbanViewIcon
- DatabaseKanbanViewIcon20
- DatabaseTableViewIcon
- DatabaseTableViewIcon20
- DeleteIcon
- DiamondIcon
- 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
- EdgelessSurfaceBlockSpec
- EdgelessSurfaceRefBlockSpec
- EdgelessTextBlockSchema
- EdgelessTextBlockSpec
- EditIcon
- EditorSettingSchema
- ElbowedLineIcon
- EllipseIcon
- 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
- ExportToHTMLIcon
- ExportToMarkdownIcon
- FileIcon
- FillColorsSchema
- FlipDirectionIcon
- FontDocIcon
- FontFamilyIcon
- FontFamilyList
- FontFamilyMap
- FontFamilyVariables
- FontLinkedDocIcon
- FontWeightMap
- FrameBlockSchema
- FrameBlockSpec
- FrameIcon
- FrameNavigatorIcon
- FrameNavigatorNextIcon
- FrameNavigatorPrevIcon
- FrameOrderAdjustmentIcon
- FrontEndpointArrowIcon
- FrontEndpointCircleIcon
- FrontEndpointDiamondIcon
- FrontEndpointTriangleIcon
- GRID_GAP_MAX
- GRID_GAP_MIN
- GROUP_TITLE_FONT
- GROUP_TITLE_FONT_SIZE
- GROUP_TITLE_OFFSET
- GROUP_TITLE_PADDING
- GeneralStyleIcon
- GroupIcon
- HandIcon
- Heading1Icon
- Heading2Icon
- Heading3Icon
- Heading4Icon
- Heading5Icon
- Heading6Icon
- HeadingIcon
- HelpIcon
- HiddenIcon
- HighLightDuotoneIcon
- HtmlTransformer
- ImageBlockSchema
- ImageBlockSpec
- ImageIcon
- ImageIcon20
- ImageUploadIcon
- ImportIcon
- InsertBelowIcon
- ItalicIcon
- LINE_COLORS
- LargeFrameIcon
- LassoFreeHandIcon
- LassoPolygonalIcon
- LatexBlockSchema
- LightLoadingIcon
- LineColorMap
- LineColorsSchema
- LineStyleIcon
- LinkIcon
- LinkedDocIcon
- LinkedEdgelessIcon
- LinkedWidgetUtils
- ListBlockSchema
- ListBlockSpec
- MarkdownTransformer
- MindMapChildIcon
- MindMapSiblingIcon
- MindmapBalanceLayoutIcon
- MindmapLeftLayoutIcon
- MindmapRightLayoutIcon
- MindmapStyleFour
- MindmapStyleIcon
- MindmapStyleOne
- MindmapStyleThree
- MindmapStyleTwo
- MindmapUtils
- MinusIcon
- MoreCopyIcon
- MoreDeleteIcon
- MoreDuplicateIcon
- MoreHorizontalIcon
- MoreIcon
- MoreIndicatorIcon
- MoreVerticalIcon
- MoveLeftIcon
- MoveRightIcon
- NOTE_BACKGROUND_COLORS
- NOTE_CORNERS
- NOTE_SHADOWS
- NOTE_WIDTH
- NavigatorExitFullScreenIcon
- NavigatorFullScreenIcon
- NavigatorSettingsIcon
- NewDocIcon
- NewIcon
- NoteAutoCompleteIcon
- NoteBackgroundColorMap
- NoteBackgroundColorsSchema
- NoteBlockSchema
- NoteBlockSpec
- NoteCornerIcon
- NoteCornersMap
- NoteCornersSchema
- NoteIcon
- NoteNoShadowIcon
- NoteShadowIcon
- NoteShadowMap
- NoteShadowSampleIcon
- NoteShadowsSchema
- NoteSmallIcon
- NotionIcon
- NowIcon
- NumberedListIcon
- OpenIcon
- PageEditorBlockSpecs
- PageIcon
- PageRootBlockSpec
- PageSurfaceBlockSpec
- PageSurfaceRefBlockSpec
- PaletteIcon
- ParagraphBlockSchema
- ParagraphBlockSpec
- PasteIcon
- PenIcon
- PlusIcon
- PointStyleMap
- PreviewEdgelessEditorBlockSpecs
- PreviewEdgelessRootBlockSpec
- PreviewEditorBlockSpecs
- QuoteIcon
- RearEndpointArrowIcon
- RearEndpointCircleIcon
- RearEndpointDiamondIcon
- RearEndpointTriangleIcon
- ReferenceInfoSchema
- RefreshIcon
- ReleaseFromGroupButtonIcon
- ReloadIcon
- RemoteCursor
- RenameIcon
- ReplaceIcon
- ResetIcon
- RootBlockSchema
- RoundedRectangleIcon
- SHAPE_FILL_COLORS
- SHAPE_STROKE_COLORS
- SHAPE_TEXT_PADDING
- SHAPE_TEXT_VERTICAL_PADDING
- ScissorsIcon
- ScribbledDiamondIcon
- ScribbledEllipseIcon
- ScribbledRoundedRectangleIcon
- ScribbledSquareIcon
- ScribbledStyleIcon
- ScribbledTriangleIcon
- SearchIcon
- SelectIcon
- SendBackwardIcon
- SendToBackIcon
- SettingsIcon
- ShrinkIcon
- SizeVariables
- SmallArrowDownIcon
- SmallDocIcon
- SmallNoteIcon
- SmallScissorsIcon
- SplitViewIcon
- SquareIcon
- StopAIIcon
- StraightLineIcon
- StrikethroughIcon
- StrokeColorsSchema
- StrokeStyleMap
- StyleVariables
- SurfaceBlockSchema
- SurfaceRefBlockSchema
- TagsIcon
- TextAlignCenterIcon
- TextAlignLeftIcon
- TextAlignMap
- TextAlignRightIcon
- TextBackgroundDuotoneIcon
- TextForegroundDuotoneIcon
- TextIcon
- TextUtils
- TodayIcon
- TomorrowIcon
- ToolsIcon
- TransparentIcon
- TriangleIcon
- UnderlineIcon
- UngroupButtonIcon
- UnlinkIcon
- ViewBarIcon
- ViewIcon
- WarningIcon
- WebIcon16
- WrapIcon
- YesterdayIcon
- ZOOM_MAX
- ZOOM_MIN
- ZOOM_STEP
- ZipTransformer
- commands
- databaseBlockColumns
- defaultAttachmentProps
- defaultEmbedSyncedDocBlockProps
- diamondSvg
- edgelessRootWigetViewMap
- elementRenderers
- ellipseSvg
- figmaUrlRegex
- frameTitleStyleVars
- loomUrlRegex
- pageRootWidgetViewMap
- roundedSvg
- shapeMethods
- toggleDown
- toggleRight
- triangleSvg
- youtubeUrlRegex
Functions
- DocModeProvider
- EmbedOptionProvider
- FontConfigExtension
- FontConfigIdentifier
- GfxCompatible
- Peekable
- QuickSearchProvider
- TelemetryProvider
- calculateNearestLocation
- checkboxChecked
- checkboxUnchecked
- compareLayer
- copyMiddleware
- createButtonPopper
- createDefaultDoc
- createEmbedBlockSchema
- createEnumMap
- createLitPortal
- createSimplePortal
- createText
- customImageProxyMiddleware
- defaultImageProxyMiddleware
- defineEmbedModel
- embedSyncedDocMiddleware
- fetchImage
- fetchable
- findNoteBlockModel
- fitContent
- getAffineInlineSpecsWithReference
- getAttachmentFileIcons
- getConnectorModeName
- getMoreMenuConfig
- getShapeName
- getShapeRadius
- getShapeType
- groupsToActions
- icon
- insertContent
- isInsideEdgelessEditor
- isInsidePageEditor
- isPeekable
- markdownToMindmap
- nanoidReplacement
- normalizeShapeBound
- on
- onModelElementUpdated
- onModelTextUpdated
- once
- openFileOrFiles
- pasteMiddleware
- peek
- playCheckAnimation
- printToPdf
- renderActions
- renderGroups
- renderToolbarSeparator
- renderableInEdgeless
- replaceIdMiddleware
- scrollbarStyle
- setImageProxyMiddlewareURL
- showImportModal
- sortIndex
- titleMiddleware
- toast
- toolbarDefaultConfig
- whenHover