studio library
Dart Desk Studio - Complete CMS interface components
Classes
- BreadcrumbSegment
- A segment in the breadcrumb trail.
- CmsStatusPill
- Autosave / publish-state status pill shown in the document editor.
- DartDeskApp
- Entry point for Dart Desk CMS applications.
- DartDeskAuth
- A widget that provides authentication guard functionality using Serverpod's IDP authentication system with Google Sign-In and email/password support.
- DartDeskConfig
- Configuration for the DartDeskApp widget.
- DefaultDeskHeader
- Default header widget for CMS Studio
- DefaultDeskHeaderConfig
-
InheritedWidget that provides CMS header configuration (branding)
to descendant widgets like the top bar in
StudioShell. - DeskBorderRadius
- Standardized border radius values for the CMS studio.
- DeskBreadcrumbs
- Breadcrumb navigation trail for the CMS top bar.
- DeskBreakpoints
- CMS layout breakpoint names, used with ResponsiveBreakpoints.of(context).
- DeskButton
- Reusable button wrapping ShadButton with loading state support.
- DeskDocumentEditor
- Document editor widget that dynamically generates forms based on fields
- DeskDocumentListView
- Document list view for browsing multiple documents of a type
- DeskDocumentTypeSidebar
- A sidebar widget that displays document type navigation items.
- DeskFieldInputRegistry
- Registry of field types to their corresponding input widgets. Uses switch-case pattern for default field types with optional custom registry.
- DeskForm
- A form widget that renders fields based on DeskField list
- DeskMarionetteConfig
- Static Marionette configuration for the CMS Studio.
- DeskRatingField
- ColorField is now a built-in field type!
- DeskRatingInput
- Custom rating input widget
- DeskRatingOption
- DeskSpacing
- Standardized spacing values for the CMS studio.
- DeskStatusPill
- A small colored pill showing document/version status.
- DeskStudioApp
- The complete CMS Studio entry point.
- DeskThemeModeProvider
- Provides the theme mode signal to descendants.
- DeskThemeToggle
- A segmented pill toggle for switching between light and dark themes.
- DeskTopBar
- Persistent top bar for the CMS studio.
- DeskVersionHistory
- A version history dropdown component that displays an event-style timeline.
- DeskViewModel
- DocumentScreen
- DocumentScreenRoute
- generated route for DocumentScreen
- DocumentScreenRouteArgs
- DocumentTypeDecoration
- A decoration wrapper for DocumentType that includes visual elements like icons
- DocumentTypeItem
- A navigation item for a document type in the sidebar.
- DocumentTypeScreen
- DocumentTypeScreenRoute
- generated route for DocumentTypeScreen
- DocumentTypeScreenRouteArgs
- DraftEvent
- An autosave-draft event — emitted for any DocumentVersionStatus.draft version. Created by the backend's bucketed autosave (see spec 2026-05-03-version-history-autosaved-drafts-design.md).
- HistoryEvent
- Sealed base for all history timeline events.
- ImageHotspotEditor
- ImageTransformParams
- ImageUrl
- CDN transform wrapper around ImageReference.
- MediaBrowser
- MediaScreen
- MediaScreenRoute
- generated route for MediaScreen
- PublishedEvent
- A version publish event — emitted when a DocumentVersion transitions to DocumentVersionStatus.published.
- StudioConfig
- Holds CMS studio configuration data.
- StudioRouteObserver
-
Observes all navigation events in the Studio router and syncs the
DeskViewModel signals (selectedDocumentId, currentDocumentTypeSlug, etc.)
from
StudioRouter.topRoute.params. - StudioRouter
- StudioShellScreen
- StudioShellScreenRoute
- generated route for StudioShellScreen
- VersionScreen
- Thin wrapper so auto_route has a unique page for the version path. Rendering is identical to DocumentScreen.
- VersionScreenRoute
- generated route for VersionScreen
- VersionScreenRouteArgs
Enums
Properties
- deskStudioLightTheme → ShadThemeData
-
Light theme for the CMS studio
no setter
- deskStudioTheme → ShadThemeData
-
Default theme for the CMS studio (dark)
no setter
Functions
-
registerRatingField(
) → void - Register the custom rating field
Typedefs
- FieldInputBuilder = Widget Function(DeskField? field, DeskData? data, OnFieldChanged onChanged)
- Type definition for field input builder functions
- OnFieldChanged = void Function(String fieldName, dynamic value)
- Type definition for field value change callbacks
- TransformUrlBuilder = String Function(String publicUrl, ImageTransformParams params)