Appearance
Stripo Extensions SDK API Reference
Comprehensive API documentation for the Stripo Email Editor Extensions SDK.
Core Interfaces
API Interfaces
API | Description |
---|---|
BaseApi | Core API functionality for all extension components |
BaseModifierApi | Document modification capabilities |
BlockApi | API interface for Block implementations |
BlockRendererApi | API interface for BlockRenderer implementations |
BlocksPanelApi | API interface for custom blocks panel implementations |
ContextActionApi | API interface for context action implementations |
ControlApi | API interface for control implementations |
SettingsPanelApi | API interface for settings panel tab implementations |
UIElementApi | API interface for UI element implementations |
Block Components
API | Description |
---|---|
Block | Base abstract class for creating custom blocks |
BlockRenderer | Base class for custom block rendering |
BlocksPanel | Base class for creating custom blocks panels |
ContextAction | Abstract base class for context menu actions |
Control Components
API | Description |
---|---|
Control | Abstract base class for creating custom controls |
Core Components
API | Description |
---|---|
Extension | Base class for creating Stripo extensions |
ExtensionBuilder | Builder class for constructing extension configurations |
Template Modification
API | Description |
---|---|
TemplateModifier | Base interface for managing template modifications |
HtmlNodeModifier | Interface for modifying HTML nodes in email templates |
CssNodeModifier | Interface for modifying CSS rules and properties |
MultiRowStructureModifier | Interface for creating and modifying email structure layouts |
ModificationDescription | Class for providing context about template modifications |
Node Interfaces
Base Node Interfaces
API | Description |
---|---|
BaseImmutableNode | Common interface for all immutable nodes |
BaseImmutableHtmlNode | HTML-specific base with type casting method |
BaseImmutableCssNode | CSS-specific base with type casting and comment checking |
HTML Node Interfaces
API | Description |
---|---|
ImmutableHtmlNode | Base interface for immutable HTML nodes |
ImmutableHtmlElementNode | HTML elements with attributes, styles, and methods |
ImmutableHtmlTextNode | Text content nodes |
CSS Node Interfaces
API | Description |
---|---|
ImmutableCssNode | Base interface for immutable CSS nodes |
ImmutableCssRuleNode | CSS rules with selectors |
ImmutableCssAttributeNode | CSS properties/attributes |
ImmutableCssCommentNode | CSS comments |
ImmutableCssDocumentNode | Document and media query containers |
Types and Interfaces
API | Description |
---|---|
AIPopoverOptions | Configuration for AI-assisted popovers |
BlockHint | Configuration for block hints and tooltips |
BlockItem | Configuration for block items in panels |
CustomFontFamily | Configuration for custom font families |
DisplayCondition | Configuration for conditional element visibility |
EmojiPopoverOptions | Configuration for emoji picker popovers |
StructureLayout | Type for defining container layouts in structures |
Constants and Enums
API | Description |
---|---|
AiAssistantValueType | Enum for AI assistant value types |
BlockAttr | Enum for block attribute constants |
BlockCompositionType | Enum defining block composition types |
BlockType | Enum for block type definitions |
ContextActionType | Enum for context action type definitions |
EditorStatePropertyType | Enum for observable editor state properties |
PanelPosition | Enum for defining panel positioning options |
PreviewDeviceMode | Enum for preview device mode settings |
SettingsTab | Enum for settings tab definitions |
UEAttr | Enum for UI element attribute constants |
UIElementType | Enum for UI element type definitions |
Integrations
API | Description |
---|---|
ExternalAiAssistant | Interface for integrating external AI assistants |
ExternalDisplayConditionsLibrary | Interface for integrating external display condition systems |
ExternalImageLibrary | Interface for integrating external image libraries |
ExternalSmartElementsLibrary | Interface for integrating external smart elements libraries |
ExternalVideosLibrary | Interface for integrating external video libraries |
Settings Panel
API | Description |
---|---|
SettingsPanelRegistry | Registry for managing settings panel tabs |
SettingsPanelTab | Base class for creating custom settings panel tabs |
Icons Management
API | Description |
---|---|
IconsRegistry | Registry for managing custom SVG icons in extensions |
UI Elements
API | Description |
---|---|
UIElement | Base class for creating custom UI elements |
UIElementTagRegistry | Registry for managing custom UI element tags |