Interface: DesignEditorProps
@fastlabai/design-editor / DesignEditorProps
Interface: DesignEditorProps
Section titled “Interface: DesignEditorProps”Defined in: components/DesignEditor.tsx:558
Props for the top-level DesignEditor component.
Properties
Section titled “Properties”backgroundRemovalProvider?
Section titled “backgroundRemovalProvider?”
optionalbackgroundRemovalProvider?:BackgroundRemovalProvider
Defined in: components/DesignEditor.tsx:574
Background removal provider. Defaults to @imgly/background-removal if installed.
className?
Section titled “className?”
optionalclassName?:string
Defined in: components/DesignEditor.tsx:578
Optional className applied to the editor root for outer styling.
fontProvider?
Section titled “fontProvider?”
optionalfontProvider?:FontProvider
Defined in: components/DesignEditor.tsx:572
Font provider. Defaults to a Google Fonts provider.
initialScene?
Section titled “initialScene?”
optionalinitialScene?:any
Defined in: components/DesignEditor.tsx:560
A serialized scene to load on mount, or any scene-shaped object with optional canvasBg/workspaceBg.
libraryPanel?
Section titled “libraryPanel?”
optionallibraryPanel?:LibraryPanelRenderProp
Defined in: components/DesignEditor.tsx:582
Custom render override for the Upload/Library panel — useful to inject host-app media library UI.
onBack?
Section titled “onBack?”
optionalonBack?: () =>void
Defined in: components/DesignEditor.tsx:564
Called when the user clicks the back button in the toolbar.
Returns
Section titled “Returns”void
onExport?
Section titled “onExport?”
optionalonExport?: (blob,format,scene) =>void|Promise<void>
Defined in: components/DesignEditor.tsx:566
Called when the user exports the design. Receives the rendered Blob, output format, and raw scene JSON.
Parameters
Section titled “Parameters”Blob
format
Section titled “format”"svg" | "png" | "jpg"
Returns
Section titled “Returns”void | Promise<void>
persistenceProvider?
Section titled “persistenceProvider?”
optionalpersistenceProvider?:PersistenceProvider
Defined in: components/DesignEditor.tsx:576
Autosave/scene persistence provider. Defaults to a localStorage provider.
sceneKey?
Section titled “sceneKey?”
optionalsceneKey?:string
Defined in: components/DesignEditor.tsx:562
Stable key identifying the scene for persistence; passed to the persistence provider.
templateProvider?
Section titled “templateProvider?”
optionaltemplateProvider?:TemplateProvider
Defined in: components/DesignEditor.tsx:568
Template provider. Defaults to a small bundled starter set.
templatesPanel?
Section titled “templatesPanel?”
optionaltemplatesPanel?:TemplatesPanelRenderProp
Defined in: components/DesignEditor.tsx:580
Custom render override for the Templates panel — useful to inject host-app template UI.
textDesignProvider?
Section titled “textDesignProvider?”
optionaltextDesignProvider?:TextDesignProvider
Defined in: components/DesignEditor.tsx:570
Text design provider. Defaults to the bundled text designs set.
title?
Section titled “title?”
optionaltitle?:ReactNode
Defined in: components/DesignEditor.tsx:584
Optional title to display in the toolbar. Defaults to “FastlabAI Design Studio”.