Installation

Adding Shard to Your Project

Step 1: Add Dependency

Add Shard to your pubspec.yaml file:

dependencies:
  flutter:
    sdk: flutter
  shard: ^2.0.0-dev.1

Step 2: Install Dependencies

Run the following command to install the package:

flutter pub get

Step 3: Import Shard

Import Shard in your Dart files:

import 'package:shard/shard.dart';

Test utilities live in a separate import that you use from your tests:

import 'package:shard/shard_test.dart';

Timer-based tests (debounce/throttle) pair well with the fake_async dev dependency.

Learning path

Follow the docs in this order for a step-by-step experience:

1. Getting Started — Introduction → Installation → Quick Start
2. Essentials — Core Concepts → Widgets → Async Values → Response Caching → Observing a Shard → ShardLocator → Undo & Redo → Testing
3. All Shards — FutureShard → StreamShard → CommandShard → ComputedShard → Persistent Shard
4. Examples — Todo App → Infinite Scroll → CommandShard Form → Best Practices
5. Migration — What's New → Migrating from 1.x

Next Steps

Next: Quick Start to build your first shard. See also: Core Concepts for the fundamentals.