Classes#
| Class | Description |
|---|---|
| ActionsAPI | ActionsAPI provides a centralized way to manage and customize actions for various user interactions in the Creative Engine SDK. |
| CreativeEditorSDK | The main entry point for the Creative Editor SDK. |
| FeatureAPI | Controls the availability of features within the Creative Editor SDK. |
| InternationalizationAPI | Manages localization and internationalization settings for the Creative Editor SDK. |
| KeyboardShortcutsAPI | cesdk.shortcuts — the editor-facing keyboard shortcut API. |
| UserInterfaceAPI | Control the user interface and behavior of the Creative Editor SDK. |
| UtilsAPI | UtilsAPI provides utility functions for common operations in the Creative Engine SDK. |
Functions#
| Function | Description |
|---|---|
| isGlobPattern | Checks if a string is a glob pattern (contains *). |
| matchGlob | Matches a value against a glob pattern. |
| useOrderContext | Hook for reading and setting order context for a UI area. |
Type Aliases#
| Type Alias | Description |
|---|---|
| ActionFunction | Type helper for retrieving the correct action function type based on the action ID. Returns the strongly-typed action for known actions, or a custom action type for unknown IDs. |
| ActionId | Available action event types that can be registered with the ActionsAPI. These correspond to different UI actions that can be customized. Supports both predefined action types from the Actions interface and custom string identifiers. |
| AnyUILocationOptions | Union type for location options. Resolves to the appropriate options type based on area-specific requirements. |
| AssetEntryId | Asset library entry IDs that can be used with asset library APIs. Includes built-in entry IDs registered by the SDK, and allows custom entry IDs. |
| AssetLibraryDockComponent | Represents an asset library dock component. |
| AssetLibraryEntryInput | A reference to an asset library entry to display. Either an entry ID, or an object that names the entry plus source IDs to hide for this display only — for example a replace panel that shows a library with a non-applicable source hidden (the text “Styles” panel shows ly.img.text but hides its text-combinations source). This per-display excludeSourceIds is distinct from the entry’s own includeGroups/excludeGroups, which apply wherever the entry is shown. |
| AssetLibraryPanelPayload | Represents the payload for the asset library panel in the Creative Editor SDK. This interface defines the title, entries, and placement options for the asset library panel. |
| BuilderRenderFunction | Function that defines a component with the help of the passed builder object. |
| CanvasBarComponentId | Represents the ID of a canvas bar component. |
| CanvasMenuComponentId | A list of the component IDs that can be used in the canvas menu. |
| CanvasMenuComponents | - |
| CanvasMenuOrderComponent | - |
| CaptionPanelComponentId | Represents the ID of a caption panel component. |
| ChildrenOrder | Represents the order of children components in a dropdown. |
| ClipContextMenuComponentId | Represents the ID of a video clip menu component. |
| ComponentGlobPattern | A glob pattern for matching component IDs. |
| ComponentId | Represents the ID of a component. |
| ComponentIdFor | Maps UI areas to their component ID types. |
| ComponentMatcher | Unified component matcher type supporting all matching strategies. |
| ComponentSpec | Specifies a component either by ID or as a full component object. |
| ComponentSpecOrArray | Specifies one or more components for insertion. |
| Configuration | Represents the user-provided configuration for the Creative Editor SDK. This type allows for partial configuration settings, making all properties optional. |
| CopyAction | Action function for copying selected blocks to the clipboard |
| CustomActionFunction | A generic action function type for custom actions. Supports both synchronous and asynchronous implementations with flexible parameters. |
| CustomPanelMountFunction | Represents a function that mounts a custom panel. |
| DeleteAssetAction | Action function for deleting an asset from an asset source. |
| DialogAction | Represents an action in the dialog. |
| DialogBackdrop | Represents the backdrop style for the dialog. |
| DialogContent | Represents the content of the dialog. |
| DialogProgress | Represents the progress of the dialog. |
| DialogSize | Represents the size of the dialog. |
| DialogType | Represents the type of dialog. |
| DockOrderComponent | Represents a dock order component. |
| DockOrderComponentId | Represents the ID of a dock order component. |
| DockPosition | Valid positions for the dock: 'left', 'right', or 'bottom'. |
| EditorCheckBrowserSupportAction | Action for checking browser capabilities at editor startup. Idempotent: only runs checks once per editor lifetime. |
| EditorPluginContext | Represents the context for an editor plugin. This type extends the EnginePluginContext with an optional cesdk property. |
| ExportAction | Action function for handling export operations. Can be called with or without options to customize the export behavior. Supports both standard and video export workflows through a generic type parameter. The return type is automatically inferred based on the input options type. |
| ExportSceneAction | Action function for handling scene export operations. |
| FeatureId | All built-in CE.SDK Feature Ids. |
| FeaturePredicate | The feature predicate is used to enable or disable a feature based on the boolean or the return value of the function. |
| FeaturePredicateContext | Represents the context for enabling a feature. This type extends IsEnabledFeatureContext and includes a function to check the previous enable state and a function to get the default predicate. |
| FileMimeType | Represents the MIME types for files supported by the file operations in UtilsAPI. |
| GetOrderOptions | Options for getting component order. Only single area queries are supported to ensure type-safe returns. |
| GlobPattern | A glob pattern string for matching UI areas or component IDs. Supports * as a wildcard. |
| GroupEnterOrExitAction | Action function for entering or exiting the selected group. |
| HistoryRedoAction | Action function for redoing the last undone editor operation. |
| HistoryUndoAction | Action function for undoing the last editor operation. |
| ImportSceneAction | Action function for handling scene import operations. |
| InferComponentType | Infers the component type from a UI area specifier. - Single area: returns area-specific component type - Array of areas: returns union of component types - Glob pattern: returns base OrderComponent (all IDs) |
| InferOrderContext | Infers the order context type from a UI area specifier. - Single area: returns area-specific context type - Array of areas: returns union of context types - Glob pattern: returns base OrderContext (all areas) |
| InsertComponentOptions | Options for inserting a component into a UI area. Supports mutual exclusion: only one of before, after, or position can be specified. Positional areas (like canvas bar) require the at property to specify which slot. |
| InsertOrderComponentLocation | Represents the location for inserting an order component. |
| InspectorBarComponentId | Represents the ID of an inspector bar component. |
| IsEnabledFeatureContext | Represents the context for determining if a feature is enabled. This type includes the CreativeEngine instance. |
| KeyboardKey | W3C standard keyboard key values Reference: https://www.w3.org/TR/uievents-key/ |
| KeyboardSequence | Type alias for keyboard sequences (for backward compatibility) |
| KeyboardShortcutContext | Context passed to a shortcut’s run and when callbacks. |
| LoadingComponent | Represents a loading indicator component. |
| LoadingOrder | Order type for loading indicator components. |
| LocaleKey | Represents the supported locale keys for the Creative Editor SDK. |
| MultiAreaRemoveResult | Result of a multi-area remove operation. |
| MultiAreaUpdateResult | Result of a multi-area update operation. |
| NavigationBarComponentId | A list of the component IDs that can be used in the navigation bar. |
| NavigationBarComponents | - |
| NavigationBarOrderComponent | - |
| NotificationDuration | Represents the duration of the notification. |
| NotificationType | Represents the type of notification. |
| NudgeAction | Action function for nudging the current selection in one direction. |
| OnExportOptions | This interface extends the base ExportOptions with additional information about the export, including which design blocks were exported and the mimeType. |
| OnExportVideoOptions | This interface extends the base VideoExportOptions with additional information about the export, including which design blocks were exported and the mimeType. |
| OnUnsupportedBrowserAction | Action function that is invoked when an unsupported browser is detected. This allows custom handling of unsupported browser scenarios. |
| Optional | Turn value at K of T into a Partial |
| OrderComponentFor | Maps UI areas to their order component types. |
| OrderComponentMatcher | Represents a matcher for order components. |
| OrderContextFor | Maps a UI area to its appropriate order context type for public API usage. - Caption panel uses CaptionPanelOrderContext (adds view property) - Video clip menu uses VideoClipMenuOrderContext (adds clipType) - All other areas use OrderContext (editMode only) |
| PageAssetReference | Reference to a page preset from an asset source. |
| PageDimensions | Direct page dimensions specification. |
| PageFormatDefinition | Represents the definition of a page format in the Creative Editor SDK. This interface defines the width, height, unit, and optional fixed orientation for a page format. |
| PageResizePanelPayload | Represents the payload for the page resize panel in the Creative Editor SDK. |
| PageSelectNextAction | Action function for selecting the next page. |
| PageSelectPreviousAction | Action function for selecting the previous page. |
| PageSpec | A page can be specified as direct dimensions, an asset source reference, or an asset object (e.g., from engine.asset.fetchAsset()). All variants optionally accept a color to set the page fill color. |
| PanelDisposer | Represents a function that disposes of a panel. |
| PanelId | Represents a unique identifier for a panel in the Creative Editor SDK. This type defines specific panel IDs and allows for custom panel IDs. |
| PanelOptions | Represents the options for a panel in the Creative Editor SDK. This interface defines the options for a panel, including whether it is closable by the user, its position, whether it is floating, and its payload. |
| PanelPayload | Represents the payload for a panel in the Creative Editor SDK. This type defines the payload based on the panel ID. |
| PanelPosition | This type is used to specify the position of various panels within the user interface, such as the inspector, settings, and asset library panels. |
| PasteAction | Action function for pasting blocks from the clipboard |
| PositionalUIArea | UI areas where at is required to specify a slot. |
| PositionFor | Maps positional UI areas to their valid at values. |
| PreviewType | Represents a preview, which can be either an image or a color. |
| PreviewTypeColor | Represents a color preview. |
| PreviewTypeImage | Represents an image preview. |
| SaveSceneAction | Action function for handling scene saving operations. |
| SceneCreateAction | Action for creating a new scene with configurable mode and page sizes. Returns the scene block ID. |
| SceneCreateOptions | Options for creating a new scene. |
| ScrollToBlockAction | Action function for scrolling to a specific block |
| ScrollToPageAction | Action function for scrolling to a specific page |
| SelectionAllAction | Action function for selecting all blocks on the current page. |
| SelectionDeleteAction | Action function for deleting every selected block. |
| SelectionDuplicateAction | Action function for duplicating every selected block. |
| SelectionGroupAction | Action function for grouping selected blocks. |
| SelectionParentOrDeselectAction | Action function for selecting the parent group of the current selection, or deselecting and refocusing the document when no eligible parent exists. |
| SelectionSplitAction | Action for splitting the first selected clip at the playhead |
| SelectionUngroupAction | Action function for ungrouping any selected group block. |
| SetOrderOptions | Options for setting component order. Single area only for type safety with area-specific component types. |
| ShareSceneAction | Action function for handling scene sharing operations. |
| ShortcutScopeId | The active uiScope of a keyboard-shortcut keypress. Resolves to: |
| Suffix | Represents additional options for a button, which can be used as a suffix. |
| TextToggleBoldAction | Action function for toggling bold on selected text. Branches on the engine edit mode internally. |
| TextToggleItalicAction | Action function for toggling italic on selected text. Branches on the engine edit mode internally. |
| TextToggleStrikethroughAction | Action function for toggling strikethrough on selected text. |
| TextToggleUnderlineAction | Action function for toggling underline on selected text. |
| TimelineCollapseAction | Action function for collapsing the video timeline. |
| TimelineExpandAction | Action function for expanding the video timeline. |
| TimelineZoomInAction | Action function for zooming in the video timeline by one step. |
| TimelineZoomOutAction | Action function for zooming out the video timeline by one step. |
| TimelineZoomResetAction | Action function for resetting the video timeline zoom to default level (1.0). |
| TimelineZoomToFitAction | Action function for fitting the video timeline to show all content. |
| TimelineZoomToLevelAction | Action function for setting the video timeline zoom to a specific level. |
| ToggleUserInterfaceVisibilityAction | Action function for toggling the editor’s user interface visibility. |
| UIArea | Represents a UI area where components can be ordered. |
| UIAreaContext | UI area-specific context - excludes base OrderContext properties (like editMode) that are read-only and derived from the engine. |
| UIAreaSpecifier | Specifies which UI area(s) to target. Can be a single area, an array of areas, or a glob pattern. |
| UnknownPanelPayload | Represents an unknown payload for a panel in the Creative Editor SDK. This type defines a generic payload with unknown keys and values. |
| UnknownTranslations | Allows for custom translation keys beyond the built-in ones. |
| UnsupportedCapabilityBehavior | Behavior for a browser capability check at editor startup. - 'block': Show a blocking error dialog (no dismiss) - 'warn': Show a dismissible warning dialog - 'ignore': Skip the check entirely |
| UpdateSpec | Specifies an update either as a new ID, partial update, or updater function. |
| UploadAction | Action function for uploading files to asset sources. |
| VectorPathDeleteNodeOrPointAction | Action function for deleting the selected vector node or control point. |
| VideoClipType | The type of clip in the video timeline. - 'clip' — clips on the main (background) track - 'overlay' — clips on overlay tracks above the main track - 'caption' — caption clips |
| VideoDecodeCheckSupportAction | Action function for checking video decoding/playback support. Returns true if WebCodecs APIs are available for video decoding and playback. Shows a blocking error dialog if not supported (unless dialog is disabled). |
| VideoEncodeCheckSupportAction | Action function for checking video encoding/export support. Returns true if H.264 video encoding and AAC audio encoding are supported. Shows a warning dialog if not supported (unless dialog is disabled). |
| VideoPlayPauseAction | Action function for toggling play/pause on the current page. |
| VideoSupportDialogOptions | Dialog display options for video support check actions. Allows configuring whether and how the dialog is displayed. |
| ViewStyle | Represents the view style options in the Creative Editor SDK. This type defines the possible view styles, which are ‘advanced’ and ‘default’. |
| ZoomInAction | Action function for zooming in by one step |
| ZoomOutAction | Action function for zooming out by one step |
| ZoomToBlockAction | Action function for zooming to a specific block |
| ZoomToFitAction | Action function for zooming to fit the current page in the viewport. |
| ZoomToLevelAction | Action function for setting zoom to a specific level |
| ZoomToPageAction | Action function for zooming to a page with optional padding |
| ZoomToSelectionAction | Action function for zooming to the current selection |
Interfaces#
| Interface | Description |
|---|---|
| AssetLibraryEntry | Represents an entry in the asset library, combining data and view configurations. |
| BaseInsertOptions | Options for inserting components into a UI area. |
| BasePositionalInsertOptions | Options for inserting components into a positional UI area (e.g., canvas bar). |
| Builder | Interface for all available builder. Depending on the context different implementation might be used. A “Button” in the canvas menu might render different component than a button in the topbar or a panel. |
| BuilderRenderFunctionContext | Represents the context for rendering a builder function. |
| BuiltinTranslations | Built-in translation keys provided by the Creative Editor SDK. |
| ButtonGroupOptions | Represents options for a button group. |
| ButtonOptions | Represents options for a button. |
| CanvasBarLocationOptions | Location options specifically for the canvas bar, which requires a position. |
| CanvasMenuActionButton | Base interface for action buttons in the canvas menu. Contains common properties shared across all canvas menu button types. |
| CanvasMenuCustomActionButton | Interface representing a custom canvas menu action button. Note: This component requires a key and has a required label, unlike other action buttons. |
| CanvasMenuOptionsComponent | Interface representing the canvas menu options dropdown component. This component can contain children components that are rendered in a dropdown menu. |
| CaptionPanelOrderContext | Context for the caption panel which adds view-based filtering. |
| CESDKConfiguration | Represents the configuration settings for the Creative Editor SDK. This interface defines various settings such as locale, theme, development mode, user interface, internationalization, accessibility, callbacks, feature flags, and logger. |
| CheckboxOptions | Represents options for a checkbox. |
| ClipContextMenuCustomAction | Interface representing a generic custom action in the clip context menu. Requires a key to uniquely identify the action and a label for display. |
| ColorInputOptions | Represents options for a color input. |
| ComponentMatchOptions | Options for update and remove operations. Supports multi-area operations via arrays or glob patterns. |
| ComponentOptions | Represents options for a component. |
| ComponentPayload | Represents the payload of a component. |
| CustomDockComponent | Represents a custom dock component. |
| Dialog | Represents a dialog configuration. |
| DockLocationOptions | Location options specifically for the dock, which supports an optional position. |
| DropdownChildrenContext | Represents the context for the children of a dropdown. |
| DropdownOptions | Represents options for a dropdown. |
| EditorPlugin | Represents an editor plugin. This interface defines the structure of an editor plugin, including its name, version, and initialization function. |
| EngineErrorMessage | Customer-facing copy resolved from a thrown engine error. |
| ExportOptions | Specifies options for exporting design blocks to various formats. |
| HeadingOptions | Represents options for a heading. |
| InputOptions | Represents options for an input. |
| InsertAfterOptions | Insert after a matched component. |
| InsertAppendOptions | Append to end (default behavior). |
| InsertAtPositionOptions | Insert at a specific position. |
| InsertBeforeOptions | Insert before a matched component. |
| InsertResult | Result of an insert operation. |
| KeyboardShortcut | Unified keyboard shortcut definition |
| LibraryOptions | Represents options for a library. |
| MediaPreviewOptions | Represents options for a media preview. |
| NavigationBarActionButton | Base interface for action buttons in the navigation bar. Contains common properties shared across all action button types. |
| NavigationBarCustomActionButton | Interface representing a generic Action Button in the navigation bar component. Note: This component requires a key and has a required label, unlike other action buttons. |
| Notification | Represents a notification configuration. |
| NumberInputOptions | Represents options for a number input. |
| OrderComponent | Represents an order component. |
| OrderComponentWithChildren | Represents a custom dock component. |
| OrderContext | Context for ordering components. Contains editMode which is used by most UI areas. |
| PositionalInsertAfterOptions | Insert after a matched component (positional areas). |
| PositionalInsertAppendOptions | Append to end (positional areas). |
| PositionalInsertAtPositionOptions | Insert at a specific position (positional areas). |
| PositionalInsertBeforeOptions | Insert before a matched component (positional areas). |
| RegisteredActions | Represents a collection of action functions used throughout the application. Each property corresponds to a specific UI action or event that can be customized. |
| RemoveResult | Result of a remove operation on a single area. |
| ReplaceAssetLibraryEntriesContext | Provides context for replacing asset library entries, including the selected blocks and the default entries (each may carry per-entry source exclusions). |
| SectionOptions | Represents options for a section. |
| SelectOptions | Options for a select input. |
| SelectValue | Represents a value for a select input. |
| SliderOptions | Represents options for a slider. |
| SpinnerOptions | Represents options for a loading spinner. |
| TextAreaOptions | Represents options for a text area. |
| TextInputOptions | Represents options for a text input. |
| TextOptions | Represents options for text. |
| Translations | Complete translation type that includes both built-in and custom translations. |
| UILocationOptions | Location options for non-positional UI areas. |
| UpdateResult | Result of an update operation on a single area. |
| UserInterface | Specifies the configuration for the user interface of the Creative Editor SDK. |
| VideoClipMenuOrderContext | Context for the clip context menu which adds clip type filtering. |
Namespaces#
| Namespace | Description |
|---|---|
| ConfigTypes | - |
| ExperimentalBuilder | Namespace containing experimental features for the builder. These features are subject to change and may not be stable for production use. |
| ExperimentalUserInterfaceAPI | Provides experimental methods for controlling the UI of the Creative Editor SDK. |
| UserInterfaceElements | - |
Variables#
| Variable | Description |
|---|---|
| AddImageOptions | - |
| CANVAS_SHORTCUT_SCOPE | - |
| EDITOR_SHORTCUT_SCOPE | - |
| - | |
| VIDEO_TIMELINE_SHORTCUT_SCOPE | - |