Add Hook for managing SnapshotController instances

[benthillerkus]

Adds a useSnapshotController hook for https://api.flutter.dev/flutter/widgets/SnapshotController-class.html

Summary by CodeRabbit

• New Features

  • Added a new hook for snapshot management, letting developers enable and control snapshot behavior via a configurable option.

• Tests

  • Added widget tests to validate the hook’s initialization, parameter behavior, lifecycle, and cleanup.

• Documentation

  • Updated README to document the new hook and adjusted related formatting for clarity.

[coderabbitai]

Walkthrough

Adds a new snapshot controller hook: a part directive in hooks.dart, a new snapshot_controller.dart implementing useSnapshotController and its hook state, widget tests for the hook, and README documentation updates listing the new hook.

Changes

Cohort / File(s)	Summary
Hook entry update packages/flutter_hooks/lib/src/hooks.dart	Added part 'snapshot_controller.dart'; to include the new hook implementation.
Hook implementation packages/flutter_hooks/lib/src/snapshot_controller.dart	New file: adds SnapshotController useSnapshotController({ bool allowSnapshotting = false }), _SnapshotControllerHook, and _SnapshotControllerHookState to create, update, and dispose a SnapshotController.
Tests packages/flutter_hooks/test/use_snapshot_controller_test.dart	New widget tests validating diagnostic output, parameter behavior, instance identity, and lifecycle of useSnapshotController.
Docs README.md	Added useSnapshotController entry in Misc hooks section and minor formatting alignment.

Sequence Diagram(s)

sequenceDiagram
    participant Widget as Widget Tree
    participant HookBuilder as HookBuilder
    participant Hook as useSnapshotController
    participant Controller as SnapshotController

    Widget ->> HookBuilder: build
    HookBuilder ->> Hook: call useSnapshotController(allowSnapshotting)
    Hook ->> Controller: create SnapshotController(allowSnapshotting)
    HookBuilder -->> Widget: render with Controller
    Note over Hook,Controller: On hook updates
    Hook ->> Controller: update allowSnapshotting
    Note over Widget,Hook: On widget disposal
    Widget ->> Hook: dispose hook
    Hook ->> Controller: dispose Controller

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

"I’m a rabbit patching code today,
Snipping parts and tests along the way.
A snapshot hook, tidy and bright,
Created, updated, then disposed right.
Hopping off — commits are out of sight! 🐇"

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 846bc3a and dfad115.

📒 Files selected for processing (2)

• README.md (1 hunks)
• packages/flutter_hooks/lib/src/hooks.dart (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• README.md

🚧 Files skipped from review as they are similar to previous changes (1)

• packages/flutter_hooks/lib/src/hooks.dart

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.