commonkit 0.1.7

A lightweight utility package for Flutter with widgets, helpers, and extensions

CommonKit

A lightweight, reusable utility package for Flutter apps, providing a collection of widgets, helpers, and extensions to simplify common development tasks.

Features

Widgets

• LoadingOverlay: Show a loading spinner with customizable theme.
• CustomSnackbar: Display styled snackbars with icons and colors.
• CustomButton: Create reusable buttons with text, icons, and themes.
• Toast: Show short-lived notifications at the screen bottom.
• CustomDialog: Present customizable dialogs with themed buttons.

Extensions

• StringExtensions: Add capitalize() and truncate() to strings.
• ContextExtensions: Access screenWidth, screenHeight, and more.

Helpers

• Validators: Validate form fields (e.g., email, required).
• DateFormatter: Format dates and get "time ago" strings.

  // Format a date
  String formatted = DateFormatter.format(DateTime.now(), 'yyyy-MM-dd');
  
  // Get a "time ago" string
  String timeAgo = DateFormatter.timeAgo(DateTime.now().subtract(Duration(minutes: 5)));
  

• NetworkHelper: Simplify HTTP GET/POST with file upload support.
• ImageCacheHelper: Preload images for performance.
• Debouncer: Delay function calls for input debouncing.
• StorageHelper: Store key-value pairs persistently.

  // Initialize StorageHelper
  final storage = StorageHelper();
  await storage.init();
  
  // Set a value
  await storage.set('my_key', 'my_value');
  
  // Get a value
  String? value = await storage.get('my_key');
  

• AnimationHelper: Create fade and slide animations easily.
• ResponsiveHelper: Build responsive layouts with breakpoints.
• SessionManager: Manage login/logout with global state.
• DirectoryManager: Handle local file system operations (create, update, delete, list).

  // Initialize DirectoryManager
  final dirManager = DirectoryManager();
  await dirManager.init();
  
  // Create a file
  await dirManager.createFile('my_folder/my_file.txt', 'Hello, World!');
  
  // Read a file
  String content = await dirManager.readFile('my_folder/my_file.txt');
  
  // List files in a directory
  List<String> files = await dirManager.listFiles('my_folder');
  
  // Delete a file
  await dirManager.deleteFile('my_folder/my_file.txt');
  

• Logger: Log messages with info, warning, and error levels.
• ClipboardManager: Copy/paste text to/from the clipboard.
• DataSerializer: Serialize/deserialize JSON data.
• PermissionManager: Request and check app permissions.

Asynchronous Operations

Many helpers in CommonKit perform asynchronous operations and return a Future. You should use async/await to work with them. For example, when using NetworkHelper:

Future<void> fetchData() async {
  try {
    final data = await _networkHelper.get('/posts/1');
    // do something with data
  } catch (e) {
    // handle error
  }
}

Configuration

• CommonKitTheme: Define app-wide colors and styles.
• GlobalConfig: Manage global settings like base URL and user session.

Example

The example directory contains a sample app demonstrating all features. The ExamplePage in example/lib/example_page.dart provides a dedicated interface to test key utilities like network requests, file uploads, directory management, clipboard, and permissions.

Getting Started

Add CommonKit to your pubspec.yaml:

dependencies:
  commonkit: ^0.1.7  # Use the latest version from pub.dev