API reference
Choose a package or domain contract to look up.
Choose a package based on how much of the editor you want to build yourself. ProductEditor provides the complete interface; the other packages support custom interfaces, imperative rendering and non-React document operations.
| Package | Reference |
|---|---|
@react-fabrio/ui | ProductEditor props, UI panels and localization |
@react-fabrio/react | Providers, canvas, hooks and uploads |
@react-fabrio/core | Contracts, validation, commands, sessions and geometry |
@react-fabrio/fabric | Canvas mounting and production exports |
@react-fabrio/three | Optional mug preview options and lifecycle |
Domain contracts
- Product configuration: fields, defaults, permissions and validation.
- Saved design document: schema version, elements, assets and compatibility.
- Assets and fonts: resource requirements, SVG restrictions and gallery capacity.
- Previews: photograph mappings and mug parameters.
- Production output: PNG dimensions and metadata, SVG geometry and resource errors.
- Editor interactions: layout, controls, keyboard behavior and theme variables.
- Example products: exported fixtures and their resources.
The exported TypeScript declarations define exact parameter types. For setup instructions, use Embed the React editor.