kickin 0.0.1-dev.2

A Flutter package that makes developments easier by providing commonly used utilities and widgets with just simple initialization.(In Progress)

Kickin — Practical Flutter utilities and widgets (In Progress)

Kickin is a comprehensive toolkit designed to strip away boilerplate and simplify common, repetitive tasks in Flutter development. It packs robust utility classes, powerful extensions, and opinionated wrappers around popular community tools (like state management and persistency) to give you better developer ergonomics and predictable behaviour right out of the box.

Features

• Boilerplate-free architecture: Helpers and mixins that tackle daily repetitive code
• Wrappers for popular tools: Ergonomic APIs for state management (e.g. Riverpod) and storage libraries (e.g. Hive)
• Result wrapper for safe and predictable async operations
• Smart isolate helpers for background work with progress reporting
• Handy extensions for BuildContext, num, String, providers and durations
• Useful widgets: AnimatedSizing, ScaleGestureWrapper, SmoothListView, AdaptiveImage, and more

Quick install

Add the package to your app dependencies:

dependencies:
  flutter:
    sdk: flutter
  kickin: 0.0.1-dev.2

Then import the package root API where needed:

import 'package:kickin/kickin.dart';

Getting started

Initialize the persistent storage driver (e.g. Hive) if you intend to use the built-in storage features:

await KickinHive.on.initialize();
KickinHive.on.app.setData(key: key, value: value);

API summary

The public API is intentionally compact and centered around a few high-value areas:

• Core APIs: ApiBase, Api, ApiKeyEnum
• Base helpers: extensions for context, durations, strings, numbers, providers, and widgets; plus reusable mixins
• State management: Absorb, standard notifiers, WatchNotifier, and PersistentNotifier
• Storage: KickinHive, AppHive, SecureHive
• Utilities: Result, SmartIsolate, SmartIsolateContinuous, SmartIsolateAccess, SmartIsolateException, WorkPriority
• Widgets: AnimatedSizing, ScaleGestureWrapper, TopPadding, BottomPadding, AppText, SmoothListView, SmoothCustomScrollView, AdaptiveImage, ImageFromMemory, and FilePath

Examples

Extensions & context helpers

// Elegant spacing in rows/columns
Widget build(BuildContext c) => Column(
  children: [
    const Text('Top'),
    24.toVBox, // No more verbose SizedBox(height: 24)
    const Text('Bottom'),
  ],
);

// Access media queries and theme securely with zero boilerplate
final isDark = context.isDarkMode;
final screenWidth = context.deviceWidth;
final topPadding = context.topPadding;

State Management & Offline Storage

// 1. A Notifier that auto-magically persists to local storage (Hive, etc.)
class ThemeModeNotifier extends PersistentNotifier<String, ThemeMode> {
  ThemeModeNotifier() : super(
    'theme_mode_key', 
    ThemeMode.system,
    encode: (mode) => mode.name,
    decode: (raw) => ThemeMode.values.byName(raw ?? 'system'),
  );
}

// 2. Pre-built standard notifiers to avoid repetitive boilerplate (riverpod 3.0+)
final counterProvider = NotifierProvider<IntNotifier, int>(() => IntNotifier(0));
final userProvider = NotifierProvider<SomeNotifier<User?>, User?>(() => SomeNotifier(null));

// Update values easily:
// ref.read(counterProvider.notifier).set(5);
// ref.read(counterProvider.notifier).update((state) => state + 1);

// 3. Surgical rebuilds using Absorb without ConsumerWidget boilerplate
Widget build(BuildContext context) {
  return Absorb.watch(
    themeProvider,
    builder: (ref, theme, _) => MaterialApp(
      themeMode: theme, // Now responsive to changes
      home: const Home(),
    ),
  );
}

Safe Async Operations (Result)

Avoid endless try-catch blocks and effectively manage data/loading/error states.

Future<Result<User>> fetchUser(String id) async {
  return Result.tryRunAsync(() async {
    final response = await api.getUser(id);
    return User.fromJson(response);
  }).then((user) async {
    await cache.save(user); // Chained safely. Skipped if error occurred above.
    return user;
  });
}

Heavy Background Workers (Smart Isolate)

Run intense workloads safely away from the main thread without stuttering the UI. Send progress updates back to the UI in real-time.

// Execute right away with progress reporting 
final compressedBytes = await SmartIsolate.run<Uint8List, double, Uint8List>(
  (imageBytes, emit) async {
    emit(0.2); // Notify UI: 20% done
    final processed = await heavyImageCompression(imageBytes);
    emit(1.0); // Notify UI: 100% done
    return processed;
  },
  rawImageBytes,
  onProgress: (percent) => print('Compressing: ${percent * 100}%'),
);

// Or create a continuous background worker with a priority queue
final imageWorker = await SmartIsolateContinuous.spawn<ImageTask, ImageResult>(
  (register) async {
    final decoder = await setupHeavyModel(); // Run once initialization
    register((task, respond) => respond(decoder.process(task)));
  },
);

imageWorker.execute(task, priority: WorkPriority.high);

Widgets & UI interactions

// Bouncy, squishy, and hyper-interactive buttons out of the box
ScaleGestureWrapper(
  onTapUp: (details) => navigateToDetails(),
  scaleBetween: (1.0, 0.92),
  child: AnimatedSizing.fast(
    child: Card(
      elevation: 4,
      child: Padding(
        padding: const EdgeInsets.all(16.0),
        child: AppText('Squish me!', fontWeight: FontWeight.bold),
      ),
    ),
  ),
);

// Mac/Windows-like buttery-smooth momentum scrolling on desktop platforms.
// Automatically falls back to native physics on mobile!
SmoothListView.builder(
  mode: SmoothScrollMode.auto,
  intensity: ScrollIntensity.slow,
  itemCount: 100,
  itemBuilder: (context, index) => ListTile(
    leading: AdaptiveImage(
      path: FilePath(url: 'https://...', local: 'assets/fallback.png'),
      fallbackWidget: const Icon(Icons.error),
    ),
    title: Text('Item $index'),
  ),
);

Documentation & examples

Use the root import for the public surface:

import 'package:kickin/kickin.dart';

The examples above cover the main patterns. For implementation details, keep exploring the package API from there.

Changelog

See the changelog for version history.

License

This project is available under the license terms.

Maintainers

okikday

Maintainer