Overview

16 Dec 20257 minutes to read

Name Description
BlockEditor Represents the root class for the Block Editor component.
The BlockEditor is a block based editor that provides functionality for creating, editing, and managing blocks of content.
Blocks can include paragraph, lists, toggles, and other block types, organized hierarchically.
CodeBlockSettings Configures settings related to code block in the editor.
ImageBlockSettings Configures settings related to image block in the editor.
LabelItem Represents LabelItem in the block editor component.
LabelSettings Configures settings related to Label popup in the editor.
This property utilizes the LabelSettingsModel to specify various options and behaviors for paste operations.
PasteCleanupSettings Configures settings related to pasting content in the editor.
This property utilizes the PasteCleanupSettingsModel to specify various options and behaviors for paste operations.
User Represents a user model for a block in the block editor component.
BlockActionItem Represents BlockActionItem in the block editor component.
BlockActionMenuSettings Represents BlockActionMenuSettings in the block editor component.
CommandItem Represents a command item model used in the command menu of the block editor component.
Each command item defines an action that can be performed in the editor, such as inserting a block type.

CommandMenuSettings Represents the settings for the command menu in the block editor component
ContextMenuItem Represents a context menu item model in the block editor component.
ContextMenuSettings Represents ContextMenuSettings in the block editor component.
InlineToolbarSettings Inline toolbar settings that will be opened when selecting a range of texts.
BlockType Enum representing the different block types available in the block editor component.
Each block type corresponds to a specific content format that can be used to create structured documents.
CommandName Enum representing the built in items for inline toolbar.
ContentType Defines the type of content a block can hold.
This enum represents various content formats supported in the editor.
BaseChildrenProp Properties for blocks that support nested child blocks.
BasePlaceholderProp Properties for blocks that support placeholder text.
IChecklistBlockSettings Properties for checklist blocks.
ICodeBlockSettings Properties for code blocks.
ICollapsibleBlockSettings Properties for collapsible blocks, such as collapsible paragraphs or headings.
IHeadingBlockSettings Properties for heading blocks.
IImageBlockSettings Properties for image blocks.
ILabelContentSettings Properties for label content
ILinkContentSettings Properties for link content
IMentionContentSettings Properties for mention content
AfterPasteCleanupEventArgs Represents the event arguments for paste event.
BeforePasteCleanupEventArgs Represents the event arguments for paste event.
BlockActionItemSelectEventArgs Represents the event arguments for a block action item click event.
BlockActionMenuClosingEventArgs Represents the event arguments for closing the block action menu.
BlockActionMenuOpeningEventArgs Represents the event arguments for opening the block action menu.
BlurEventArgs This event is triggered when the block editor loses focus.
CommandFilteringEventArgs This event is triggered when a query is typed in the command menu and filtering of commands occurs.
CommandItemSelectEventArgs This event is triggered when a command item is clicked in the command menu.
ContextMenuItemSelectEventArgs Provides information about the event when a context menu item is being clicked.
ContextMenuOpeningEventArgs Provides information about the event before the context menu opens.
FocusEventArgs This event is triggered when a block or the block editor gains focus.
SelectionChangedEventArgs Represents the event arguments for a selection change event.
ToolbarItemClickEventArgs This event is triggered when a toolbar item is clicked.
BlockProperties Union type of all possible block properties.
ContentProperties Union type of all possible content properties.
BlockAction Defines actions being performed within the blocks.
SaveFormat Specifies the formats available for saving images.
Options include saving as Base64 or Blob.
TableColumnType Defines supported column types for table blocks.
ToolbarCommandName Specifies the commands available for the inline toolbar items.