पैकेज, रिपॉज़िटरी और ऐप श्रेणियाँ खोजें

पैकेज विवरणv0.6.0

chrome_extension

क्रोम एक्सटेंशन में उपलब्ध `chrome.*` API के लिए एक पुस्तकालय।

Web
30-दिन डाउनलोड
5.6 हज़ार
लाइक
65
Pub अंक
160

पैकेज इंस्टॉल करें

flutter pub add chrome_extension

पैकेज अवलोकन

सार्वजनिक जानकारी से बना चयन मार्गदर्शन। केवल संदर्भ हेतु।

एक डार्ट पैकेज जो फ्लटर वेब एप्लिकेशन में `chrome.runtime`, `chrome.storage`, और `chrome.tabs` जैसे क्रोम एक्सटेंशन एपीआई को एक्सेस करने की अनुमति देता है। फ्लटर का उपयोग करके क्रोम एक्सटेंशन बनाने वाले विकासकर्मियों के लिए विशेष रूप से डिज़ाइन किया गया, यह ब्राउज़र-स्तरीय कार्यक्षमता के साथ इंटरैक्ट करने के लिए एक प्रकार सुरक्षित इंटरफ़ेस प्रदान करता है। यह पैकेज फ्लटर की वेब क्षमताओं और मूल क्रोम एक्सटेंशन विशेषताओं के बीच अंतर को दूर करता है, जिससे बैकग्राउंड स्क्रिप्ट, पॉपअप इंटरैक्शन और स्टोरेज प्रबंधन जैसे एक्सटेंशन-विशिष्ट व्यवहार को बिना किसी बाधा के एकीकृत किया जा सकता है। इसे xaha.dev द्वारा बनाए रखा जाता है और ट्रांसपेरेंसी और समुदाय योगदान के लिए गिटहब पर होस्ट किया गया है।

उपयोग

  • Flutter के साथ Chrome एक्सटेंशन बनाना
  • वेब ऐप्स में ब्राउज़र स्टोरेज का एक्सेस करना
  • टैब और रनटाइम घटनाओं का प्रबंधन
  • पॉपअप इंटरफेस बनाना
  • बैकग्राउंड सेवाओं का कार्यान्वयन

मुख्य विशेषताएँ

  • chrome.* APIs की सीधी पहुँच
  • टाइप-सुरक्षित डार्ट वрапर्स
  • वेब के लिए सीमित संगतता
  • GitHub-आधारित स्रोत कोड
  • सरल pub add एकीकरण

इनके लिए उपयुक्त

  • Flutter web विकासकर्ता
  • Chrome एक्सटेंशन निर्माता
  • ब्राउज़र स्वचालन परियोजनाएं
  • क्रॉस-प्लेटफॉर्म एक्सटेंशन टूल्स
  • डार्ट-केंद्रित वेब ऐप निर्माता

विचार योग्य बातें

  • केवल वेब प्लेटफॉर्म पर कार्य करता है
  • क्रोम एक्सटेंशन मैनिफेस्ट सेटअप की आवश्यकता है
  • क्रोम-विशिष्ट सुविधाओं तक सीमित
  • गैर-क्रोम ब्राउज़र के साथ असंगत
  • JavaScript इंटरऑप के निर्भरता

मूल README

संबंधित सोर्स रिपॉज़िटरी के मूल README का स्नैपशॉट। नवीनतम सामग्री के लिए रिपॉज़िटरी देखें।

chrome_extension.dart

pub package Build Status

A library for accessing the chrome.* APIs available in Chrome extensions.

This allows to build Chrome extension with Dart & Flutter and to interop with the native APIs easily with a high-level type-safe interface.

The JS interop is build on top of dart:js_interop (static interop) which make it ready for future WASM compilation.

Buy Me A Coffee

Using the library

Example
chrome.tabs
import 'package:chrome_extension/tabs.dart';

void main() async {
  var tabs = await chrome.tabs.query(QueryInfo(
    active: true,
    currentWindow: true,
  ));
  print(tabs.first.title);
}
chrome.alarms
import 'package:chrome_extension/alarms.dart';

void main() async {
  await chrome.alarms.create('MyAlarm', AlarmCreateInfo(delayInMinutes: 2));

  var alarm = await chrome.alarms.get('MyAlarm');
  print(alarm!.name);
}
chrome.power
import 'package:chrome_extension/power.dart';

void main() {
  chrome.power.requestKeepAwake(Level.display);
}
chrome.runtime
import 'dart:js_interop';
import 'package:chrome_extension/runtime.dart';

void main() async {
  chrome.runtime.onInstalled.listen((e) {
    print('OnInstalled: ${e.reason}');
  });

  chrome.runtime.onMessage.listen((e) {
    e.sendResponse.callAsFunction(null, {'the_response': 1}.jsify());
  });
}
chrome.storage
import 'package:chrome_extension/storage.dart';

void main() async {
  await chrome.storage.local.set({'mykey': 'value'});
  var values = await chrome.storage.local.get(null /* all */);
  print(values['mykey']);
}
Available APIs

Documentation

Tips to build Chrome extensions with Flutter

Here are some personal tips to build Chrome extension using the Flutter UI framework.

Develop the app using Flutter Desktop

In order to develop in a comfortable environment with hot-reload, most of the app (the UI part) should be developed using Flutter desktop.

This requires an abstraction layer between the UI and the chrome_extension APIs.

In the Desktop entry point, a fake implementation of this abstraction layer is used, like this:

// lib/main_desktop.dart
void main() {
  // Inject a fake service that doesn't use the real chrome_extension package.
  var service = FakeBookmarkService();
  runApp(MyExtensionPopup(service));
}

abstract class BookmarkService {
  Future<List<Bookmark>> getBookmarks();
}

class FakeBookmarkService implements BookmarkService {
  @override
  Future<List<Bookmark>> getBookmarks() async => [Bookmark()];
}

Launch this entry point in desktop with
flutter run -t lib/main_desktop.dart -d macos|windows|linux

And the real entry point (the one used in the actual compiled extension) looks like:

// lib/main.dart
void main() {
  var service = ChromeBookmarkService();
  runApp(MyExtensionPopup(service));
}

class ChromeBookmarkService implements BookmarkService {
  @override
  Future<List<Bookmark>> getBookmarks() async {
    // Real implementation using chrome.bookmarks
    return (await chrome.bookmarks.getTree()).map(Bookmark.new).toList();
  }
}
Build script

web/manifest.json

{
  "manifest_version": 3,
  "name": "my_extension",
  "permissions": [
    "activeTab"
  ],
  "options_page": "options.html",
  "background": {
    "service_worker": "background.dart.js"
  },
  "action": {
    "default_popup": "index.html",
    "default_icon": {
      "16": "icons-16.png"
    }
  },
  "content_security_policy": {
    "extension_pages": "script-src 'self' 'wasm-unsafe-eval'; object-src 'self';"
  }
}
// tool/build.dart
void main() async {
  await _process.runProcess([
    'flutter',
    'build',
    'web',
    '-t',
    'web/popup.dart',
    '--csp',
    '--web-renderer=canvaskit',
    '--no-web-resources-cdn',
  ]);
  for (var script in [
    'background.dart',
    'content_script.dart',
    'options.dart'
  ]) {
    await _process.runProcess([
      Platform.resolvedExecutable,
      'compile',
      'js',
      'web/$script',
      '--output',
      'build/web/$script.js',
    ]);
  }
}

It builds the flutter app and compiles all the other Dart scripts (for example: options.dart.js, popup.dart.js, background.dart.js)

Testing

Write tests for the extension using puppeteer-dart.

import 'package:collection/collection.dart';
import 'package:puppeteer/puppeteer.dart';

void main() async {
  // Compile the extension
  var extensionPath = '...';

  var browser = await puppeteer.launch(
    headless: false,
    args: [
      '--disable-extensions-except=$extensionPath',
      '--load-extension=$extensionPath',
      // Allow to connect to puppeteer from inside your extension if needed for the testing
      '--remote-allow-origins=*',
    ],
  );

  // Find the background page target
  var targetName = 'service_worker';
  var backgroundPageTarget =
      browser.targets.firstWhereOrNull((t) => t.type == targetName);
  backgroundPageTarget ??=
      await browser.waitForTarget((target) => target.type == targetName);
  var worker = (await backgroundPageTarget.worker)!;

  var url = Uri.parse(worker.url!);
  assert(url.scheme == 'chrome-extension');
  var extensionId = url.host;

  // Go to the popup page
  await (await browser.pages)
      .first
      .goto('chrome-extension://$extensionId/popup.html');

  // Etc...
}

श्रेणियाँ

सोर्स रिपॉज़िटरी

इस पैकेज का उपयोग करने वाले प्रोजेक्ट

अभी कोई डेटा उपलब्ध नहीं है।