plugin_platform_interface
2.1.8, released 3 years ago by flutter.dev
Reusable base class for platform interfaces of Flutter federated plugins.
WASM-readyQuiet but busy
What it does
Provides a base class and verification mechanism for platform interfaces of federated Flutter plugins. It enforces that platform implementations extend rather than implement the interface, ensuring safety when new methods are added.
AI-written summary of version 2.1.8, based on the package's README and metadata. Report an inaccuracy
Use it when
- You are developing a federated Flutter plugin
- You want to enforce that platform implementations extend the platform interface class rather than implement it
Skip it when
- You are building a standard non-federated app or package
- You prefer using Dart 3 base classes exclusively for enforcement without runtime checks
Strengths
- Enforces best practices for federated plugin architecture
- Provides MockPlatformInterfaceMixin for easy mocking and faking in tests
Weaknesses
- May be considered redundant in Dart 3 projects that can utilize the `base` class modifier directly
Setup
- Kind
- Pure Dart
- Effort
- Low
- Code generation
- No
- Direct dependencies
- 1
Not documented
abstract class SamplePluginPlatform extends PlatformInterface {
SamplePluginPlatform() : super(token: _token);
static final Object _token = Object();
static SamplePluginPlatform _instance = SamplePluginDefault();
static SamplePluginPlatform get instance => _instance;
static set instance(SamplePluginPlatform instance) {
PlatformInterface.verify(instance, _token);
_instance = instance;
}
}Alternatives
Packages that do the same job and could replace plugin_platform_interface.
- irondash_message_channel
Rust-to-Dart bridge mimicking Flutter's platform channel via FFI without code generation.
50Compare
Works with
Packages commonly used together with plugin_platform_interface: ones it builds on, ones built on it, and its own family.
- flutter_plugin_android_lifecycleSame familyFlutter plugin for accessing Android Lifecycle within other plugins.
- flutter_plugin_toolsSame familyCLI tool for managing, testing, and releasing packages across Flutter team repositories
- jniBuilt on plugin_platform_interfaceProvides Dart/Flutter bindings to call native Java code via JNI.
- flutter_local_notifications_platform_interfaceBuilt on plugin_platform_interfaceA common platform interface for the flutter_local_notifications plugin.
- mobile_scannerBuilt on plugin_platform_interfaceUniversal Flutter barcode and QR code scanner using native ML Kit, Vision, and ZXing.
- audioplayers_platform_interfaceBuilt on plugin_platform_interfacePlatform interface for the audioplayers Flutter plugin.
- file_picker_platform_interfaceBuilt on plugin_platform_interfaceCommon platform interface for the file_picker federated plugin.
- just_audio_platform_interfaceBuilt on plugin_platform_interfaceA platform interface for the just_audio plugin, defining the contract for platform-specific implementations.