Skip to content
This plugin is new and currently in beta. For the stable version, please use the previous version of the plugin.

Stripo Extensions SDK API Reference

Comprehensive API documentation for the Stripo Email Editor Extensions SDK.

Core Interfaces

API Interfaces

APIDescription
BaseApiCore API functionality for all extension components
BaseModifierApiDocument modification capabilities
BlockApiAPI interface for Block implementations
BlockRendererApiAPI interface for BlockRenderer implementations
BlocksPanelApiAPI interface for custom blocks panel implementations
ContextActionApiAPI interface for context action implementations
ControlApiAPI interface for control implementations
SettingsPanelApiAPI interface for settings panel tab implementations
UIElementApiAPI interface for UI element implementations

Block Components

APIDescription
BlockBase abstract class for creating custom blocks
BlockRendererBase class for custom block rendering
BlocksPanelBase class for creating custom blocks panels
ContextActionAbstract base class for context menu actions

Control Components

APIDescription
ControlAbstract base class for creating custom controls

Core Components

APIDescription
ExtensionBase class for creating Stripo extensions
ExtensionBuilderBuilder class for constructing extension configurations

Template Modification

APIDescription
TemplateModifierBase interface for managing template modifications
HtmlNodeModifierInterface for modifying HTML nodes in email templates
CssNodeModifierInterface for modifying CSS rules and properties
MultiRowStructureModifierInterface for creating and modifying email structure layouts
ModificationDescriptionClass for providing context about template modifications

Node Interfaces

Base Node Interfaces

APIDescription
BaseImmutableNodeCommon interface for all immutable nodes
BaseImmutableHtmlNodeHTML-specific base with type casting method
BaseImmutableCssNodeCSS-specific base with type casting and comment checking

HTML Node Interfaces

APIDescription
ImmutableHtmlNodeBase interface for immutable HTML nodes
ImmutableHtmlElementNodeHTML elements with attributes, styles, and methods
ImmutableHtmlTextNodeText content nodes

CSS Node Interfaces

APIDescription
ImmutableCssNodeBase interface for immutable CSS nodes
ImmutableCssRuleNodeCSS rules with selectors
ImmutableCssAttributeNodeCSS properties/attributes
ImmutableCssCommentNodeCSS comments
ImmutableCssDocumentNodeDocument and media query containers

Types and Interfaces

APIDescription
AIPopoverOptionsConfiguration for AI-assisted popovers
BlockHintConfiguration for block hints and tooltips
BlockItemConfiguration for block items in panels
CustomFontFamilyConfiguration for custom font families
DisplayConditionConfiguration for conditional element visibility
EmojiPopoverOptionsConfiguration for emoji picker popovers
StructureLayoutType for defining container layouts in structures

Constants and Enums

APIDescription
AiAssistantValueTypeEnum for AI assistant value types
BlockAttrEnum for block attribute constants
BlockCompositionTypeEnum defining block composition types
BlockTypeEnum for block type definitions
ContextActionTypeEnum for context action type definitions
EditorStatePropertyTypeEnum for observable editor state properties
PanelPositionEnum for defining panel positioning options
PreviewDeviceModeEnum for preview device mode settings
SettingsTabEnum for settings tab definitions
UEAttrEnum for UI element attribute constants
UIElementTypeEnum for UI element type definitions

Integrations

APIDescription
ExternalAiAssistantInterface for integrating external AI assistants
ExternalDisplayConditionsLibraryInterface for integrating external display condition systems
ExternalImageLibraryInterface for integrating external image libraries
ExternalSmartElementsLibraryInterface for integrating external smart elements libraries
ExternalVideosLibraryInterface for integrating external video libraries

Settings Panel

APIDescription
SettingsPanelRegistryRegistry for managing settings panel tabs
SettingsPanelTabBase class for creating custom settings panel tabs

Icons Management

APIDescription
IconsRegistryRegistry for managing custom SVG icons in extensions

UI Elements

APIDescription
UIElementBase class for creating custom UI elements
UIElementTagRegistryRegistry for managing custom UI element tags