New to KendoReact? Start a free 30-day trial

EditorTools

Class

Represents a wrapping namespace for the tool components, props, and functions of the Editor.

Definition

Package:@progress/kendo-react-editor

Methods

BulletedList

The BulletedList tool component. Will render a SplitButton which applies <ol> HTML element with predefined styles - disc and square.

Parameters:propsanyReturns:

Element

createAddColumnAfterTool

Creates the AddColumnAfter tool component of the Editor.

Parameters:settingsToolSettingsReturns:

React.ComponentClass<ToolProps, React.ComponentState>

The AddColumnAfter tool component of the Editor.

createAddColumnBeforeTool

Creates the AddColumnBefore tool component of the Editor.

Parameters:settingsToolSettingsReturns:

React.ComponentClass<ToolProps, React.ComponentState>

The AddColumnBefore tool component of the Editor.

createAddRowAfterTool

Creates the AddRowAfter tool component of the Editor.

Parameters:settingsToolSettingsReturns:

React.ComponentClass<ToolProps, React.ComponentState>

The AddRowAfter tool component of the Editor.

createAddRowBeforeTool

Creates the AddRowBefore tool component of the Editor.

Parameters:settingsToolSettingsReturns:

React.ComponentClass<ToolProps, React.ComponentState>

The AddRowBefore tool component of the Editor.

createAlignTool

Creates the Align tool component of the Editor.

Parameters:settingsAlignSettingsReturns:

React.ComponentClass<AlignToolProps, React.ComponentState>

Editor's Align tool component.

createDeleteColumnTool

Creates the DeleteColumn tool component of the Editor.

Parameters:settingsToolSettingsReturns:

React.ComponentClass<ToolProps, React.ComponentState>

The DeleteColumn tool component of the Editor.

createDeleteRowTool

Creates the DeleteRow tool component of the Editor.

Parameters:settingsToolSettingsReturns:

React.ComponentClass<ToolProps, React.ComponentState>

The DeleteRow tool component of the Editor.

createDeleteTableTool

Creates the DeleteTable tool component of the Editor.

Parameters:settingsToolSettingsReturns:

React.ComponentClass<ToolProps, React.ComponentState>

The DeleteTable tool component of the Editor.

createFormatBlockDropDownList

Creates the FormatBlock tool component of the Editor.

Parameters:settingsFormatBlockDropDownListSettingsReturns:

React.ComponentClass<FormatBlockProps, React.ComponentState>

The FormatBlock tool component of the Editor.

createIndentTool

Creates the Indent tool component of the Editor.

Parameters:settingsIndentationSettingsReturns:

React.ComponentClass<IndentProps, React.ComponentState>

The Indent tool component of the Editor.

createInlineFormatTool

Creates the InlineFormat tool component of the Editor.

Parameters:settingsInlineFormatSettingsReturns:

React.ComponentClass<InlineFormatToolProps, React.ComponentState>

Editor's InlineFormat tool component.

createInsertImageTool

Creates the InsertImage tool component of the Editor.

Parameters:settingsImageSettingsReturns:

React.ComponentClass<InsertImageProps>

The InsertImage tool component of the Editor.

createInsertTableTool

Creates the InsertTable tool component of the Editor.

Parameters:settingsInsertTableSettingsReturns:

React.ComponentClass<InsertTableProps>

The InsertTable tool component of the Editor.

createLinkTool

Creates the Link tool component of the Editor.

Parameters:settingsLinkSettingsReturns:

React.ComponentClass<LinkProps>

The Link tool component of the Editor.

createListTool

Creates the List tool component of the Editor.

Parameters:settingsListSettingsReturns:

React.ComponentClass<ListToolProps, React.ComponentState>

The List tool component of the Editor.

createMergeCellsTool

Creates the MergeCells tool component of the Editor.

Parameters:settingsToolSettingsReturns:

React.ComponentClass<ToolProps, React.ComponentState>

The MergeCells tool component of the Editor.

createOutdentTool

Creates the Outdent tool component of the Editor.

Parameters:settingsIndentationSettingsReturns:

React.ComponentClass<OutdentProps, React.ComponentState>

The Outdent tool component of the Editor.

createRedoTool

Creates the Redo tool component of the Editor.

Parameters:settingsToolSettingsReturns:

React.ComponentClass<ToolProps, React.ComponentState>

The Redo tool component of the Editor.

createSplitCellTool

Creates the SplitCell tool component of the Editor.

Parameters:settingsToolSettingsReturns:

React.ComponentClass<ToolProps, React.ComponentState>

The SplitCell tool component of the Editor.

createStyleDropDownList

Creates the DropDownList tool component of the Editor which applies inline styles to inline HTML elements.

Parameters:settingsStyleDropDownListSettingsReturns:

React.ComponentClass<DropDownListToolProps, React.ComponentState>

The DropDownList tool component of the Editor.

createUndoTool

Creates the Undo tool component of the Editor.

Parameters:settingsToolSettingsReturns:

React.ComponentClass<ToolProps, React.ComponentState>

The Undo tool component of the Editor.

createUnlinkTool

Creates the Unlink tool component of the Editor.

Parameters:settingsUnlinkSettingsReturns:

React.ComponentClass<UnlinkProps, React.ComponentState>

The Unlink tool component of the Editor.

createViewHtmlTool

Creates the ViewHtml tool component of the Editor.

Parameters:settingsViewHtmlSettingsReturns:

React.ComponentClass<ViewHtmlProps>

The ViewHtml tool component of the Editor.

NumberedList

The NumberedList tool component. Will render a SplitButton which applies <ul> HTML element with predefined styles - upper-roman, lower-roman, upper-latin and lower-latin.

Parameters:propsanyReturns:

Element

Components

AddColumnAfter

The AddColumnAfter tool component.

AddColumnBefore

The AddColumnBefore tool component.

AddRowAfter

The AddRowAfter tool component.

AddRowBefore

The AddRowBefore tool component.

AlignCenter

The AlignCenter tool component.

AlignJustify

The AlignJustify tool component.

AlignLeft

The AlignLeft tool component.

AlignRight

The AlignRight tool component.

BackColor

The BackColor tool component.

Bold

The Bold tool component.

CleanFormatting

The CleanFormatting tool component.

DeleteColumn

The DeleteColumn tool component.

DeleteRow

The DeleteRow tool component.

DeleteTable

The DeleteTable tool component.

FontName

The FontName tool component.

ForeColor

The ForeColor tool component.

FormatBlock

The FormatBlock tool component.

Indent

The Indent tool component.

InsertFile

The InsertFile tool component.

InsertImage

The InsertImage tool component.

InsertTable

The InsertTable tool component.

Italic

The Italic tool component.

Link

The Link tool component.

MergeCells

The MergeCells tool component.

OrderedList

The basic OrderedList tool component. Will render a button which applies <ol> HTML element.

Outdent

The Outdent tool component.

Pdf

The Export to PDF tool component.

To modify the default PDF export options, see the following example:

Print

The Print tool component. Designed to work only if Editor's defaultEditMode prop is set to 'iframe'.

Redo

The Redo tool component of the Editor.

SelectAll

The SelectAll tool component.

SplitCell

The SplitCell tool component.

Strikethrough

The Strikethrough tool component.

Subscript

The Subscript tool component.

Superscript

The Superscript tool component.

TableCellProperties

The TableCellProperties tool component.

TableProperties

The TableProperties tool component.

Underline

The Underline tool component.

Undo

The Undo tool component of the Editor.

Unlink

The Unlink tool component.

UnorderedList

The basic UnorderedList tool component. Will render a button which applies <ul> HTML element.

ViewHtml

The ViewHtml tool component.

Interfaces

AddColumnAfterProps

The props for the AddColumnAfter tool component of the Editor.

AddColumnBeforeProps

The props for the AddColumnBefore tool component of the Editor.

AddRowAfterProps

The props for the AddRowAfter tool component of the Editor.

AddRowBeforeProps

The props for the AddRowBefore tool component of the Editor.

AlignCenterProps

The props for the AlignCenter tool component of the Editor.

AlignJustifyProps

The props for the AlignJustify tool component of the Editor.

AlignLeftProps

The props for the AlignLeft tool component of the Editor.

AlignRightProps

The props for the AlignRight tool component of the Editor.

AlignToolProps

The props for the Align tool component of the Editor.

BackColorProps

The props for the BackColor tool component of the Editor.

BoldProps

The props for the Bold tool component of the Editor.

CleanFormattingProps

The props for the CleanFormatting tool component of the Editor.

DeleteColumnProps

The props for the DeleteColumn tool component of the Editor.

DeleteRowProps

The props for the DeleteRow tool component of the Editor.

DeleteTableProps

The props for the DeleteTable tool component of the Editor.

DropDownListToolProps

The props for the DropDownList tool component for inline styling of the Editor.

FindAndReplaceProps

The props for the FindAndReplace tool component of the Editor.

FontNameProps

The props for the FontName tool component of the Editor.

FontSizeProps

The props for the FontSize tool component of the Editor.

ForeColorProps

The props for the ForeColor tool component of the Editor.

FormatBlockProps

The props for the FormatBlock tool component of the Editor.

IndentProps

The props for the Indent tool component of the Editor.

InlineFormatToolProps

The props for the InlineFormat tool component of the Editor.

InsertImageProps

The props for the InsertImage tool component of the Editor.

InsertTablePopupProps

The props of the InsertTablePopup component.

InsertTableProps

The props for the InsertTable tool component of the Editor.

ItalicProps

The props for the Italic tool component of the Editor.

LinkProps

The props for the Link tool component of the Editor.

ListToolProps

The base interface of OrderedListProps and UnorderedListProps.

MergeCellsProps

The props for the MergeCells tool component of the Editor.

OrderedListProps

The props for the OrderedList tool component of the Editor.

OutdentProps

The props for the Outdent tool component of the Editor.

PdfProps

The props for the Export to PDF tool component of the Editor.

PrintProps

The props for the Print tool component of the Editor.

RedoProps

The props for the Redo tool component of the Editor.

SelectAllProps

The props for the SelectAll tool component of the Editor.

SplitCellProps

The props for the SplitCell tool component of the Editor.

StrikethroughProps

The props for the Strikethrough tool component of the Editor.

SubscriptProps

The props for the Subscript tool component of the Editor.

SuperscriptProps

The props for the Superscript tool component of the Editor.

TableCellPropertiesProps

The props for the TableCellProperties tool component of the Editor.

TablePropertiesProps

The props for the TableProperties tool component of the Editor.

UnderlineProps

The props for the Underline tool component of the Editor.

UndoProps

The props for the Undo tool component of the Editor.

UnlinkProps

The props for the Unlink tool component of the Editor.

UnorderedListProps

The props for the UnorderedList tool component of the Editor.

ViewHtmlProps

The props for the ViewHtml tool component of the Editor.

Classes

FindAndReplace

The FindAndReplace tool component.

InsertTablePopup

The InsertTablePopup component.