flutter_cookie_consent - Dart API docs

A Flutter plugin for displaying cookie consent banners and managing cookie preferences in your Flutter applications. This plugin helps you comply with GDPR, CCPA, and other privacy regulations by providing a customizable cookie consent solution.

Features

Display customizable cookie consent banners
Support for multiple cookie categories (Essential, Analytics, Marketing)
Customizable banner position (top or bottom)
Settings dialog for detailed cookie preferences
Persistent storage of user preferences
Web platform implementation
Accessibility support

Platform Support

Platform	Support
Web	✅
Android	✅
iOS	✅
Windows	❌
macOS	❌
Linux	❌

Installation

Add the following to your pubspec.yaml file:

dependencies:
  flutter_cookie_consent: ^1.0.0

Then run:

flutter pub get

Flutter Version Compatibility

Flutter Version	Package Version
>=3.3.0	^1.0.0

Usage

Example Project

Here's a simple example showing how to use the createBanner method to display a cookie consent banner:

import 'package:flutter/material.dart';
import 'package:flutter_cookie_consent/flutter_cookie_consent.dart';

class MyApp extends StatefulWidget {
  const MyApp({super.key});

  @override
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  final FlutterCookieConsent _cookieConsent = FlutterCookieConsent();
  late final Future<void> _initFuture;

  @override
  void initState() {
    super.initState();
    _initFuture = _cookieConsent.initialize();
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        body: FutureBuilder(
          future: _initFuture,
          builder: (context, snapshot) {
            if (snapshot.connectionState == ConnectionState.waiting) {
              return const Center(child: CircularProgressIndicator());
            }

            return Stack(
              children: [
                // Your app content
                const Center(
                  child: Text('Welcome to our app!'),
                ),
                // Cookie consent banner
                _cookieConsent.createBanner(
                  context: context,
                  title: 'Cookie Settings',
                  message: 'We use cookies to enhance your browsing experience...',
                  acceptButtonText: 'Accept',
                  declineButtonText: 'Decline',
                  settingsButtonText: 'Settings',
                  showSettings: true,
                  position: BannerPosition.top,
                ),
              ],
            );
          },
        ),
      ),
    );
  }
}

### Basic Usage

The following is a minimal implementation that you can use with the example code above:

```dart
import 'package:flutter_cookie_consent/flutter_cookie_consent.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        body: CookieConsentBanner(
          title: 'Cookie Consent',
          message: 'We use cookies to enhance your experience...',
          acceptButtonText: 'Accept All',
          declineButtonText: 'Decline',
          settingsButtonText: 'Settings',
        ),
      ),
    );
  }
}

### Advanced Usage

You can also customize the banner with more options. Here's an example that you can integrate with the main example code:

```dart
CookieConsentBanner(
  title: 'Cookie Consent',
  message: 'We use cookies to enhance your experience...',
  acceptButtonText: 'Accept All',
  declineButtonText: 'Decline',
  settingsButtonText: 'Settings',
  showSettings: true,
  position: BannerPosition.bottom,
  style: CookieConsentStyle(
    backgroundColor: Colors.white,
    textColor: Colors.black,
    buttonColor: Colors.blue,
    buttonTextColor: Colors.white,
    borderRadius: 8.0,
    padding: const EdgeInsets.all(16.0),
  ),
  categories: [
    CookieCategory(
      id: 'essential',
      title: 'Essential',
      description: 'Required for the website to function',
      isRequired: true,
    ),
    CookieCategory(
      id: 'analytics',
      title: 'Analytics',
      description: 'Help us understand how visitors interact',
    ),
    CookieCategory(
      id: 'marketing',
      title: 'Marketing',
      description: 'Used for advertising purposes',
    ),
  ],
  onAccept: (Map<String, bool> preferences) {
    // Handle accept
    print('Accepted preferences: $preferences');
  },
  onDecline: (Map<String, bool> preferences) {
    // Handle decline
    print('Declined preferences: $preferences');
  },
  onSettings: () {
    // Handle settings
    print('Settings opened');
  },
);

You can check the consent status in your app like this:

final cookieConsent = FlutterCookieConsent();

// Check if user has given consent
if (cookieConsent.hasConsent) {
  final preferences = cookieConsent.preferences;
  // Use preferences to determine which cookies to set
}

// Check if banner should be shown
if (cookieConsent.shouldShowBanner) {
  // Show banner
}

These examples can be integrated with the main example code to create a complete cookie consent solution for your app.

API Reference