Skip to main content

Type Alias: CanvicoEditorConfig

CanvicoEditorConfig = object

The main configuration object for the CanvicoEditor.

Properties​

clearCanvasButtonSelector​

clearCanvasButtonSelector: string

CSS selector for the button that clears the canvas and resets the editor.

containerSelector​

containerSelector: string

CSS selector for the element that will contain the editor's canvas.

imageFileInputSelector​

imageFileInputSelector: string

CSS selector for the file input used to load images.

logErrorsToConsole?​

optional logErrorsToConsole: boolean

Controls whether handled errors are printed to console. Defaults to true.

maxFileSizeMB?​

optional maxFileSizeMB: number

Optional maximum allowed file size in megabytes (MB).

modules?​

optional modules: ModuleConfig

Optional container for all module configurations.

onError?​

optional onError: CanvicoEditorErrorCallback

Optional callback to report handled runtime errors to host application.

resetEditsButtonSelector​

resetEditsButtonSelector: string

CSS selector for the button that resets the image to its original state.

saveButtonSelector​

saveButtonSelector: string

CSS selector for the button that saves/downloads the current image.

strictModuleSelectors?​

optional strictModuleSelectors: boolean

When true, invalid module selectors throw during initialization (fail-fast behavior). When false, invalid module selectors disable only the affected module and report the error through the editor error pipeline. Defaults to false.