EditorTools

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

NameTypeDefaultDescription

AddColumnAfter

The AddColumnAfter tool component.

AddColumnAfterProps

The props for the AddColumnAfter tool component of the Editor.

AddColumnBefore

The AddColumnBefore tool component.

AddColumnBeforeProps

The props for the AddColumnBefore tool component of the Editor.

AddRowAfter

The AddRowAfter tool component.

AddRowAfterProps

The props for the AddRowAfter tool component of the Editor.

AddRowBefore

The AddRowBefore tool component.

AddRowBeforeProps

The props for the AddRowBefore tool component of the Editor.

AlignCenter

The AlignCenter tool component.

AlignCenterProps

The props for the AlignCenter tool component of the Editor.

AlignJustify

The AlignJustify tool component.

AlignJustifyProps

The props for the AlignJustify tool component of the Editor.

AlignLeft

The AlignLeft tool component.

AlignLeftProps

The props for the AlignLeft tool component of the Editor.

AlignRight

The AlignRight tool component.

AlignRightProps

The props for the AlignRight tool component of the Editor.

AlignToolProps

The props for the Align tool component of the Editor.

BackColor

React.FunctionComponent<BackColorProps>

The BackColor tool component.

BackColorProps

The props for the BackColor tool component of the Editor.

Bold

The Bold tool component.

BoldProps

The props for the Bold tool component of the Editor.

BulletedList

CleanFormatting

React.FunctionComponent<CleanFormattingProps>

The CleanFormatting tool component.

CleanFormattingProps

The props for the CleanFormatting tool component of the Editor.

createAddColumnAfterTool

createAddColumnBeforeTool

createAddRowAfterTool

createAddRowBeforeTool

createAlignTool

createDeleteColumnTool

createDeleteRowTool

createDeleteTableTool

createFormatBlockDropDownList

createIndentTool

createInlineFormatTool

createInsertImageTool

createInsertTableTool

createLinkTool

createListTool

createMergeCellsTool

createOutdentTool

createRedoTool

createSplitCellTool

createStyleDropDownList

createUndoTool

createUnlinkTool

createViewHtmlTool

DeleteColumn

The DeleteColumn tool component.

DeleteColumnProps

The props for the DeleteColumn tool component of the Editor.

DeleteRow

The DeleteRow tool component.

DeleteRowProps

The props for the DeleteRow tool component of the Editor.

DeleteTable

The DeleteTable tool component.

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.

FindAndReplace

The FindAndReplace tool component.

FindAndReplaceProps

The props for the FindAndReplace tool component of the Editor.

FontName

The FontName tool component.

FontNameProps

The props for the FontName tool component of the Editor.

FontSize

The FontSize tool component.

FontSizeProps

The props for the FontSize tool component of the Editor.

ForeColor

React.FunctionComponent<ForeColorProps>

The ForeColor tool component.

ForeColorProps

The props for the ForeColor tool component of the Editor.

FormatBlock

The FormatBlock tool component.

FormatBlockProps

The props for the FormatBlock tool component of the Editor.

Indent

The Indent tool component.

IndentProps

The props for the Indent tool component of the Editor.

InlineFormatToolProps

The props for the InlineFormat tool component of the Editor.

InsertFile

The InsertFile tool component.

InsertImage

The InsertImage tool component.

InsertImageProps

The props for the InsertImage tool component of the Editor.

InsertTable

The InsertTable tool component.

InsertTablePopup

The InsertTablePopup component.

InsertTablePopupProps

The props of the InsertTablePopup component.

InsertTableProps

The props for the InsertTable tool component of the Editor.

Italic

The Italic tool component.

ItalicProps

The props for the Italic tool component of the Editor.

The Link tool component.

LinkProps

The props for the Link tool component of the Editor.

ListToolProps

The base interface of OrderedListProps and UnorderedListProps.

MergeCells

The MergeCells tool component.

MergeCellsProps

The props for the MergeCells tool component of the Editor.

NumberedList

OrderedList

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

OrderedListProps

The props for the OrderedList tool component of the Editor.

Outdent

The Outdent tool component.

OutdentProps

The props for the Outdent tool component of the Editor.

Pdf

React.FunctionComponent<PdfProps>

The Export to PDF tool component.

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

import { Editor, EditorTools } from '@progress/kendo-react-editor';
const { Bold, Italic, Pdf } = EditorTools;

const PdfTool = (props: EditorTools.PdfProps) => (
    <Pdf
        {...props}
        // https://www.telerik.com/kendo-react-ui/components/pdfprocessing/api/PDFExportProps/
        savePdfOptions={{
            fileName: 'editor-export.pdf',
            paperSize: 'A5',
            margin: '1cm'
        }}
    />
);

class App extends React.Component<any, any> {
    render() {
        return (
            <Editor
                tools={[[ Bold, Italic, PdfTool ]]}
                contentStyle={{ height: 100 }}
                defaultContent="<p>text</p>"
            />
        );
    }
}

PdfProps

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

Print

React.FunctionComponent<PrintProps>

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

PrintProps

The props for the Print tool component of the Editor.

Redo

The Redo tool component of the Editor.

RedoProps

The props for the Redo tool component of the Editor.

SelectAll

React.FunctionComponent<SelectAllProps>

The SelectAll tool component.

SelectAllProps

The props for the SelectAll tool component of the Editor.

SplitCell

The SplitCell tool component.

SplitCellProps

The props for the SplitCell tool component of the Editor.

Strikethrough

The Strikethrough tool component.

StrikethroughProps

The props for the Strikethrough tool component of the Editor.

Subscript

The Subscript tool component.

SubscriptProps

The props for the Subscript tool component of the Editor.

Superscript

The Superscript tool component.

SuperscriptProps

The props for the Superscript tool component of the Editor.

Underline

The Underline tool component.

UnderlineProps

The props for the Underline tool component of the Editor.

Undo

The Undo tool component of the Editor.

UndoProps

The props for the Undo tool component of the Editor.

The Unlink tool component.

UnlinkProps

The props for the Unlink tool component of the Editor.

UnorderedList

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

UnorderedListProps

The props for the UnorderedList tool component of the Editor.

ViewHtml

The ViewHtml tool component.

ViewHtmlProps

The props for the ViewHtml tool component of the Editor.

In this article

Not finding the help you need?