A Flutter/Dart SDK for submitting form data to Formclick.
Mirrors the API design of @formclick/react and @formclick/react-native — but written in idiomatic Dart using ChangeNotifier and InheritedWidget.
| Android | iOS | Linux | macOS | Web | Windows |
|---|---|---|---|---|---|
| ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
This is a pure Flutter/Dart package — no native plugin code. It relies on Flutter widgets and the http package, which supports all six Flutter platforms.
Dart ships bundled with Flutter. Installing Flutter gives you both.
- Download the latest Flutter SDK from flutter.dev/docs/get-started/install/windows
- Extract to a path without spaces or special characters, e.g.
C:\src\flutter - Add
C:\src\flutter\binto yourPATHenvironment variable - Open a new terminal and verify:
dart --version flutter --version flutter doctor
brew install --cask flutter
dart --version && flutter --version && flutter doctorsudo snap install flutter --classic
dart --version && flutter --version && flutter doctor| SDK | Minimum |
|---|---|
| Dart | 3.0.0 |
| Flutter | 3.10.0 |
FormclickNotifier—ChangeNotifier-based state holder (loading / success / error / data)FormclickProvider—InheritedWidgetfor app-wide config (base URL, headers, global callbacks)submitToFormclick— low-level async function for one-shot submissions- Zero Flutter-specific dependencies beyond
http - Works with any state-management solution that supports
ChangeNotifier(provider,riverpod, vanillaListenableBuilder)
Add to your pubspec.yaml:
dependencies:
formclick: ^0.1.0Then run:
flutter pub getWrap your root widget with FormclickProvider so every FormclickNotifier in the tree can read the shared config:
import 'package:formclick/formclick.dart';
import 'package:flutter/material.dart';
void main() {
runApp(
FormclickProvider(
config: const FormclickConfig(
submitBaseUrl: 'https://api.formclick.io/submit',
// Optional global callbacks
onSuccess: _onSuccess,
onError: _onError,
),
child: const MyApp(),
),
);
}
void _onSuccess(SubmitResult result, SubmitOptions options) {
debugPrint('Submitted! ${result.message}');
}
void _onError(Exception error, SubmitOptions options) {
debugPrint('Error: $error');
}final _notifier = FormclickNotifier(
submitBaseUrl: 'https://api.formclick.io/submit',
);import 'package:formclick/formclick.dart';
import 'package:flutter/material.dart';
class LeadForm extends StatefulWidget {
const LeadForm({super.key});
@override
State<LeadForm> createState() => _LeadFormState();
}
class _LeadFormState extends State<LeadForm> {
final _formKey = GlobalKey<FormState>();
final _name = TextEditingController();
final _email = TextEditingController();
late final FormclickNotifier _notifier;
@override
void didChangeDependencies() {
super.didChangeDependencies();
// Read config from the nearest FormclickProvider
final config = FormclickProvider.of(context);
_notifier = FormclickNotifier(
submitBaseUrl: config.submitBaseUrl,
headers: config.headers,
onSuccess: config.onSuccess,
onError: config.onError,
);
}
@override
void dispose() {
_notifier.dispose();
_name.dispose();
_email.dispose();
super.dispose();
}
Future<void> _submit() async {
if (!_formKey.currentState!.validate()) return;
await _notifier.submit(SubmitOptions(
formId: 'YOUR_ACCESS_KEY',
data: {
'name': _name.text.trim(),
'email': _email.text.trim(),
},
));
}
@override
Widget build(BuildContext context) {
return ListenableBuilder(
listenable: _notifier,
builder: (context, _) {
return Form(
key: _formKey,
child: Column(
children: [
TextFormField(
controller: _name,
decoration: const InputDecoration(labelText: 'Full Name'),
validator: (v) => v!.isEmpty ? 'Required' : null,
),
TextFormField(
controller: _email,
decoration: const InputDecoration(labelText: 'Email'),
keyboardType: TextInputType.emailAddress,
validator: (v) => v!.isEmpty ? 'Required' : null,
),
const SizedBox(height: 16),
if (_notifier.success)
const Text('Sent! ✓', style: TextStyle(color: Colors.green)),
if (_notifier.error != null)
Text(
_notifier.error.toString(),
style: const TextStyle(color: Colors.red),
),
const SizedBox(height: 8),
ElevatedButton(
onPressed: _notifier.loading ? null : _submit,
child: _notifier.loading
? const SizedBox(
width: 18,
height: 18,
child: CircularProgressIndicator(strokeWidth: 2),
)
: const Text('Send Message'),
),
],
),
);
},
);
}
}// In your widget tree
ChangeNotifierProvider(
create: (_) => FormclickNotifier(
submitBaseUrl: 'https://api.formclick.io/submit',
),
child: const LeadForm(),
)
// Inside LeadForm
final notifier = context.watch<FormclickNotifier>();final formclickProvider = ChangeNotifierProvider<FormclickNotifier>(
(ref) => FormclickNotifier(
submitBaseUrl: 'https://api.formclick.io/submit',
),
);
// Inside a ConsumerWidget
final notifier = ref.watch(formclickProvider);import 'package:formclick/formclick.dart';
final result = await submitToFormclick(
SubmitOptions(
formId: 'YOUR_ACCESS_KEY',
data: {'name': 'John', 'email': 'john@example.com'},
),
);
print(result.success); // true
print(result.message); // "Email sent successfully."| Property | Type | Default | Description |
|---|---|---|---|
submitBaseUrl |
String |
https://api.formclick.io/submit |
Base URL of the submissions API |
headers |
Map<String,String>? |
null |
Extra headers for every request |
onSuccess |
void Function(SubmitResult, SubmitOptions)? |
null |
Global success callback |
onError |
void Function(Exception, SubmitOptions)? |
null |
Global error callback |
| Member | Type | Description |
|---|---|---|
loading |
bool |
true while a request is in-flight |
success |
bool |
true after a successful submission |
error |
Exception? |
Last error, or null |
data |
SubmitResult? |
Last successful server response |
submit(options) |
Future<SubmitResult> |
Send a form submission |
reset() |
void |
Reset all state to idle |
| Property | Type | Description |
|---|---|---|
formId |
String |
Formclick access_key |
data |
FormValues (Map<String, dynamic>) |
Field data to submit |
submitUrl |
String? |
Override the full endpoint URL |
| Property | Type | Description |
|---|---|---|
success |
bool |
Whether the submission succeeded |
message |
String? |
Server message |
# Static analysis
flutter analyze
# Dry-run publish (validates package without uploading)
flutter pub publish --dry-runRun pana locally to preview your pub.dev score:
dart pub global activate pana
pana .Common score requirements:
pubspec.yamlmust havedescription,homepage,repositoryREADME.md,CHANGELOG.md, andLICENSEmust exist- All public APIs must have dartdoc comments
flutter analyzemust pass with zero issues
# Example: MIT license
curl -o LICENSE https://opensource.org/licenses/MITflutter pub publishYou will be prompted to authenticate with your Google account. The package is uploaded to pub.dev and is publicly available within a few minutes.
- Bump the version in
pubspec.yaml(follows semver) - Add an entry to
CHANGELOG.md - Run
flutter pub publish
MIT © Formclick