cloudflare_turnstile 3.0.1 cloudflare_turnstile: ^3.0.1 copied to clipboard
A free CAPTCHAs alternative to enhance security and protect against bots.
Flutter Cloudflare Turnstile #
Cloudflare turnstile is a free CAPTCHAs Alternative, Turnstile delivers frustration-free, CAPTCHA-free web experiences to website visitors - with just a simple snippet of free code. Moreover, Turnstile stops abuse and confirms visitors are real without the data privacy concerns or awful user experience of CAPTCHAs.
⚠️ This package is unofficial and not endorsed by Cloudflare. Use it at your own discretion. #
Installation #
flutter pub add cloudflare_turnstile
Example #
Here`s a quick example that show how to add Cloudflare Turnstile widget to your flutter app
import 'package:flutter/material.dart';
import 'package:cloudflare_turnstile/cloudflare_turnstile.dart';
class MyApp extends StatelessWidget {
const MyApp({super.key});
@override
Widget build(BuildContext context) {
// Turnstile widget configuration
final TurnstileOptions options = const TurnstileOptions(
size: TurnstileSize.normal,
theme: TurnstileTheme.light,
language: 'ar',
retryAutomatically: false,
refreshTimeout: TurnstileRefreshTimeout.manual,
);
return Scaffold(
body: Center(
child: CloudflareTurnstile(
siteKey: '3x00000000000000000000FF', //Change with your site key
baseUrl: 'http://localhost/',
onTokenReceived: (token) {
print(token);
},
),
),
);
}
}
For Android and iOS platforms you need to provide the
baseUrl
parameter with the actual URL of your Turnstile Widget Domans list.baseUrl
is must be a same as list of domains when creating a Widget.
Using Turnstile invisible mode #
Here's how to use Cloudflare's invisible Turnstile, which automatically solves the challenge in the background
import 'package:cloudflare_turnstile/cloudflare_turnstile.dart';
class TurnstileService {
/// Retrives the CloudFlare Turnstile token using invisible mode.
static Future<String?> get token async {
// Initialize an instance of invisible Cloudflare Turnstile with your site key
final turnstile = CloudflareTurnstile.invisible(
siteKey: '1x00000000000000000000BB', // Replace with your actual site key
);
try {
// Get the Turnstile token
final token = await turnstile.getToken();
return token; // Return the token upon success
} on TurnstileException catch (e) {
// Handle Turnstile failure
print('Challenge failed: ${e.message}');
} finally {
// Ensure the Turnstile instance is properly disposed of
turnstile.dispose();
}
// Return null if the token couldn't be generated
return null;
}
}
⚠️ It's important to call
dispose()
on theCloudflareTurnstile
instance when you no longer need it. This ensures that resources are properly cleaned up, preventing any potential memory issues.
Contribution #
Your contributions are welcome and greatly valued! If you have ideas, suggestions, or improvements, feel free to open an issue or submit a pull request. Every bit of help is appreciated, and your input can make a big difference. Just ensure your contributions fit with the project's goals and guidelines.
License #
This project is licensed under the MIT License - see the LICENSE.md file for details.