adblocker_webview 2.3.0 copy "adblocker_webview: ^2.3.0" to clipboard
adblocker_webview: ^2.3.0 copied to clipboard

Published 6 days ago β€’ verified publisherislamdidarmd.dev
SDKFlutter
PlatformAndroidiOS
β†’

Metadata

A webview for flutter with adblocking capability. It's currently based on Official Flutter Webview Plugin.

More...

style: very good analysis

AdBlocker WebView Flutter #

A Flutter WebView implementation that blocks ads and trackers using EasyList and AdGuard filter lists.

Features #

  • 🚫 Ad and tracker blocking using EasyList and AdGuard filters
  • 🌐 Supports both URL and HTML content loading
  • πŸ”„ Navigation control (back, forward, refresh)
  • πŸ“± User agent strings for Android and iOS
  • ⚑ Early resource blocking for better performance
  • 🎯 Domain-based filtering and element hiding
  • πŸ” Detailed logging of blocked resources
  • πŸ’‰ Custom JavaScript injection support
  • βœ… Whitelist/allowlist domains
  • πŸ“Š Blocking statistics tracking

Getting Started #

Installation #

Add this to your pubspec.yaml:

dependencies:
  adblocker_webview: ^2.2.0

Basic Usage #

import 'package:adblocker_webview/adblocker_webview.dart';

// Initialize the controller (preferably in main())
void main() async {
  await AdBlockerWebviewController.instance.initialize(
    FilterConfig(
      filterTypes: [FilterType.easyList, FilterType.adGuard],
    ),
  );
  runApp(MyApp());
}

// Use in your widget
class MyWebView extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return AdBlockerWebview(
      url: Uri.parse('https://example.com'),
      shouldBlockAds: true,
      adBlockerWebviewController: AdBlockerWebviewController.instance,
      onLoadStart: (url) => print('Started loading: $url'),
      onLoadFinished: (url) => print('Finished loading: $url'),
      onLoadError: (url, code) => print('Error: $code'),
      onProgress: (progress) => print('Progress: $progress%'),
    );
  }
}

Loading HTML Content #

AdBlockerWebview(
  initialHtmlData: '<html><body>Hello World!</body></html>',
  shouldBlockAds: true,
  adBlockerWebviewController: AdBlockerWebviewController.instance,
)

final controller = AdBlockerWebviewController.instance;

// Check if can go back
if (await controller.canGoBack()) {
  controller.goBack();
}

// Reload page
controller.reload();

// Execute JavaScript
controller.runScript('console.log("Hello from Flutter!")');

Whitelist/Blacklist Domains #

Disable ad blocking for specific trusted domains:

// Via configuration
await AdBlockerWebviewController.instance.initialize(
  FilterConfig(
    filterTypes: [FilterType.easyList],
    allowedDomains: ['trusted-site.com', 'partner.com'],
    blockedDomains: ['ads.example.com'],
  ),
);

// Dynamically at runtime
controller.addAllowedDomain('example.com');
controller.removeAllowedDomain('example.com');

// Check if a domain is whitelisted
if (controller.isAllowedDomain('https://example.com')) {
  print('Ads allowed on this site');
}

Statistics Tracking #

Track blocked resources and CSS rules applied:

// Get statistics
final stats = controller.statistics;
print('Blocked: ${stats.blockedResourceCount} resources');
print('CSS rules applied: ${stats.cssRulesAppliedCount}');
print('Top blocked domains: ${stats.blockedDomains}');

// Reset statistics (e.g., when navigating to new page)
controller.resetStatistics();

Configuration #

The WebView can be configured with various options:

AdBlockerWebview(
  url: Uri.parse('https://example.com'),
  shouldBlockAds: true,  // Enable/disable ad blocking
  adBlockerWebviewController: AdBlockerWebviewController.instance,
  onLoadStart: (url) {
    // Page started loading
  },
  onLoadFinished: (url) {
    // Page finished loading
  },
  onProgress: (progress) {
    // Loading progress (0-100)
  },
  onLoadError: (url, code) {
    // Handle loading errors
  },
  onUrlChanged: (url) {
    // URL changed
  },
);

Features in Detail #

Ad Blocking #

  • EasyList and AdGuard filter list support
  • Blocks resources before they load
  • Hides ad elements using CSS rules
  • Exception rules for whitelisting

Whitelist/Blacklist Support #

  • Configure allowed domains via FilterConfig
  • Configure blocked domains via FilterConfig
  • Add/remove domains at runtime
  • Subdomain matching (e.g., example.com allows sub.example.com)

Statistics #

  • Track blocked resource count
  • Track CSS rules applied
  • Per-domain blocking statistics
  • Reset statistics on demand

Resource Blocking #

  • Blocks trackers and unwanted resources
  • Early blocking for better performance
  • Domain-based filtering
  • Exception handling for allowed domains

Element Hiding #

  • Hides ad containers and placeholders
  • CSS-based element hiding
  • Domain-specific rules
  • Batch processing for performance

Migration Guide #

Migrating from 2.0.x to 2.2.x #

  1. Controller Initialization

    // Old (<= 2.2.0)
await AdBlockerWebviewController.instance.initialize(
  FilterConfig(
    filterTypes: [FilterType.easyList, FilterType.adGuard],
  ),
  []
);

    // New (>= 2.2.0)
await AdBlockerWebviewController.instance.initialize(
  FilterConfig(
    filterTypes: [FilterType.easyList, FilterType.adGuard],
    blockedDomains: ['ads.example.com'],
  ),
);

Migrating from 1.2.0 to 2.0.0 #

Breaking Changes

  1. Controller Initialization

    // Old (1.2.0)
final controller = AdBlockerWebviewController();
await controller.initialize();

// New (>= 2.0.0)
await AdBlockerWebviewController.instance.initialize(
  FilterConfig(
    filterTypes: [FilterType.easyList, FilterType.adGuard],
  ),
  []
);

  2. URL Parameter Type

    // Old (1.2.0)
AdBlockerWebview(
  url: "https://example.com",
  // ...
)

// New (>= 2.0.0)
AdBlockerWebview(
  url: Uri.parse("https://example.com"),
  // ...
)

  3. Filter Configuration

    // Old (1.2.0)
AdBlockerWebview(
//.. other params
  additionalHostsToBlock: ['ads.example.com'],
);

// New (>= 2.0.0)
// Use FilterConfig for configuration
await AdBlockerWebviewController.instance.initialize(
  FilterConfig(
    filterTypes: [FilterType.easyList, FilterType.adGuard],
  ),
);

  4. Event Handlers

    // Old (1.2.0)
onTitleChanged: (title) { ... }

// New (>= 2.0.0)
// Use onUrlChanged instead
onUrlChanged: (url) { ... }

Deprecated Features

  • additionalHostsToBlock parameter is removed
  • Individual controller instances are replaced with singleton
  • onTitleChanged callback is replaced with onUrlChanged

New Features

  • Singleton controller pattern for better resource management
  • Structured filter configuration using FilterConfig
  • Improved type safety with Uri for URLs
  • Enhanced filter list parsing and management
  • Better performance through early resource blocking

Steps to Migrate

  1. Update the package version in pubspec.yaml:

    dependencies:
  adblocker_webview: ^2.2.0

  2. Replace controller initialization with singleton pattern

  3. Update URL parameters to use Uri instead of String

  4. Replace deprecated callbacks with new ones

  5. Update filter configuration to use FilterConfig

  6. Test the application thoroughly after migration

Contributing #

We welcome contributions to improve the ad-blocking capabilities! Here's how you can help:

Getting Started #

  1. Fork the repository
  2. Create a new branch from main for your feature/fix
    • Use feature/ prefix for new features
    • Use fix/ prefix for bug fixes
    • Use docs/ prefix for documentation changes
  3. Make your changes
  4. Write/update tests if needed
  5. Update documentation if needed
  6. Run tests and ensure they pass
  7. Submit a pull request

Before Submitting #

  • Check that your code follows our style guide (see analysis badge)
  • Write clear commit messages
  • Include tests for new features
  • Update documentation if needed
  • Verify all tests pass

Pull Request Process #

  1. Create an issue first to discuss major changes
  2. Update the README.md if needed
  3. Update the CHANGELOG.md following semantic versioning
  4. The PR will be reviewed by maintainers
  5. Once approved, it will be merged

Code Style #

  • Follow Effective Dart guidelines
  • Use the provided analysis options
  • Run dart format before committing

License #

This project is licensed under the BSD-3-Clause License - see the LICENSE file for details.

← Metadata

20
likes
160
points
485
downloads

Publisher

verified publisherislamdidarmd.dev

Weekly Downloads

Metadata

A webview for flutter with adblocking capability. It's currently based on Official Flutter Webview Plugin.

Repository (GitHub)
View/report issues

Documentation

API reference

License

BSD-3-Clause (license)

Dependencies

adblocker_manager, flutter, webview_flutter, webview_flutter_android, webview_flutter_wkwebview

More

Packages that depend on adblocker_webview

Back