CommandsMap (core)
@ckeditor/ckeditor5-core/src/commandcollection
interface
Helper type that maps command names to their types. It is meant to be extended with module augmentation.
class MyCommand extends Command {
public execute( parameter: A ): B {
// ...
}
}
declare module '@ckeditor/ckeditor5-core' {
interface CommandsMap {
myCommand: MyCommand;
}
}
// Returns `MyCommand | undefined`.
const myCommand = editor.commands.get( 'myCommand' );
// Expects `A` type as parameter and returns `B`.
const value = editor.commands.execute( 'myCommand', new A() );
Filtering
Properties
-
acceptAllSuggestions : ExecuteOnAllSuggestionsCommand<AcceptSuggestionCommand>
module:core/commandcollection~CommandsMap#acceptAllSuggestions
-
acceptSelectedSuggestions : ExecuteOnSelectedSuggestionsCommand<AcceptSuggestionCommand>
module:core/commandcollection~CommandsMap#acceptSelectedSuggestions
-
acceptSuggestion : AcceptSuggestionCommand
module:core/commandcollection~CommandsMap#acceptSuggestion
-
alignment : AlignmentCommand
module:core/commandcollection~CommandsMap#alignment
-
blockQuote : BlockQuoteCommand
module:core/commandcollection~CommandsMap#blockQuote
-
bold : AttributeCommand
module:core/commandcollection~CommandsMap#bold
-
bulletedList : ListCommand | DocumentListCommand
module:core/commandcollection~CommandsMap#bulletedList
-
checkTodoList : CheckTodoListCommand
module:core/commandcollection~CommandsMap#checkTodoList
-
ckbox : CKBoxCommand
module:core/commandcollection~CommandsMap#ckbox
-
ckfinder : CKFinderCommand
module:core/commandcollection~CommandsMap#ckfinder
-
code : AttributeCommand
module:core/commandcollection~CommandsMap#code
-
codeBlock : CodeBlockCommand
module:core/commandcollection~CommandsMap#codeBlock
-
copyFormat : CopyFormatCommand
module:core/commandcollection~CommandsMap#copyFormat
-
delete : DeleteCommand
module:core/commandcollection~CommandsMap#delete
-
deleteForward : DeleteCommand
module:core/commandcollection~CommandsMap#deleteForward
-
discardAllSuggestions : ExecuteOnAllSuggestionsCommand<DiscardSuggestionCommand>
module:core/commandcollection~CommandsMap#discardAllSuggestions
-
discardSelectedSuggestions : ExecuteOnSelectedSuggestionsCommand<DiscardSuggestionCommand>
module:core/commandcollection~CommandsMap#discardSelectedSuggestions
-
discardSuggestion : DiscardSuggestionCommand
module:core/commandcollection~CommandsMap#discardSuggestion
-
enter : EnterCommand
module:core/commandcollection~CommandsMap#enter
-
exportPdf : ExportPdfCommand
module:core/commandcollection~CommandsMap#exportPdf
-
exportWord : ExportWordCommand
module:core/commandcollection~CommandsMap#exportWord
-
find : FindCommand
module:core/commandcollection~CommandsMap#find
-
findNext : FindNextCommand
module:core/commandcollection~CommandsMap#findNext
-
findPrevious : FindPreviousCommand
module:core/commandcollection~CommandsMap#findPrevious
-
fontBackgroundColor : FontBackgroundColorCommand
module:core/commandcollection~CommandsMap#fontBackgroundColor
-
fontColor : FontColorCommand
module:core/commandcollection~CommandsMap#fontColor
-
fontFamily : FontFamilyCommand
module:core/commandcollection~CommandsMap#fontFamily
-
fontSize : FontSizeCommand
module:core/commandcollection~CommandsMap#fontSize
-
goToNextRestrictedEditingException : RestrictedEditingModeNavigationCommand
module:core/commandcollection~CommandsMap#goToNextRestrictedEditingException
-
goToPreviousRestrictedEditingException : RestrictedEditingModeNavigationCommand
module:core/commandcollection~CommandsMap#goToPreviousRestrictedEditingException
-
heading : HeadingCommand
module:core/commandcollection~CommandsMap#heading
-
highlight : HighlightCommand
module:core/commandcollection~CommandsMap#highlight
-
horizontalLine : HorizontalLineCommand
module:core/commandcollection~CommandsMap#horizontalLine
-
htmlEmbed : HtmlEmbedCommand
module:core/commandcollection~CommandsMap#htmlEmbed
-
imageStyle : ImageStyleCommand
module:core/commandcollection~CommandsMap#imageStyle
-
imageTextAlternative : ImageTextAlternativeCommand
module:core/commandcollection~CommandsMap#imageTextAlternative
-
imageTypeBlock : ImageTypeCommand
module:core/commandcollection~CommandsMap#imageTypeBlock
-
imageTypeInline : ImageTypeCommand
module:core/commandcollection~CommandsMap#imageTypeInline
-
importWord : ImportWordCommand
module:core/commandcollection~CommandsMap#importWord
-
indentBlock : IndentBlockCommand
module:core/commandcollection~CommandsMap#indentBlock
-
indentCodeBlock : IndentCodeBlockCommand
module:core/commandcollection~CommandsMap#indentCodeBlock
-
indentList : IndentCommand | DocumentListIndentCommand
module:core/commandcollection~CommandsMap#indentList
-
insertImage : InsertImageCommand
module:core/commandcollection~CommandsMap#insertImage
-
insertParagraph : InsertParagraphCommand
module:core/commandcollection~CommandsMap#insertParagraph
-
insertTable : InsertTableCommand
module:core/commandcollection~CommandsMap#insertTable
-
insertTableColumnLeft : InsertColumnCommand
module:core/commandcollection~CommandsMap#insertTableColumnLeft
-
insertTableColumnRight : InsertColumnCommand
module:core/commandcollection~CommandsMap#insertTableColumnRight
-
insertTableOfContents : TableOfContentsCommand
module:core/commandcollection~CommandsMap#insertTableOfContents
-
insertTableRowAbove : InsertRowCommand
module:core/commandcollection~CommandsMap#insertTableRowAbove
-
insertTableRowBelow : InsertRowCommand
module:core/commandcollection~CommandsMap#insertTableRowBelow
-
insertTemplate : TemplateCommand
module:core/commandcollection~CommandsMap#insertTemplate
-
insertText : InsertTextCommand
module:core/commandcollection~CommandsMap#insertText
-
italic : AttributeCommand
module:core/commandcollection~CommandsMap#italic
-
link : LinkCommand
module:core/commandcollection~CommandsMap#link
-
listReversed : ListReversedCommand | DocumentListReversedCommand
module:core/commandcollection~CommandsMap#listReversed
-
listStart : ListStartCommand | DocumentListStartCommand
module:core/commandcollection~CommandsMap#listStart
-
listStyle : ListStyleCommand | DocumentListStyleCommand
module:core/commandcollection~CommandsMap#listStyle
-
mediaEmbed : MediaEmbedCommand
module:core/commandcollection~CommandsMap#mediaEmbed
-
mention : MentionCommand
module:core/commandcollection~CommandsMap#mention
-
mergeListItemBackward : DocumentListMergeCommand
module:core/commandcollection~CommandsMap#mergeListItemBackward
-
mergeListItemForward : DocumentListMergeCommand
module:core/commandcollection~CommandsMap#mergeListItemForward
-
mergeTableCellDown : MergeCellCommand
module:core/commandcollection~CommandsMap#mergeTableCellDown
-
mergeTableCellLeft : MergeCellCommand
module:core/commandcollection~CommandsMap#mergeTableCellLeft
-
mergeTableCellRight : MergeCellCommand
module:core/commandcollection~CommandsMap#mergeTableCellRight
-
mergeTableCellUp : MergeCellCommand
module:core/commandcollection~CommandsMap#mergeTableCellUp
-
mergeTableCells : MergeCellsCommand
module:core/commandcollection~CommandsMap#mergeTableCells
-
numberedList : ListCommand | DocumentListCommand
module:core/commandcollection~CommandsMap#numberedList
-
outdentBlock : IndentBlockCommand
module:core/commandcollection~CommandsMap#outdentBlock
-
outdentCodeBlock : OutdentCodeBlockCommand
module:core/commandcollection~CommandsMap#outdentCodeBlock
-
outdentList : IndentCommand | DocumentListIndentCommand
module:core/commandcollection~CommandsMap#outdentList
-
pageBreak : PageBreakCommand
module:core/commandcollection~CommandsMap#pageBreak
-
paragraph : ParagraphCommand
module:core/commandcollection~CommandsMap#paragraph
-
pasteFormat : PasteFormatCommand
module:core/commandcollection~CommandsMap#pasteFormat
-
redo : RedoCommand
module:core/commandcollection~CommandsMap#redo
-
removeFormat : RemoveFormatCommand
module:core/commandcollection~CommandsMap#removeFormat
-
removeTableColumn : RemoveColumnCommand
module:core/commandcollection~CommandsMap#removeTableColumn
-
removeTableRow : RemoveRowCommand
module:core/commandcollection~CommandsMap#removeTableRow
-
replace : ReplaceCommand
module:core/commandcollection~CommandsMap#replace
-
replaceAll : ReplaceAllCommand
module:core/commandcollection~CommandsMap#replaceAll
-
replaceImageSource : ReplaceImageSourceCommand
module:core/commandcollection~CommandsMap#replaceImageSource
-
resizeImage : ResizeImageCommand
module:core/commandcollection~CommandsMap#resizeImage
-
restoreRevision : RestoreRevisionCommand
module:core/commandcollection~CommandsMap#restoreRevision
-
restrictedEditingException : RestrictedEditingExceptionCommand
module:core/commandcollection~CommandsMap#restrictedEditingException
-
selectAll : SelectAllCommand
module:core/commandcollection~CommandsMap#selectAll
-
selectTableColumn : SelectColumnCommand
module:core/commandcollection~CommandsMap#selectTableColumn
-
selectTableRow : SelectRowCommand
module:core/commandcollection~CommandsMap#selectTableRow
-
setTableColumnHeader : SetHeaderColumnCommand
module:core/commandcollection~CommandsMap#setTableColumnHeader
-
setTableRowHeader : SetHeaderRowCommand
module:core/commandcollection~CommandsMap#setTableRowHeader
-
shiftEnter : ShiftEnterCommand
module:core/commandcollection~CommandsMap#shiftEnter
-
showNextChange : ShowChangeCommand<'forward'>
module:core/commandcollection~CommandsMap#showNextChange
-
showPreviousChange : ShowChangeCommand<'backward'>
module:core/commandcollection~CommandsMap#showPreviousChange
-
splitListItemAfter : DocumentListSplitCommand
module:core/commandcollection~CommandsMap#splitListItemAfter
-
splitListItemBefore : DocumentListSplitCommand
module:core/commandcollection~CommandsMap#splitListItemBefore
-
splitTableCellHorizontally : SplitCellCommand
module:core/commandcollection~CommandsMap#splitTableCellHorizontally
-
splitTableCellVertically : SplitCellCommand
module:core/commandcollection~CommandsMap#splitTableCellVertically
-
strikethrough : AttributeCommand
module:core/commandcollection~CommandsMap#strikethrough
-
style : StyleCommand
module:core/commandcollection~CommandsMap#style
-
subscript : AttributeCommand
module:core/commandcollection~CommandsMap#subscript
-
superscript : AttributeCommand
module:core/commandcollection~CommandsMap#superscript
-
tableAlignment : TableAlignmentCommand
module:core/commandcollection~CommandsMap#tableAlignment
-
tableBackgroundColor : TableBackgroundColorCommand
module:core/commandcollection~CommandsMap#tableBackgroundColor
-
tableBorderColor : TableBorderColorCommand
module:core/commandcollection~CommandsMap#tableBorderColor
-
tableBorderStyle : TableBorderStyleCommand
module:core/commandcollection~CommandsMap#tableBorderStyle
-
tableBorderWidth : TableBorderWidthCommand
module:core/commandcollection~CommandsMap#tableBorderWidth
-
tableCellBackgroundColor : TableCellBackgroundColorCommand
module:core/commandcollection~CommandsMap#tableCellBackgroundColor
-
tableCellBorderColor : TableCellBorderColorCommand
module:core/commandcollection~CommandsMap#tableCellBorderColor
-
tableCellBorderStyle : TableCellBorderStyleCommand
module:core/commandcollection~CommandsMap#tableCellBorderStyle
-
tableCellBorderWidth : TableCellBorderWidthCommand
module:core/commandcollection~CommandsMap#tableCellBorderWidth
-
tableCellHeight : TableCellHeightCommand
module:core/commandcollection~CommandsMap#tableCellHeight
-
tableCellHorizontalAlignment : TableCellHorizontalAlignmentCommand
module:core/commandcollection~CommandsMap#tableCellHorizontalAlignment
-
tableCellPadding : TableCellPaddingCommand
module:core/commandcollection~CommandsMap#tableCellPadding
-
tableCellVerticalAlignment : TableCellVerticalAlignmentCommand
module:core/commandcollection~CommandsMap#tableCellVerticalAlignment
-
tableCellWidth : TableCellWidthCommand
module:core/commandcollection~CommandsMap#tableCellWidth
-
tableHeight : TableHeightCommand
module:core/commandcollection~CommandsMap#tableHeight
-
tableWidth : TableWidthCommand
module:core/commandcollection~CommandsMap#tableWidth
-
textPartLanguage : TextPartLanguageCommand
module:core/commandcollection~CommandsMap#textPartLanguage
-
todoList : ListCommand
module:core/commandcollection~CommandsMap#todoList
-
toggleImageCaption : ToggleImageCaptionCommand
module:core/commandcollection~CommandsMap#toggleImageCaption
-
toggleTableCaption : ToggleTableCaptionCommand
module:core/commandcollection~CommandsMap#toggleTableCaption
-
trackChanges : TrackChangesCommand
module:core/commandcollection~CommandsMap#trackChanges
-
underline : AttributeCommand
module:core/commandcollection~CommandsMap#underline
-
undo : UndoCommand
module:core/commandcollection~CommandsMap#undo
-
unlink : UnlinkCommand
module:core/commandcollection~CommandsMap#unlink
-
uploadImage : UploadImageCommand
module:core/commandcollection~CommandsMap#uploadImage
Every day, we work hard to keep our documentation complete. Have you spotted outdated information? Is something missing? Please report it via our issue tracker.