# A simple package to help integrate Cloudflare Turnstile. [![Latest Version on Packagist](https://img.shields.io/packagist/v/ryangjchandler/laravel-cloudflare-turnstile.svg?style=flat-square)](https://packagist.org/packages/ryangjchandler/laravel-cloudflare-turnstile) [![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/ryangjchandler/laravel-cloudflare-turnstile/run-tests.yml?branch=main&style=flat-square&label=tests)](https://github.com/ryangjchandler/laravel-cloudflare-turnstile/actions?query=workflow%3Arun-tests+branch%3Amain) [![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/ryangjchandler/laravel-cloudflare-turnstile/fix-php-code-style-issues.yml?branch=main&style=flat-square&label=code+style)](https://github.com/ryangjchandler/laravel-cloudflare-turnstile/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain) [![Total Downloads](https://img.shields.io/packagist/dt/ryangjchandler/laravel-cloudflare-turnstile.svg?style=flat-square)](https://packagist.org/packages/ryangjchandler/laravel-cloudflare-turnstile) This packages provides an API integrating Laravel with [Cloudflare's Turnstile](https://www.cloudflare.com/en-gb/application-services/products/turnstile/) product. ## Installation You can install the package via Composer: ```bash composer require ryangjchandler/laravel-cloudflare-turnstile ``` You should then add the following configuration values to your `config/services.php` file: ```php return [ // ..., 'turnstile' => [ 'key' => env('TURNSTILE_SITE_KEY'), 'secret' => env('TURNSTILE_SECRET_KEY'), ], ]; ``` Create your Turnstile keys through Cloudflare and add them to your `.env` file. ``` TURNSTILE_SITE_KEY="1x00000000000000000000AA" TURNSTILE_SECRET_KEY="2x0000000000000000000000000000000AA" ``` ## Usage In your layout file, include the Turnstile scripts using the `` component. This should be added to the `` of your document. ```blade {{ $slot }} ``` Once that's done, you can use the `` component inside of a `

` to output the appropriate markup with your site key configured. ```blade ``` To validate the Turnstile response, use the `Turnstile` rule when validating your request. ```php use Illuminate\Validation\Rule; use RyanChandler\LaravelCloudflareTurnstile\Rules\Turnstile; public function submit(Request $request) { $request->validate([ 'cf-turnstile-response' => ['required', new Turnstile], ]); } ``` ### Customizing the widget You can customize the widget by passing attributes to the `` component. > To learn more about these parameters, refer to [the offical documentation](https://developers.cloudflare.com/turnstile/get-started/client-side-rendering/#configurations). ```blade

``` ### Livewire support This package can also integrate seamlessly with [Livewire](https://livewire.laravel.com). You can use `wire:model` to bind the Turnstile response to a Livewire property directly. ```blade ``` #### Multiple widgets with Livewire If you're using Livewire and need to have multiple widgets on the same page, each widget requires a unique ID. ```blade ``` The `id` property must match this RegEx: `/^[a-zA-Z_][a-zA-Z0-9_-]*$/`. IDs that do not match the RegEx will trigger an exception. ## Testing ```bash composer test ``` ## Changelog Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. ## Contributing Please see [CONTRIBUTING](CONTRIBUTING.md) for details. ## Security Vulnerabilities Please review [our security policy](../../security/policy) on how to report security vulnerabilities. ## Credits - [Ryan Chandler](https://github.com/ryangjchandler) - [All contributors](../../contributors) ## License The MIT License (MIT). Please see [License File](LICENSE.md) for more information.