Overview
Start here to understand the Feddy Flutter SDK surface area — what ships in the box and where each piece fits.
The Feddy Flutter SDK is a single Dart package that gives your app drop-in Material widgets for feedback and roadmap, a Smart Review prompt with a 2-step gate, automatic subscription detection, and a small imperative API for building anything custom on top of the same data.
What's in the box
| Surface | Purpose |
|---|---|
Feddy.configure(apiKey: ...) | One-line bootstrap with your Project ID. |
FeddyProvider widget | Mounts the built-in compose modal and Smart Review sheet so the imperative APIs work from anywhere in your tree. |
Feddy.identify(...) | Attribute writes to a real user identity. Optional. |
Feddy.openFeedback(boardKey: ...) | Open the bundled compose modal from anywhere. |
Feddy.requestReviewIfAppropriate(trigger: ...) | Gated Smart Review prompt with the 2-step like / dislike sheet. |
Feddy.submitRequest(...) | Programmatic submit. Fire-and-forget, never throws. |
Feddy.fetchRequests(...) etc | Async reads for fetch / vote / comment when you need a custom UI. |
RequestListView | Bundled feedback list with pagination, voting, and detail navigation. |
RoadmapView | Public roadmap with Planned / In Progress / Completed tabs. |
FeedbackComposeView | Bundled compose widget, mountable inside a showModalBottomSheet. |
Two API styles
The SDK is split deliberately so fire-and-forget writes never need a
try / catch:
- Synchronous, never-throws:
configure,identify,submitRequest,setSubscription,reset. Errors log to the console and queue for retry where it makes sense. - Async / throws:
fetchRequests,fetchRequest,fetchComments,upvote,addComment,fetchBoards. Failures throwFeddyError(network or HTTP).
What ships in the box vs the host
Unlike the React Native SDK, the Flutter package bundles its image picker and IAP dependencies directly — no optional setup is required for image attachments or subscription auto-detection.
- Image attachments:
image_pickeris bundled. Add the platform privacy strings once and the compose widget shows the camera roll button. - Subscription auto-detection:
in_app_purchaseis bundled. The SDK subscribes to Play Billing'spurchaseStreamon Android and readsSK2Transaction.transactions()on iOS.
Reading order
The next three pages take you from zero to fully integrated:
- Installation —
flutter pub add, Project ID setup,FeddyProvidermount, and theFeddy.configure(...)call at app launch. - Authentication — identifying signed-in users and how anonymous-first attribution reconciles to a real user later.
- Common flows — open the feedback modal, push the roadmap as a route, trigger Smart Review, build a custom UI on top of the async API, and handle errors.
Status
The Flutter SDK is at v0.3.x, currently in beta. Breaking changes between minor versions are called out on the GitHub releases page. After 1.0, the SDK follows strict semver — minor / patch releases will not break callers.
Common Flows
Open the feedback modal, render the roadmap, trigger Smart Review, build custom UI on top of the async API, and handle errors. Covers openFeedback, RequestListView, RoadmapView, SmartReview, programmatic submit / fetch / vote / comment, and FeddyError patterns.
Installation
From flutter pub add to a working feedback modal in one flow — install, mount FeddyProvider, configure with your Project ID, drop in a button, verify in the dashboard.