flutter_mcp_ui_runtime library
Classes
- AccessibleFormField
- Form field with live validation announcements
- AccessibleProgressIndicator
- Progress indicator with live region announcements
- ActionHandler
- Handles action execution
- ApplicationDefinition
- Application definition according to spec
- AsyncValidator
- Async validator base class
- BackgroundServiceDefinition
- Background service definition
- BackgroundServiceManager
- Manages background services for the runtime
- BackgroundServiceRunner
- Runs a single background service
- BaseService
- Base implementation of Service
- ComponentLifecycleHandler
- Handles lifecycle events for individual components
- CompositeAsyncValidator
- Composite async validator that combines multiple validators
- ComputedProperty
- Represents a computed property that derives its value from other state according to MCP UI DSL v1.0 specification
- ConformanceChecker
- Checker for determining conformance level support
- CustomValidator
- Custom validator that uses expressions for validation according to MCP UI DSL v1.0 specification
- Debouncer
- Debouncer utility for performance optimization according to MCP UI DSL v1.0 specification
- DialogAction
- Represents an action in a dialog
- DialogService
- Service for managing dialogs, bottom sheets, and overlays
- ErrorBoundary
- Error boundary widget for catching and handling errors according to MCP UI DSL v1.0 specification
- ErrorRecovery
- Error recovery widget with multiple strategies
- ExamplePlugin
- Example plugin implementation
- ExampleWidgetFactory
- Example widget factory for the plugin
- FocusGroup
- Focus group for managing related focus nodes
- FocusRestore
- Focus restore widget for preserving focus state
- GlobalErrorHandler
- Global error handler registration
- I18nLoader
- Loader for i18n translations
- I18nManager
- Manager for internationalization support according to MCP UI DSL v1.0
- JsonPath
- Utility for accessing nested data using path notation
- LifecycleDefinition
- Lifecycle definition
- LifecycleManager
- Manages component and runtime lifecycle events
- LiveRegion
- Live region widget for dynamic content announcements
- LiveRegionBuilder
- Live region builder for dynamic content
- LiveRegionManager
- Live region manager for accessibility announcements
- MCPFocusManager
- Focus manager for accessibility improvements according to MCP UI DSL v1.0 specification
- MCPFocusTraversalPolicy
- Focus traversal policy for custom navigation
- MCPLogger
- Logger for MCP UI Runtime that outputs debug messages.
- MCPNotification
- Represents a notification in the MCP UI Runtime
- MCPPageScopeWrapper
- Widget that provides page state scope wrapper
- MCPPageWidget
- Widget that renders a single page
- MCPPlugin
- Base class for MCP plugins according to MCP UI DSL v1.0
- MCPUIRuntime
- Main MCP UI Runtime class that provides the entry point for using the runtime
- MCPUIRuntimeHelper
- Convenience functions for quick runtime usage
- Executes navigation actions
- Builds navigation UI based on NavigationDefinition
- Navigation definition
- Navigation item
- Navigation service for managing app navigation
- NotificationAction
- Represents an action that can be performed on a notification
- NotificationChannel
- Represents a notification channel for organizing notifications
- NotificationManager
- Manages local and system notifications for the MCP UI Runtime
- NotificationService
- Service for managing notifications within the runtime
- PageDefinition
- Page definition according to spec
- PageStateNotifier
- Notifier for page state changes
- PageStateScope
- Provides a page-specific state scope for multi-page applications
- PathSegment
-
Represents a segment in a path (e.g., "items" or "
0") - PluginContext
- Plugin context provided to plugins during initialization
- PluginInfo
- Plugin information
- PluginManager
- Plugin manager for loading and managing plugins
- RateLimiter
- Rate limiter utility for controlling action frequency
- RemoteValidator
- Remote validator for server-side validation
- RenderContext
- Render context that provides access to runtime services during widget rendering
- Renderer
- Core rendering engine for MCP UI DSL
- RouteInfo
- Route information
- RouteManager
- Manages application routing based on MCP UI DSL spec
- RuntimeEngine
- The main runtime engine that manages the MCP UI Runtime lifecycle and coordinates all runtime services.
- RuntimeService
- Abstract base class for all runtime services
- Service
- Service interface for common service operations
- ServiceLocator
- Service locator for dependency injection according to MCP UI DSL v1.0 specification
- ServiceProvider
- Service provider widget for Flutter
- ServiceRegistry
- Registry for managing runtime services
- ServicesDefinition
- Services definition
- SkipToContent
- Skip to content widget for accessibility
- StateManager
- Manages application state with change notifications Supports computed properties according to MCP UI DSL v1.0
- StateWatcher
- Watches for changes to a specific state path
- StateWatcherGroup
- A group of watchers that can be managed together
- StatusLiveRegion
- Status live region for form validation and status updates
- Throttler
- Throttler utility for performance optimization
- UIDefinition
- Main UI definition that can be either an application or a page
- ValidationEngine
- Validation engine for MCP UI DSL v1.0
- ValidationResult
- Enhanced validation result with pending state
- ValidationRule
- Validation rule
- ValidationState
- Validation state for managing async validation
- Validator
- Base validator class
- VirtualizedGridWidget
- Virtualized grid widget for performance optimization
- VirtualizedListWidget
- Virtualized list widget for performance optimization according to MCP UI DSL v1.0 specification
- WidgetFactory
- Base class for widget factories
- WidgetRegistry
- Registry for widget factories
Enums
- ConformanceLevel
- Conformance level definitions for MCP UI DSL v1.0
- DialogType
- Types of dialogs
- ErrorRecoveryStrategy
- Error recovery strategies
- LifecycleEvent
- Enumeration of lifecycle events supported by the runtime
- LiveRegionType
- Live region types for accessibility announcements according to MCP UI DSL v1.0 specification
- NotificationEvent
- Events that can occur with notifications
- NotificationImportance
- Importance levels for notifications
- NotificationType
- Types of notifications supported by the runtime
- ServiceStatus
- Service status
- SnackbarType
- Types of snackbars
- UIDefinitionType
- Core models for MCP UI DSL v1.0
- ValidationRuleType
- Validation rule types
Mixins
- DebounceMixin
- Mixin to add debouncing capabilities to widgets
-
FormValidationMixin<
T extends StatefulWidget> - Form validation mixin for widgets
-
ServiceLocatorMixin<
T extends StatefulWidget> - Mixin to add service locator access to widgets
- ThrottleMixin
- Mixin to add throttling capabilities to widgets
Extensions
- NotificationActionJson on NotificationAction
- Extension methods for NotificationAction
- VirtualizationExtension on RenderContext
- Extension to integrate virtualized lists with existing list widgets
Typedefs
- NotificationListener = void Function(NotificationEvent event, MCPNotification notification, String? actionId)
- Callback type for notification events
-
StateChangeCallback
= Future<
void> Function(dynamic newValue, dynamic oldValue) - Represents a function that is called when a watched state value changes
Exceptions / Errors
- CircularDependencyException
- Exception thrown when circular dependency is detected
- PluginException
- Plugin exception
- ServiceException
- Exception thrown when service operations fail
- ServiceNotFoundException
- Exception thrown when a service is not found