Type Aliases#
| Type Alias | Description |
|---|---|
| A11y | Represents the accessibility settings for the Creative Editor SDK. This type defines the heading hierarchy start level, which can be a number between 1 and 6. |
| Represents the callback functions for various events in the Creative Editor SDK. This interface defines functions for handling back, close, share, save, load, load archive, download, export, upload, and unsupported browser events. | |
| CombinedConfiguration | Represents the combined configuration for the Creative Editor SDK. This type combines the CESDKConfiguration with the EngineConfiguration while omitting the presets key. It also includes deprecated keys from the CESDKConfiguration. |
| I18n | Represents the internationalization settings for the Creative Editor SDK. This type defines a record of locale strings to translation objects. Note: this will append keys and not override keys. |
| OnUploadCallback | Represents the upload callback function for the Creative Editor SDK. This type defines a function that handles file uploads, including progress updates and context. |
| OnUploadOptions | Represents the options for the upload callback in the Creative Editor SDK. This type defines the supported MIME types for uploads. |
| Scale | Represents the base scale values for the Creative Editor SDK. This type defines the concrete scales that can be rendered. |
| ScaleConfig | Represents the scale configuration for the Creative Editor SDK. This can be a concrete scale or a function that returns a scale based on viewport properties. |
| ScaleFn | A function that returns a scale value based on viewport properties. This allows for dynamic scale selection based on runtime conditions. |
| Theme | Represents the base theme values for the Creative Editor SDK. This type defines the concrete themes that can be rendered. |
| ThemeConfig | Represents the theme configuration for the Creative Editor SDK. This can be a concrete theme, a function that returns a theme, or ‘system’ to use OS preference. |
| ThemeFn | A function that returns a theme value. This allows for dynamic theme selection based on runtime conditions. The function is evaluated lazily whenever the theme is accessed. |
Interfaces#
| Interface | Description |
|---|---|
| BleedMarginOptions | Represents the bleed margin configuration options for a single design unit type in the Creative Editor SDK. This interface defines the dropdown options and the default bleed margin value. |
| FontSizeOptions | Represents the font size configuration options in the Creative Editor SDK. This interface defines the dropdown options for font sizes. |
| UIOptionsForSingleDesignUnit | Represents the UI options for a single design unit type in the Creative Editor SDK. This interface defines the bleed margin options for a single design unit. |
| UIOptionsPerDesignUnit | Represents the UI options for different design units in the Creative Editor SDK. This interface defines the UI options for millimeters, pixels, and inches. |
| UploadCallbackContext | Represents the context for the upload callback in the Creative Editor SDK. This interface defines the source ID and an optional group for the upload context. |