Skip to content

Interface: DesignEditorProps

@fastlabai/design-editor


@fastlabai/design-editor / DesignEditorProps

Defined in: components/DesignEditor.tsx:558

Props for the top-level DesignEditor component.

optional backgroundRemovalProvider?: BackgroundRemovalProvider

Defined in: components/DesignEditor.tsx:574

Background removal provider. Defaults to @imgly/background-removal if installed.


optional className?: string

Defined in: components/DesignEditor.tsx:578

Optional className applied to the editor root for outer styling.


optional fontProvider?: FontProvider

Defined in: components/DesignEditor.tsx:572

Font provider. Defaults to a Google Fonts provider.


optional initialScene?: any

Defined in: components/DesignEditor.tsx:560

A serialized scene to load on mount, or any scene-shaped object with optional canvasBg/workspaceBg.


optional libraryPanel?: LibraryPanelRenderProp

Defined in: components/DesignEditor.tsx:582

Custom render override for the Upload/Library panel — useful to inject host-app media library UI.


optional onBack?: () => void

Defined in: components/DesignEditor.tsx:564

Called when the user clicks the back button in the toolbar.

void


optional onExport?: (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.

Blob

"svg" | "png" | "jpg"

IScene

void | Promise<void>


optional persistenceProvider?: PersistenceProvider

Defined in: components/DesignEditor.tsx:576

Autosave/scene persistence provider. Defaults to a localStorage provider.


optional sceneKey?: string

Defined in: components/DesignEditor.tsx:562

Stable key identifying the scene for persistence; passed to the persistence provider.


optional templateProvider?: TemplateProvider

Defined in: components/DesignEditor.tsx:568

Template provider. Defaults to a small bundled starter set.


optional templatesPanel?: TemplatesPanelRenderProp

Defined in: components/DesignEditor.tsx:580

Custom render override for the Templates panel — useful to inject host-app template UI.


optional textDesignProvider?: TextDesignProvider

Defined in: components/DesignEditor.tsx:570

Text design provider. Defaults to the bundled text designs set.


optional title?: ReactNode

Defined in: components/DesignEditor.tsx:584

Optional title to display in the toolbar. Defaults to “FastlabAI Design Studio”.