Actions Reference

Plugins can respond to the following actions. If you want to learn how to listen to an action, see the Action API guide.

List of Actions

AddBorder
AddExportFormat
AddFill
AddFlow
AddFlowBack
AddFlowHome
AddInnerShadow
AddShadow
AlignBottom
AlignCenter
AlignJustified
AlignLayersBottom
AlignLayersCenter
AlignLayersLeft
AlignLayersMiddle
AlignLayersRight
AlignLayersTop
AlignLeft
AlignMiddle
AlignRight
AlignTop
AlignmentActions
ApplyData
ApplyHorizontalFlip
ApplyVerticalFlip
AssignColorSpace
Assistant
AssistantActivate
AssistantCheckDocument
AssistantCheckDocumentAutomatically
AssistantConfigure
AssistantInstallFromDisk
AssistantInstallFromURL
AssistantInstallMissing
AssistantShowIgnored
AutoExpandGroups
BackToInstance
BadgeMenu
BaseAlignLayers
BaseStyle
BooleanActionGroup
BooleanMenu
CenterLayersInCanvas
CenterSelectionInVisibleArea
ChangeFlowAnimationFromBottomAnimation
ChangeFlowAnimationFromLeftAnimation
ChangeFlowAnimationFromRightAnimation
ChangeFlowAnimationFromTopAnimation
ChangeFlowAnimationNoAnimation
ChangeFont
ChangeInferredLayout
ClearDataRecord
ClippingMask
ClippingMaskMode
ClosePath
Cloud
CollapseAllGroups
ColorInspectorCircularGradientTab
ColorInspectorColorTab
ColorInspectorImageTab
ColorInspectorLinearGradientTab
ColorInspectorModeBorderTouchBarGroup
ColorInspectorModeFillTouchBarGroup
ColorInspectorModePicker
ColorInspectorRadialGradientTab
ConstraintFixHeight
ConstraintFixWidth
ConstraintPinBottom
ConstraintPinLeft
ConstraintPinRight
ConstraintPinTop
ConstraintReset
ContextMenuData
ConvertColorSpace
ConvertFlowToHotspot
ConvertSymbolOrDetachInstances
ConvertSymbolOrDetachInstancesRecursively
ConvertToOutlines
Copy
CopyCSSAttributes
CopyCloudDocumentLink
CopyOverride
CopySVGCode
CopyStyle
CreateSharedColor
CreateSharedStyle
CreateSymbol
CurveModeAsymmetric
CurveModeDisconnected
CurveModeMirrored
CurveModeStraight
CurveModeTouchGroup
Cut
DataMenu
DefaultStyle
Delete
DetachSharedColor
DetachSharedStyle
Difference
DistributeActions
DistributeHorizontally
DistributeVertically
Duplicate
Edit
EditColorSpace
Export
ExportPDFBook
ExportSelectionWithExportFormats
Find
Flatten
FlattenSelection
FlipHorizontal
FlipVertical
FollowFlow
ForceResyncLibrary
GridSettings
Group
GroupActionGroup
HandleURL Triggered when Sketch is opened with the following URL scheme: `sketch://plugin/my.plugin.identifier/my.command.identifier`.
HandlerGotFocus
HandlerLostFocus
HideAllGridsAndLayouts
HideLayer
IgnoreClippingMask
ImageOriginalSize
IncompatiblePluginsDisabled
InsertArrow
InsertArtboard
InsertHotspot
InsertImage
InsertLine
InsertMenu
InsertSharedText
InsertSlice
InsertSymbol
InsertTextLayer
InsertVector
Intersect
Join
LayerFocusActions
LayerHeightFocus
LayerWidthFocus
LayerXFocus
LayerYFocus
LayoutSettings
LegacyInsertMenu
LicenseExpired
ListTypeActionBullet
ListTypeActionNone
ListTypeActionNumbered
LockLayer
Magnifier
MainMenuData
MakeGrid
MakeLowercase
MakeUppercase
ManageCloudDocumentShareSettings
MaskWithShape
Mirror
MoveActionGroup
MoveBackward
MoveForward
MoveToBack
MoveToFront
MoveToTop
MoveUpHierarchy
NavigateToOverrideMaster
NewPage
NextPage
OffsetPath
OpenPreview
OpenStyleInLibrary
OpenSwatchInLibrary
OpenSymbolInLibrary
OpenTypeFeatures
OrganizeImportedSymbols
OvalShape
Paste
PasteHere
PasteOverSelection
PasteStyle
PasteWithStyle
Pencil
PolygonShape
PreviewAtActualSize
PreviousPage
Print
RectangleShape
Redo
ReduceFileSize
ReduceImageSize
RefreshData
RemoveAllOverrides
RemoveFlow
RemoveSelectedOverrides
RemoveTextTransform
RemoveUnusedStyles
RenameLayer
ReplaceColor
ReplaceFonts
ReplaceImage
ReplaceOverride
ReplaceOverrideStyle
ReplaceOverrideSymbol
ReplaceWithSymbol
ReplaceWithSymbolRoot
ResetOrigin
ResetSharedColor
ResetSharedStyle
ResetSymbolSize
ResizeArtboardToFit
RevealInLayerList
ReversePath
Rotate
RotateClockwise
RotateCounterclockwise
RoundToPixel
RoundedRectangleShape
RunPluginCommand
SaveAsTemplate
Scale
Scissors
Search
SelectAll
SelectAllArtboards
SendToSymbolsPage
Shape
ShowBorderOptions
ShowColors
ShowComponentsPane
ShowDocumentFonts
ShowFillOptions
ShowFonts
ShowLayerList
ShowReplaceColorSheet
Sketch.MSAddComponent
Sketch.MSChangeComponentKindActionGroup
Sketch.MSChangeLayerStyleComponentKind
Sketch.MSChangeSwatchComponentKind
Sketch.MSChangeSymbolComponentKind
Sketch.MSChangeTextStyleComponentKind
Sketch.MSComponentsPicker
Sketch.MSContentMode
Sketch.MSCopyComponent
Sketch.MSDeleteComponent
Sketch.MSDuplicateComponent
Sketch.MSEditSymbolMasterComponent
Sketch.MSFilterComponentList
Sketch.MSGroupComponents
Sketch.MSInsertComponentInstance
Sketch.MSMaintainScrollPosition
Sketch.MSRenameComponent
Sketch.MSRenameSharedStyle
Sketch.MSRevealComponent
Sketch.MSRevealComponentsPanel
Sketch.MSTidy
Sketch.MSUngroupComponents
Sketch.MSVisitSymbolComponent
Sketch.ToggleLibraryListInComponentsPanel
SmartRotate
StarShape
Subtract
SyncLibrary
SyncLocalColor
SyncLocalStyle
TextAlignTouchBarGroup
TextOnPath
TextStyleTouchBar
ToggleAlignmentGuides
ToggleArtboardShadow
ToggleFixToViewport
ToggleFlowInteraction
ToggleGrid
ToggleInspectorVisibility
ToggleInterface
ToggleLayerHighlight
ToggleLayout
TogglePixelGrid
TogglePixelLines
ToggleRulerDragLocking
ToggleRulers
ToggleSelection
ToggleSidebarVisibility
ToggleSliceInteraction
ToggleToolbarVisibility
ToolsMenu
Transform
TriangleShape
Underline
Undo
Ungroup
Union
UnlinkAndSyncFromLibrary
UnlinkFromLibrary
UpdatePlugins
ViewDocumentInDocumentsWindow
ViewMenu
ViewOnSketchCloudWeb
Zoom
ZoomActions
ZoomIn
ZoomOut
ZoomToActualSize
ZoomToArtboard
ZoomToSelection
AddAsLibrary Triggered when a document is saved as a Library
ApplyLandscapeOrientation Triggered when the orientation of an Artboard changes
ApplyPortraitOrientation Triggered when the orientation of an Artboard changes
ApplySharedLayerStyle Triggered when a shared Layer Style is applied to a layer
ApplySharedTextStyle Triggered when a shared Text Style is applied to a text layer
ArtboardChanged Triggered when the current Artboard changes
CloseDocument Triggered when a document is closed
DocumentSaved Triggered when a document is saved
ExportSlices Triggered whenever the user exports some artboards, layers or slices
LayersMoved Triggered when some layers are moved by the user
LayersResized Triggered when some layers are resized by the user
OpenDocument Triggered when a document is opened
SelectionChanged Triggered whenever the user changes which layers are selected in a document
Shutdown Triggered when the plugin is unloaded
Startup Triggered when the plugin is loaded
TextChanged Triggered when the contents of a text layer change
ToggleBorder Triggered when the border for the selected shape is toggled
ToggleFill Triggered when the fill for the selected shape is toggled
See something wrong or incomplete? Improve this page.