dartvel_ui
library
Classes
AlgoliaSearchProvider <TModel , TFacets >
Algolia query endpoint.
Analytics
Analytics manager supporting multiple providers
AnalyticsEvent
AnalyticsProvider
AnthropicDVAIAdapter
Talks to the Anthropic Messages API (POST /v1/messages).
AuthProvider
Authentication provider
AuthUser
User model
BillingPlan
CustomTransitionPage <T >
Page with custom transition functionality.
DartvelLayout
DartvelPage
DartvelRouteState
DartvelSeo
DV
DVAccessibility
DVAccessibilityCheck
DVAccessibilityReport
DVAI
DVAIAdapter
DVAIAgentRequest
DVAIAgentResult
DVAIToolDefinition
A registered AI tool: the handler plus the description and JSON Schema a
provider needs in order to decide when to call it.
DVAIToolEntry
DVAIToolRegistry
DVAITranscript
DVAndroidBindings
The Android bindings, unavailable here.
DVAppKey
The application key: generated once per install and per user, used to
encrypt what Dartvel stores at rest on a device.
DVAppKeyCipher
AES-256-GCM over the application key.
DVAppKeySharedStoreCipher
AES-256-GCM under the application key.
DVAppKeyStore
Where the application key is kept.
DVAuth
DVAuthAuthorization
DVAuthProvider
DVAuthUser
DVAwsCredentials
DVAwsSigV4
Signs requests with AWS Signature Version 4.
DVBilling
DVBillingCheckoutSession
DVBillingProvider
DVBiometrics
DVBluetooth
DVBox <T >
DVBrowserExtension
DVCache
DVCacheAdapter
Storage behind DV.Cache. Expiry is the adapter's responsibility: a read
of an expired key must behave exactly like a read of a missing key.
DVCacheAdmin
The cache and tag explorer: which tags exist, what they cover, and a way
to revalidate one.
DVCacheLock
A held cache lock. Release it when the guarded work completes.
DVCacheTags
DVCamera
DVClassWidget
A Dartvel page widget represented as a class.
DVClipboard
DVContacts
DVContext
The context handed to a DV.transaction body and to backend functions.
DVContextLifecycle
Lifecycle signals scoped to a single context.
DVContrastCheck
DVCronEntry
DVDatabase
The database facade behind DV.Database.
DVDatabaseAdapter
DVDatabaseCacheAdapter
Cache backed by a DVDatabaseAdapter , so cache entries survive process
restarts and can share the application's database.
DVDatabaseQueueAdapter
Queue storage backed by a DVDatabaseAdapter , so dispatched jobs survive a
process restart. With SQLite this is the durable local queue the spec calls
for, sharing one database file with the application and cache.
DvDataLoader
DvDataScope
DVDeepLinks
DvDefaultError
DvDefaultLoading
DVDerivedSignal <T >
A signal produced by operating on other signals.
DVDeviceControls
DVDeviceDiagnosticsBundle
DVDeviceHealth
DVDeviceProvisioningResult
DVDisplayControls
DVDisplayState
DVExportOptions <TModel >
DVExportResult
DVFiles
DVFileStorageAdapter
DVFleetProvisioningRequest
DVForm <T >
DVFormControls
DVFullscreenOptions
DVGlobalShortcut
DVHaptics
DVHardwareCapability
DVHardwareCapabilityManifest
DVHttpAIAdapter
DVHttpMailProvider
Shared behaviour for mail providers that speak HTTP.
DVHttpRequest
DVHttpResponse
DVHttpSearchProvider <TModel , TFacets >
Shared behaviour for hosted search services reached over HTTP.
DVI18n
DvI18n
DvI18nScope
DVImage
An image held by a model field.
DVImageView
Renders a DVImage model field.
DVImportChunk
DVImportResult <TModel >
DVImportRowError
DVInMemoryQueueAdapter
DVInMemorySearchProvider <TModel , TFacets >
A concrete local search provider for development, tests, and small apps.
DVIosBindings
The iOS bindings, unavailable here.
DVJob
Annotation for a durable background job.
DVJobEnvelope <TPayload >
DVJobPayload
Type-erased queue storage marker. User job payloads remain strongly typed
at dispatch and handler registration boundaries.
DVJobPayloadCodec <TPayload >
Converts a job payload to and from JSON so a durable queue can store it.
DVJobPayloadCodecs
Codecs that let DVDatabaseQueueAdapter persist job payloads.
DVJsonBool
DVJsonCodec
Converts between Dartvel's typed DVJsonValue tree and the plain
Object? tree that dart:convert produces and consumes.
DVJsonList
DVJsonMap
DVJsonNull
DVJsonNumber
DVJsonString
DVJsonValue
DVKioskOptions
DVLifecycleRegistry
The lifecycle signals reachable from DV.lifecycle.
DVLifecycleSignal <T >
A read-only reactive value.
DVLinuxBindings
The Linux desktop bindings, unavailable here.
DVLocalAuthProvider
Development and test auth adapter.
DVLocalBillingProvider
DVLocation
DVMacosBindings
The macOS bindings, unavailable here.
DVMailAddress
DVMailMessage
DVMailProvider
DVMedia
DVMemoryAppKeyStore
Holds the key for the lifetime of the process only.
DVMemoryCacheAdapter
Process-local cache. The default, and what DV.Cache used exclusively
before adapters existed.
DVMemoryFileStorageAdapter
Process-local storage. The default, and what DV.FileStorage used
exclusively before adapters existed.
DVMemoryMailProvider
DVMemoryNotificationProvider
DVMemorySharedStoreBackend
The default backend: in memory, with no cross-engine notification.
DVMiddleware
Annotation for backend function/page middleware.
DVMiddlewareKey
DVMiddlewares
DVModelAdmin <T >
Generated CRUD admin for one model.
DVModelChange <T >
One model change, as delivered to watchers.
DVModelSync
The model sync hub.
DVModelSyncTransport
Where sync events cross process boundaries.
DVModelWatch
A running Model.watch(...). Cancel it when the watcher goes away.
DVModifier
DVModule
A mounted Dartvel module.
DVModuleRegistry
The registry behind DV.Modules.
DVMutableLifecycleSignal <T >
The framework-facing half of a lifecycle signal.
DVNativeBridge
DVNavigation
Context-free navigation over the generated route targets.
DVNfc
DVNotificationMail
DVNotificationMessage
DVNotificationProvider
DVNotifications
DVNotificationsService
DVNullSharedStoreCipher
The default when no application key has been provided.
DVOAuth2Authorization
A started authorization. Hold this until the provider redirects back: the
state proves the callback belongs to this attempt and the
codeVerifier proves the exchange comes from whoever started it.
DVOAuth2Client
Drives the authorization-code flow with PKCE.
DVOAuth2Config
Endpoints and client identity for one identity provider.
DVOAuth2Tokens
DVObservabilityAndLogging
DVOutboxAdmin
The mail and notification outbox.
DVPageBundle
A set of page documents shipped together — the unit an OTA patch carries.
DVPageBundleInstaller
Applies page bundles delivered with a release or OTA patch.
DVPageDocument
A builder-editable page: a route, a title, and a widget tree.
DVPageDocumentEditor
The operations a drag-and-drop surface calls. UI gestures reduce to these
four; everything else in the builder is chrome around them.
DVPageDocumentRenderer
Renders a document as the real widgets it describes.
DVPageNode
One widget in a page document.
DVPageScaffoldSpec
DVPageShell
DVPageStore
Stores documents through DV.Database, WordPress-style: page content is
data, so saving is publishing.
DVPageUpdateResult
DVPasswordHasher
PBKDF2-HMAC-SHA256 password hashing.
DVPermissions
DVPlatform
DVPluralForms
DVPolicies
DVPolicy
Annotation for model/resource authorization policies.
DVPolicyAction
DVPolicyAdmin
The policy and permission explorer, and the model sync channel inspector.
DVPresence
Channel membership.
DVPresenceEvent
DVPresenceMember
One participant on a channel.
DVPresenceTransport
Carries presence between processes, the way DVModelSyncTransport carries
model changes. Without one, presence is per-process.
DVQueueAdapter
DVQueueAdmin
The queue and job dashboard: what is waiting, what has died, and the two
things an operator can do about a dead letter.
DVQueues
DVReadableSignal <T >
A reactive value that can be read, whether it stores its own state or is
derived from signals that do.
DVReportResult
DVRouteAdmin
The route and page explorer.
DVRouteInfo
One generated route, as the route explorer sees it.
DVRouteTarget
DVRust
DVRustInt
DVScheduledReport
DVScreen
DVSearchProvider <TModel , TFacets >
DVSearchResultPage <TModel >
DVSecrets
Reads secrets from the process environment.
DVSensors
DVSentNotification
DVShare
DVSharedStoreBackend
Where a shared value is actually kept, and how a change reaches another
window.
DVSharedStoreCipher
Encrypts values before they reach the backend.
DVShell
DVShellCommand
DVShellResult
DVShortcuts
DVSignal <T >
DVSmtpClient
DVSmtpConnection
One SMTP connection. The transport is abstracted so tests drive a scripted
conversation instead of opening a socket.
DVSqliteSearchProvider <TModel , TFacets >
Full-text search backed by SQLite's FTS5 extension.
DVStorage
DVStudioCanvas
The editing canvas.
DVStudioEditorController
Editing state for one page document: what is selected, what changed, and
how to undo it.
DVStudioInspector
Edits the selected node's properties.
DVStudioLeafType
A leaf node type the page builder can place.
Serves the Studio document for route when one exists, and fallback
otherwise.
DVStudioPalette
The draggable source list.
DVStudioPaletteItem
What the palette drags and the canvas accepts.
DVStudioProperty
DVStudioScreen
The Studio admin surface: the section switcher and the page builder,
assembled, plus whatever sections it is given.
DVStudioSection
A section in Studio's switcher.
DVTab
A tab is a route.
DVTabWorkspace
A tab strip and its content, composed from DVBox and DVText.
DVTabWorkspaceController
The state behind a tab strip: order, selection, tear-out and adoption.
DVTappableTargetCheck
DVTelemetryAdmin
Entitlements and recorded events.
DVTenants
Resolves a tenant from a request, and holds the tenant the current work is
running for.
DVTerminalSurface
The terminal an application is drawing into.
DVTestHarness
DVText
DVTheme
DVTransactionRunner
Runs reversible units of work.
DVTranslationCatalog
DVTranslationKey
DVTray
DVUnconfiguredSearchProvider <TModel , TFacets >
Fails loudly when a searchable model has no configured provider.
DVUpdateInfo
DVUpdates
DVUseMiddleware
Typed annotation for page, layout, model, storage, and backend middleware.
DVWebBindings
The browser bindings, unavailable here.
DVWindow
A window, real or virtual.
DVWindowingCapability
What a target can actually do with windows.
DVWindowManager
The window manager.
DVWindowOptions
DVWindowsBindings
The Windows bindings, unavailable here.
DVWindowSharedStore
Cross-window view state: which tab is active, tab order, layout, scroll
offsets, drafts.
DVWindowState
A window size worth restoring.
Entitlement
FirebasePushProvider
Firebase Cloud Messaging, HTTP v1.
GeminiDVAIAdapter
Talks to the Gemini generative-language REST API.
GoRoute
Get started
Configuration
Redirection
Transition animations
Named routes
A route that is displayed visually above the matching parent route using the
Navigator .
GoRouteData
Type-safe routes
A class to represent a GoRoute in
Type-safe routing .
GoRouteInformationParser
Converts between incoming URLs and a RouteMatchList using RouteMatcher.
Also performs redirection using RouteRedirector.
GoRouteInformationProvider
The RouteInformationProvider created by go_router.
GoRouter
Get started
Upgrading
Configuration
Navigation
Redirection
Web
Deep linking
Named routes
Error handling
The route configuration for the app.
GoRouterDelegate
GoRouter implementation of RouterDelegate .
GoRouterState
The route state during routing.
ImperativeRouteMatch
The route match that represent route pushed through GoRouter.push .
InheritedGoRouter
GoRouter implementation of InheritedWidget.
LocalAnalyticsProvider
In-memory analytics provider for local development and tests.
LocalAuthProvider
In-memory auth provider for local development and tests.
LocalDVAIAdapter
Deterministic in-process adapter for development and tests. It never reaches
the network, so tests cannot accidentally pass because a provider was
unreachable.
LocaleTag
MailgunMailProvider
Mailgun messages API. Unlike the others this is form-encoded, and it
authenticates with HTTP Basic using the literal user name api.
MeilisearchProvider <TModel , TFacets >
Meilisearch search endpoint. Paging is 1-based, matching Dartvel.
MemoryDVDatabaseAdapter
NoTransitionPage <T >
Custom transition page with no transition.
OllamaDVAIAdapter
Talks to a local Ollama runtime. The API key is optional and only sent when
the runtime is fronted by an authenticating proxy.
OpenAIDVAIAdapter
Talks to the OpenAI REST API. OpenRouterDVAIAdapter reuses this wire
format against a different host.
OpenRouterDVAIAdapter
OpenRouter exposes the OpenAI chat-completions wire format under its own
host. It does not serve embeddings or transcription.
OpenSearchProvider <TModel , TFacets >
OpenSearch and Elasticsearch, which share this query API.
PageTransitionSpec
PostmarkMailProvider
Postmark single-message send.
ResendMailProvider
Resend (https://resend.com ) transactional mail.
RouteBase
The base class for GoRoute and ShellRoute .
RouteBuilder
Builds the top-level Navigator for GoRouter.
RouteConfiguration
The route configuration for GoRouter configured by the app.
RouteData
Baseclass for supporting
Type-safe routing .
RouteInformationState <T >
The data class to be stored in RouteInformation.state to be used by
GoRouteInformationParser .
RouteMatch
An matched result by matching a GoRoute against a location.
RouteMatchBase
The base class for various route matches.
RouteMatchList
The list of RouteMatchBase objects.
RoutingConfig
Configuration
A set of parameters that defines routing in GoRouter.
S3FileStorageAdapter
S3 and S3-compatible object stores (AWS S3, Cloudflare R2, MinIO),
authenticated with AWS Signature Version 4.
SendGridMailProvider
SendGrid v3 mail send.
SeoProps
SesMailProvider
Amazon SES v2, signed with AWS Signature Version 4.
ShellRoute
Configuration
A route that displays a UI shell around the matching child route.
ShellRouteBase
Base class for classes that act as shells for sub-routes, such
as ShellRoute and StatefulShellRoute .
ShellRouteContext
Context object used when building the shell and Navigator for a shell route.
ShellRouteData
A class to represent a ShellRoute in
Type-safe routing .
ShellRouteMatch
An matched result by matching a ShellRoute against a location.
SmtpMailProvider
Sends through an SMTP server.
SqliteDVDatabaseAdapter
StatefulNavigationShell
Widget for managing the state of a StatefulShellRoute .
StatefulNavigationShellState
State for StatefulNavigationShell.
StatefulShellBranch
Representation of a separate branch in a stateful navigation tree, used to
configure StatefulShellRoute .
StatefulShellBranchData
Base class for supporting
StatefulShellRoute
StatefulShellRoute
Configuration
A route that displays a UI shell with separate Navigator s for its
sub-routes.
StatefulShellRouteData
Base class for supporting
StatefulShellRoute
TwilioSmsProvider
Twilio SMS.
TypedGoRoute <T extends GoRouteData >
A superclass for each typed go route descendant
TypedRoute <T extends RouteData >
A superclass for each typed route descendant
TypedShellRoute <T extends ShellRouteData >
A superclass for each typed shell route descendant
TypedStatefulShellBranch <T extends StatefulShellBranchData >
A superclass for each typed shell route descendant
TypedStatefulShellRoute <T extends StatefulShellRouteData >
A superclass for each typed shell route descendant
Enums
AuthFailure
Why an authentication attempt failed.
AuthState
Auth state
DVAppLifecycle
Application-level lifecycle states.
DVBuildLifecycle
Build pipeline lifecycle states, observed through DV.lifecycle.build.
DVCronTarget
DVImageSource
Where a DVImage 's bytes come from.
DVJobState
DVLaunchOutcome
What a dual-mode application should do at startup.
DVMailPriority
DVModelChangeKind
What happened to a model.
DVModelPageDataMode
How a generated Model.Page(...) resolves the data it renders.
The part a field plays in a generated model page, set by the field-scoped
@DVModel.featuredImage(), .pageTitle(), .mainContent() and
.hideFromPage() constructors.
DVModuleLifecycle
Module lifecycle states, observed through DV.Modules.<id>.lifecycle.
DVNotificationChannel
DVNotificationProviderKind
DVPageLifecycle
Page-level lifecycle states, observed through context.lifecycle.page.
DVPageUpdateOutcome
What a page bundle fetch resulted in.
DVPresenceEventKind
What happened on a channel.
DVRenderSurface
Where an application's frames are landing.
DVRequestLifecycle
Backend request lifecycle states, observed through
context.lifecycle.request.
DVStudioPropertyKind
How a document property is edited and applied.
DVTabExit
Why a tab left a workspace, so the caller can tell a tear-out from a close.
DVTenantIsolation
How tenant data is separated.
DVTenantSource
Where a request's tenant is read from.
DVTerminalGraphics
How faithfully a terminal can draw.
DVTransactionLifecycle
Transaction lifecycle states, observed through
context.lifecycle.transaction.
DvTransition
DVUpdateChannel
DVWindowDegradation
Why a request was presented as something other than a window.
DVWindowKind
What kind of surface was asked for.
DVWindowLifecycle
The lifecycle of a window, as a read-only signal the runtime owns.
DVWindowPresentation
How the request was actually presented.
NavigatingType
The type of the navigation.
Functions
dvDeviceTypeFor ({required String platform , required String breakpoint , bool isTV = false , bool isWatch = false , bool isWeb = false , bool isFoldable = false })
→ String
What kind of device this is.
dvIosHapticSoundId (String name )
→ int
The system sound identifier that produces a given haptic.
dvSendAIHttpRequest (DVAIHttpRequest request )
→ Future <DVAIHttpResponse >
dvSendHttpRequest (DVHttpRequest request )
→ Future <DVHttpResponse >
Sends request, walking its protocol chain until one succeeds.
dvStudioLeafTypeFor (DVPageNode node )
→ DVStudioLeafType ?
The leaf type node declares, or null when it is a layout box.
dvTransitionPage <T > ({LocalKey ? key , required Widget child , required PageTransitionSpec spec })
→ CustomTransitionPage <T >
dvWindowStateKey (String name )
→ String
The storage key for a named window.
parseDocumentColor (Object ? value )
→ Color ?
Reads a colour from a document property.
registerDVModelDeserializer <T > (DVModelDeserializer <T > deserializer )
→ void
Registers how a T is rebuilt from a JSON map.
registerDVModelFactory <T > (DVModelFactory <T > factory )
→ void
registerDVModelSerializer <T > (DVModelSerializer <T > serializer )
→ void
registerFormControlsFactory <T > (DVFormControlsFactory factory )
→ void
resolveLaunchSurface ({required Set <DVRenderSurface > linked , required List <String > arguments , required bool displayAvailable , bool interactive = true })
→ DVLaunchOutcome
Decides where a launch should start.
signal <T > (BuildContext context , T value )
→ DVSignal <T >
Typedefs
DVAccessTokenSupplier
= Future <String > Function()
Supplies a short-lived OAuth2 access token for a push service.
DVAIHttpRequest
= DVHttpRequest
Retained names for the shared HTTP seam, which now lives in
src/http/transport.dart so mail and other provider adapters share it.
DVAIHttpResponse
= DVHttpResponse
DVAIHttpSend
= DVHttpSend
DVAIToolHandler
= FutureOr <DVJsonValue > Function(DVJsonObject input )
DVFormControlsFactory
= DVFormControls Function(Object ? model , {void onReset ()?, void onSubmit ()? })
DVHttpSend
= Future <DVHttpResponse > Function(DVHttpRequest request )
DVJobHandler <TPayload >
= FutureOr <void > Function(TPayload payload )
DVJsonObject
= Map <String , DVJsonValue >
DVPolicyCheck <TUser , TResource >
= FutureOr <bool > Function(TUser user , TResource resource )
DVPublicPathsResolver
= Future <List <String > > Function()
Supplies the concrete parameter values a parameterized route needs during
static generation.
DVSearchDocument <TModel >
= String Function(TModel model )
DVSearchFacetFilter <TFacets >
= List <String > Function(TFacets? facets )
Builds provider filter expressions from typed facets. Meilisearch and
Algolia both express facets as filter strings, so this is where an
application maps its own facet type onto that syntax.
DVSearchFacetMatcher <TModel , TFacets >
= bool Function(TModel model , TFacets? facets )
DVSeo
= SeoProps
DVSmtpConnect
= Future <DVSmtpConnection > Function(String host , int port , {required bool secure })
DVStyleModifier
= DVModifier
DVWidgetBuilder <T >
= Widget Function(T item )
ExitCallback
= FutureOr <bool > Function(BuildContext context , GoRouterState state )
Signature for function used in RouteBase.onExit.
GoExceptionHandler
= void Function(BuildContext context , GoRouterState state , GoRouter router )
The function signature of GoRouter.onException.
GoRouterBuilderWithNav
= Widget Function(BuildContext context , Widget child )
Signature of a go router builder function with navigator.
GoRouterPageBuilder
= Page Function(BuildContext context , GoRouterState state )
The page builder for GoRoute .
GoRouterRedirect
= FutureOr <String ? > Function(BuildContext context , GoRouterState state )
The signature of the redirect callback.
GoRouterWidgetBuilder
= Widget Function(BuildContext context , GoRouterState state )
The widget builder for GoRoute .
NavigatorBuilder
= Widget Function(GlobalKey <NavigatorState > navigatorKey , ShellRouteMatch match , RouteMatchList matchList , List <NavigatorObserver > ? observers , String ? restorationScopeId )
Signature for functions used to build Navigators
ParserExceptionHandler
= RouteMatchList Function(BuildContext context , RouteMatchList routeMatchList )
The function signature of GoRouteInformationParser.onParserException .
PopPageWithRouteMatchCallback
= bool Function(Route route , dynamic result , RouteMatchBase match )
Signature for a function that takes in a route to be popped with
the result and returns a boolean decision on whether the pop
is successful.
RouteMatchVisitor
= bool Function(RouteMatchBase )
The function signature for RouteMatchList.visitRouteMatches
ShellNavigationContainerBuilder
= Widget Function(BuildContext context , StatefulNavigationShell navigationShell , List <Widget > children )
Builder for a custom container for the branch Navigators of a
StatefulShellRoute .
ShellRouteBuilder
= Widget Function(BuildContext context , GoRouterState state , Widget child )
The widget builder for ShellRoute .
ShellRoutePageBuilder
= Page Function(BuildContext context , GoRouterState state , Widget child )
The page builder for ShellRoute .
StatefulShellRouteBuilder
= Widget Function(BuildContext context , GoRouterState state , StatefulNavigationShell navigationShell )
The widget builder for StatefulShellRoute .
StatefulShellRoutePageBuilder
= Page Function(BuildContext context , GoRouterState state , StatefulNavigationShell navigationShell )
The page builder for StatefulShellRoute .