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 work in progress
AddExportFormat work in progress
AddFill work in progress
AddFlow work in progress
AddFlowBack work in progress
AddFlowHome work in progress
AddInnerShadow work in progress
AddShadow work in progress
AlignBottom work in progress
AlignCenter work in progress
AlignJustified work in progress
AlignLayersBottom work in progress
AlignLayersCenter work in progress
AlignLayersLeft work in progress
AlignLayersMiddle work in progress
AlignLayersRight work in progress
AlignLayersTop work in progress
AlignLeft work in progress
AlignMiddle work in progress
AlignRight work in progress
AlignTop work in progress
AlignmentActions work in progress
ApplyHorizontalFlip work in progress
ApplyVerticalFlip work in progress
AssignColorSpace work in progress
AutoExpandGroups work in progress
BackToInstance work in progress
BadgeMenu work in progress
BaseAlignLayers work in progress
BaseStyle work in progress
BooleanActionGroup work in progress
BooleanMenu work in progress
CenterLayersInCanvas work in progress
CenterSelectionInVisibleArea work in progress
ChangeFlowAnimationFromBottomAnimation work in progress
ChangeFlowAnimationFromLeftAnimation work in progress
ChangeFlowAnimationFromRightAnimation work in progress
ChangeFlowAnimationFromTopAnimation work in progress
ChangeFlowAnimationNoAnimation work in progress
ChangeFont work in progress
ClippingMask work in progress
ClippingMaskMode work in progress
ClosePath work in progress
Cloud work in progress
CollapseAllGroups work in progress
ColorInspectorCircularGradientTab work in progress
ColorInspectorColorTab work in progress
ColorInspectorImageTab work in progress
ColorInspectorLinearGradientTab work in progress
ColorInspectorModeBorderTouchBarGroup work in progress
ColorInspectorModeFillTouchBarGroup work in progress
ColorInspectorModePicker work in progress
ColorInspectorRadialGradientTab work in progress
ConstraintFixHeight work in progress
ConstraintFixWidth work in progress
ConstraintPinBottom work in progress
ConstraintPinLeft work in progress
ConstraintPinRight work in progress
ConstraintPinTop work in progress
ConstraintReset work in progress
ConvertColorSpace work in progress
ConvertFlowToHotspot work in progress
ConvertSymbolOrDetachInstances work in progress
ConvertToOutlines work in progress
Copy work in progress
CopyCSSAttributes work in progress
CopySVGCode work in progress
CopyStyle work in progress
CreateSharedStyle work in progress
CreateSymbol work in progress
CurveModeAsymmetric work in progress
CurveModeDisconnected work in progress
CurveModeMirrored work in progress
CurveModeStraight work in progress
CurveModeTouchGroup work in progress
Cut work in progress
Data work in progress
DataMenu work in progress
DefaultStyle work in progress
Delete work in progress
DetachSharedStyle work in progress
DetachSybolInstances work in progress
Difference work in progress
DistributeActions work in progress
DistributeHorizontally work in progress
DistributeVertically work in progress
Duplicate work in progress
Edit work in progress
EditColorSpace work in progress
Export work in progress
ExportPDFBook work in progress
ExportSelectionWithExportFormats work in progress
FindLayer work in progress
Flatten work in progress
FlattenSelection work in progress
FlipHorizontal work in progress
FlipVertical work in progress
FollowFlow work in progress
GridSettings work in progress
Group work in progress
GroupActionGroup work in progress
HandleURL Triggered when Sketch is opened with the following URL scheme: `sketch://plugin/my.plugin.identifier/my.command.identifier`.
HandlerGotFocus work in progress
HandlerLostFocus work in progress
HideAllGridsAndLayouts work in progress
HideLayer work in progress
IgnoreClippingMask work in progress
ImageOriginalSize work in progress
IncompatiblePluginsDisabled work in progress
InsertArrow work in progress
InsertArtboard work in progress
InsertHotspot work in progress
InsertImage work in progress
InsertLine work in progress
InsertMenu work in progress
InsertSharedText work in progress
InsertSlice work in progress
InsertSymbol work in progress
InsertTextLayer work in progress
InsertVector work in progress
Intersect work in progress
Join work in progress
LayerFocusActions work in progress
LayerHeightFocus work in progress
LayerWidthFocus work in progress
LayerXFocus work in progress
LayerYFocus work in progress
LayoutSettings work in progress
LicenseExpired work in progress
ListTypeActionBullet work in progress
ListTypeActionNone work in progress
ListTypeActionNumbered work in progress
LockLayer work in progress
Magnifier work in progress
MakeGrid work in progress
MakeLowercase work in progress
MakeUppercase work in progress
ManageShareableObjects work in progress
MaskWithShape work in progress
Mirror work in progress
MoveActionGroup work in progress
MoveBackward work in progress
MoveForward work in progress
MoveToBack work in progress
MoveToFront work in progress
MoveToTop work in progress
MoveUpHierarchy work in progress
NewPage work in progress
NextPage work in progress
NineSlice work in progress
OffsetPath work in progress
OpenPreview work in progress
OpenStyleInLibrary work in progress
OpenSymbolInLibrary work in progress
OvalShape work in progress
Paste work in progress
PasteHere work in progress
PasteOverSelection work in progress
PasteStyle work in progress
Pencil work in progress
PolygonShape work in progress
PreviewAtActualSize work in progress
PreviousPage work in progress
Print work in progress
Publish work in progress
RectangleShape work in progress
Redo work in progress
ReduceFileSize work in progress
ReduceImageSize work in progress
RemoveAllOverrides work in progress
RemoveFlow work in progress
RemoveTextTransform work in progress
RemoveUnusedStyles work in progress
RenameLayer work in progress
ReplaceColor work in progress
ReplaceFonts work in progress
ReplaceImage work in progress
ReplaceWithSymbol work in progress
ResetBoolean work in progress
ResetOrigin work in progress
ResetSharedStyle work in progress
ResetSymbolSize work in progress
ResizeArtboardToFit work in progress
RevealInLayerList work in progress
ReversePath work in progress
Rotate work in progress
RotateClockwise work in progress
RotateCounterclockwise work in progress
RoundToPixel work in progress
RoundedRectangleShape work in progress
RunPluginCommand work in progress
SaveAsTemplate work in progress
Scale work in progress
Scissors work in progress
SelectAll work in progress
SelectAllArtboards work in progress
SendToSymbolsPage work in progress
Shape work in progress
ShowBorderOptions work in progress
ShowColors work in progress
ShowFillOptions work in progress
ShowFonts work in progress
ShowReplaceColorSheet work in progress
SmartRotate work in progress
SpiralShape work in progress
Split work in progress
StarShape work in progress
Subtract work in progress
SyncLibrary work in progress
SyncLocalStyle work in progress
SyncSharedStyle work in progress
TextAlignTouchBarGroup work in progress
TextOnPath work in progress
TextStyleTouchBar work in progress
ToggleAlignmentGuides work in progress
ToggleArtboardShadow work in progress
ToggleFixToViewport work in progress
ToggleFlowInteraction work in progress
ToggleGrid work in progress
ToggleInspectorVisibility work in progress
ToggleInterface work in progress
ToggleLayerHighlight work in progress
ToggleLayerListVisibility work in progress
ToggleLayout work in progress
TogglePixelGrid work in progress
TogglePixelLines work in progress
TogglePresentationMode work in progress
ToggleRulerDragLocking work in progress
ToggleRulers work in progress
ToggleSelection work in progress
ToggleSliceInteraction work in progress
ToggleToolbarVisibility work in progress
ToolsMenu work in progress
Transform work in progress
TriangleShape work in progress
Underline work in progress
Undo work in progress
Ungroup work in progress
Union work in progress
UnlinkAndSyncFromLibrary work in progress
UnlinkFromLibrary work in progress
UpdatePlugins work in progress
ViewMenu work in progress
Zoom work in progress
ZoomActions work in progress
ZoomIn work in progress
ZoomOut work in progress
ZoomToActualSize work in progress
ZoomToArtboard work in progress
ZoomToSelection work in progress
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.