@spree/dashboard-core/src/....
@spree/dashboard-core
Default-import surface for plugins and customizations.
Plugin facade
Registries
add/remove/update-style mutators. See the per-feature pages for examples — form fields and custom field components are covered in the custom form field recipe.
Components
Hooks
Helpers
SDK client
@spree/admin-sdk instance configured for the host’s API URL. Use this everywhere instead of constructing your own.
The package entry point loads the whole framework — every registry, component and translation. A small host app that builds its own screens and only needs the client and sign-in can import from subpaths instead, which keeps the rest out of its bundle:
Providers
Vite plugin
@source directives for their CSS. See Distributing for the host wiring.
@spree/dashboard-ui
Design system primitives. Headless — accept data via props, never reach for providers or hooks.
shadcn-style primitives
import { toast } from 'sonner' — while <Toaster> (the mount point, already rendered by the app shell) is the only part re-exported here.
Composed components
Higher-level pieces that bundle multiple primitives but still take data via props:Empty* composes via children (icon in <EmptyMedia>, actions in <EmptyContent>) rather than taking title/description props.
Utilities
@spree/dashboard
The app shell, and the single import a host application needs. It re-exports everything from @spree/dashboard-core and @spree/dashboard-ui, so code in your own dashboard app never has to work out which package an export lives in:
@spree/dashboard-core and never renders the shell, so importing the shell would pull the whole app into a package meant to plug into it.
The host (the dashboard-starter project, or a create-spree-app project) is also what mounts the admin:
Dashboard— the app shell component (provider stack + router). Render it with a router:<Dashboard router={router} />.createDashboardRouter(routeTree)— builds the router from the host’s generatedrouteTree.gen.ts(the shell’s routes composed with every installed plugin’s file routes). The starter’smain.tsxwires these together; you rarely write this by hand.
<Dashboard />, can reuse the dashboard’s building blocks one module at a time without pulling in the app shell:
@spree/dashboard-core, so they render translated as soon as its i18n instance is loaded.
A plugin page that works on an order in its own layout — a quote over a draft order, say — reuses the order page’s building blocks from one subpath:
DiscountsCard, OrderSummaryCard, TagsCard, SpecialInstructionsCard, InternalNoteCard), CompanyComboboxOption for rendering the company picker’s options, and useOrderMutation for a save that refreshes the order.
useOrderItemsEditor(order) returns the form and fields the table renders, items for the totals card, stageVariant for the picker’s onSelect, and save(values) / discard(). Nothing reaches the server until save, which resolves true once the lines are saved and re-baselines the form on the saved order. Once the order has loaded, render OrderTotalsCard against savedOrder ({savedOrder && <OrderTotalsCard order={savedOrder} items={items} />}) — it follows the save even before your order refreshes — and lock the editing controls while isSaving (<OrderEditItemsTable disabled={isSaving} />, and the button that opens the picker): the save replaces the form when it finishes. Their copy lives in @spree/dashboard’s locales, which the dashboard loads, so they render translated on any page the dashboard routes to.
A few names exist in both re-exported packages — the design system ships a presentational component and the framework wraps it with data (ResourceCombobox, StatusCard, Slot, DateRange, ResourceMultiAutocomplete). The facade gives you the framework’s version, which is the one an application wants. Reach past it when you want the presentational half:
@spree/dashboard pins your code to the deployable app’s version, which is what a host app wants and what a distributed plugin must avoid.
What about @spree/admin-sdk?
The Admin API client is a separate package and a public dependency. Import types and SpreeError from it directly:
adminClient instance, by contrast, comes from @spree/dashboard-core so the host owns the configured singleton.
Stability
Anything on this page is covered by semver from@spree/dashboard-core 1.0.0 onward. Pre-1.0 we may rename, but we’ll call breaking moves out in the changelog.
Anything not listed here is internal. If you find yourself wanting it, open a discussion — it’s a sign we should promote it to the public surface.
Reference
packages/dashboard-core/src/index.ts— canonical export listpackages/dashboard-ui/src/index.tspackages/admin-sdk/src/index.ts

