blob: 50035db91482be1fdd02b0bb2203deafa3d48719 [file] [log] [blame] [view]
# path_provider_platform_interface
A common platform interface for the [`path_provider`][1] plugin.
This interface allows platform-specific implementations of the `path_provider`
plugin, as well as the plugin itself, to ensure they are supporting the
same interface.
# Usage
To implement a new platform-specific implementation of `path_provider`, extend
[`PathProviderPlatform`][2] with an implementation that performs the
platform-specific behavior, and when you register your plugin, set the default
`PathProviderPlatform` by calling
`PathProviderPlatform.instance = MyPlatformPathProvider()`.
# Note on breaking changes
Strongly prefer non-breaking changes (such as adding a method to the interface)
over breaking changes for this package.
See https://flutter.dev/go/platform-interface-breaking-changes for a discussion
on why a less-clean interface is preferable to a breaking change.
[1]: ../
[2]: lib/path_provider_platform_interface.dart