starter_kit library
Compatibility export for the previous library path.
Prefer importing package:starter_kit_flutter/starter_kit_flutter.dart.
Classes
- AppError
- Base sealed hierarchy for all application errors.
- ConfigurationError
- Configuration errors.
- ConnectionError
- Connection errors (no internet, timeout, etc.).
- ConnectivityBanner
- Banner that displays when there's no internet connection.
- DateHelper
- Helper class for date formatting utilities.
- DesignRadiusConfig
- Centralized radius scale for rounded corners.
- DesignShadowConfig
- Centralized shadow and elevation values.
- DesignSpacingConfig
- Centralized spacing scale used across the app.
- DesignSystemConfig
- Root centralized design system configuration.
- DesignTypographyConfig
- Centralized typography and font settings.
- DevNetworkLogEntry
- A captured network log entry for the Dev Panel inspector.
- ErrorParser
- Parses Dio exceptions and HTTP errors into AppError instances.
-
Failure<
T, E> - Represents a failed operation with an error.
- FeatureFlagConfig
- Configuration for the feature flag module.
- ForceUpdateScreen
- Full-screen, un-dismissible force update screen.
- GlobalLoader
- Global loader overlay that blocks user interaction.
- HSpace
- Horizontal gap that resolves size from centralized spacing tokens.
- IConnectivityService
- Interface for connectivity monitoring service.
- IFeatureFlagService
- Interface for feature flag evaluation and local overrides.
- INetworkClient
- Interface for network operations.
- IStorageService
- Interface for storage operations.
- IUpdaterService
- Interface for app updater service.
- MaintenanceScreen
- Full-screen maintenance mode screen.
- NetworkConfig
- Configuration for network client.
- NetworkError
- Network-related errors.
-
Result<
T, E> - Sealed class for representing operation results.
- SafeJsonReader
- Crash-proof JSON/Map reading helpers that tolerate backend key renames.
- ServiceAccessor
- Service accessor that provides typed access to registered services.
- SKSizedBox
- Predefined constant sized boxes for quick non-inline spacing.
- StarterKit
- Main facade class for StarterKit package.
- StarterKitApp
- High-level app wrapper that initializes StarterKit once and wires navigation, theme, and global overlays in one place.
- StarterKitAppData
- Data exposed to host app builders from StarterKitApp.
- StarterKitConfig
- Master configuration object for StarterKit initialization.
- StarterKitDebugController
- Debug-only runtime controller for Dev Panel features.
- StarterKitDevPanel
- The Dev Panel content with inspector tabs.
- StarterKitDevPanelHost
- Debug-only in-app developer panel.
- StarterKitModulesConfig
- Module-level switches for StarterKit initialization.
- StarterKitSlot
- Lightweight conditional slot for local / feature-flagged / fallback UI.
- StarterKitUiConfig
- UI behavior controls for global StarterKit widgets.
- StorageConfig
- Configuration for storage services.
- StorageError
- Storage-related errors.
-
Success<
T, E> - Represents a successful operation with data.
- ThemeConfig
- Configuration for theme management.
- ThemeManager
- Manages app theme and persists theme preference.
- ToastOverlay
- Global toast/snackbar overlay manager.
- UnknownError
- Unknown or unexpected errors.
- UpdaterConfig
- Configuration for app updater service.
- ValidationError
- Validation errors.
- VersionResponse
- Response model for version check API.
- VSpace
- Vertical gap that resolves size from centralized spacing tokens.
Enums
- DesignSpacingSize
- Semantic spacing sizes for reusable gap widgets and spacing lookups.
- DevNetworkFailureMode
- Simulated network failure modes for QA.
- DevOverlaySimulation
- Overlay simulation modes for QA.
- DevPanelTrigger
- How the in-app Dev Panel can be opened.
- NetworkConnectionState
- Connection state enum.
- StarterKitModuleMode
- Defines how a StarterKit module should be initialized.
- UpdateStatus
- Update status enum.
Extensions
- ContextExtensions on BuildContext
- Extension methods for BuildContext.
- DateExtensions on DateTime
- Extension methods for DateTime.
- ResponsiveSizer on num
- Extension for responsive sizing based on screen dimensions.
-
ResultExtensions
on Result<
T, E> - Extension methods for Result type with Dart 3 pattern matching helpers.
-
SafeJsonMapExtension
on Map<
String, dynamic> - Extension helpers for type-safe fallback key chains.
- ScreenDimensions on BuildContext
- Extension for direct access to screen dimensions from BuildContext.
- StringExtensions on String
- Extension methods for String.
Properties
-
Global navigation key for the app.
final
Functions
-
combineValidators(
List< String? Function(String?)> validators) → String? Function(String?) - Combines multiple validators.
-
emailValidator(
) → String? Function(String?) - Validates that the value is a valid email address.
-
matchValidator(
String otherValue, String fieldName) → String? Function(String?) - Validates that the value matches another value (for password confirmation).
-
maxLengthValidator(
int maxLength, String fieldName) → String? Function(String?) - Validates that the value meets maximum length requirement.
-
minLengthValidator(
int minLength, String fieldName) → String? Function(String?) - Validates that the value meets minimum length requirement.
-
patternValidator(
RegExp pattern, String errorMessage) → String? Function(String?) - Validates that the value matches a pattern (regex).
-
phoneValidator(
) → String? Function(String?) - Validates that the value is a valid phone number (basic validation).
-
requiredValidator(
String fieldName) → String? Function(String?) - Validator functions for FormField validation. Validates that the value is not empty.
-
urlValidator(
) → String? Function(String?) - Validates that the value is a valid URL.
Typedefs
- StarterKitAppBuilder = Widget Function(BuildContext context, StarterKitAppData data)
- Signature for building the host app once StarterKit is initialized.