updated README
This commit is contained in:
Lorenzo Pichilli
parent
d57d1aecfb
commit
6d525a9790
@ -3,6 +3,7 @@
|
|||||||
### BREAKING CHANGES
|
### BREAKING CHANGES
|
||||||
|
|
||||||
- Plugin conversion to a [Federated Plugin](https://docs.flutter.dev/packages-and-plugins/developing-packages#federated-plugins) to better support multiple environments and implementations.
|
- Plugin conversion to a [Federated Plugin](https://docs.flutter.dev/packages-and-plugins/developing-packages#federated-plugins) to better support multiple environments and implementations.
|
||||||
|
- Dart SDK min version `>= 2.17.0`
|
||||||
- Android package name has been changed to `com.pichillilorenzo.flutter_inappwebview_android`. References to old package name `com.pichillilorenzo.flutter_inappwebview` should be updated, for example inside `AndroidManifest.xml` file: `<provider android:name="com.pichillilorenzo.flutter_inappwebview_android.InAppWebViewFileProvider" android:authorities="${applicationId}.flutter_inappwebview_android.fileprovider" ...`
|
- Android package name has been changed to `com.pichillilorenzo.flutter_inappwebview_android`. References to old package name `com.pichillilorenzo.flutter_inappwebview` should be updated, for example inside `AndroidManifest.xml` file: `<provider android:name="com.pichillilorenzo.flutter_inappwebview_android.InAppWebViewFileProvider" android:authorities="${applicationId}.flutter_inappwebview_android.fileprovider" ...`
|
||||||
- Web Platform: `web_support.js` file path has been changed to `packages/flutter_inappwebview_web/assets/web/web_support.js`
|
- Web Platform: `web_support.js` file path has been changed to `packages/flutter_inappwebview_web/assets/web/web_support.js`
|
||||||
|
|
||||||
|
|||||||
@ -1,15 +1,13 @@
|
|||||||
# flutter_inappwebview_android
|
# flutter\_inappwebview\_android
|
||||||
|
|
||||||
Android implementation of the flutter_inappwebview plugin.
|
The Android WebView implementation of [`flutter_inappwebview`][https://pub.dev/packages/flutter_inappwebview].
|
||||||
|
|
||||||
## Getting Started
|
## Usage
|
||||||
|
|
||||||
This project is a starting point for a Flutter
|
This package is [endorsed][https://flutter.dev/docs/development/packages-and-plugins/developing-packages#endorsed-federated-plugin],
|
||||||
[plug-in package](https://flutter.dev/developing-packages/),
|
which means you can simply use `flutter_inappwebview`
|
||||||
a specialized package that includes platform-specific implementation code for
|
normally. This package will be automatically included in your app when you do,
|
||||||
Android and/or iOS.
|
so you do not need to add it to your `pubspec.yaml`.
|
||||||
|
|
||||||
For help getting started with Flutter development, view the
|
|
||||||
[online documentation](https://flutter.dev/docs), which offers tutorials,
|
|
||||||
samples, guidance on mobile development, and a full API reference.
|
|
||||||
|
|
||||||
|
However, if you `import` this package to use any of its APIs directly, you
|
||||||
|
should add it to your `pubspec.yaml` as usual.
|
||||||
@ -1,15 +1,13 @@
|
|||||||
# flutter_inappwebview_ios
|
# flutter\_inappwebview\_ios
|
||||||
|
|
||||||
A new Flutter project.
|
The Apple iOS WKWebView implementation of [`flutter_inappwebview`][https://pub.dev/packages/flutter_inappwebview].
|
||||||
|
|
||||||
## Getting Started
|
## Usage
|
||||||
|
|
||||||
This project is a starting point for a Flutter
|
This package is [endorsed][https://flutter.dev/docs/development/packages-and-plugins/developing-packages#endorsed-federated-plugin],
|
||||||
[plug-in package](https://flutter.dev/developing-packages/),
|
which means you can simply use `flutter_inappwebview`
|
||||||
a specialized package that includes platform-specific implementation code for
|
normally. This package will be automatically included in your app when you do,
|
||||||
Android and/or iOS.
|
so you do not need to add it to your `pubspec.yaml`.
|
||||||
|
|
||||||
For help getting started with Flutter development, view the
|
|
||||||
[online documentation](https://flutter.dev/docs), which offers tutorials,
|
|
||||||
samples, guidance on mobile development, and a full API reference.
|
|
||||||
|
|
||||||
|
However, if you `import` this package to use any of its APIs directly, you
|
||||||
|
should add it to your `pubspec.yaml` as usual.
|
||||||
@ -1,15 +1,13 @@
|
|||||||
# flutter_inappwebview_macos
|
# flutter\_inappwebview\_macos
|
||||||
|
|
||||||
A new Flutter project.
|
The Apple macOS WKWebView implementation of [`flutter_inappwebview`][https://pub.dev/packages/flutter_inappwebview].
|
||||||
|
|
||||||
## Getting Started
|
## Usage
|
||||||
|
|
||||||
This project is a starting point for a Flutter
|
This package is [endorsed][https://flutter.dev/docs/development/packages-and-plugins/developing-packages#endorsed-federated-plugin],
|
||||||
[plug-in package](https://flutter.dev/developing-packages/),
|
which means you can simply use `flutter_inappwebview`
|
||||||
a specialized package that includes platform-specific implementation code for
|
normally. This package will be automatically included in your app when you do,
|
||||||
Android and/or iOS.
|
so you do not need to add it to your `pubspec.yaml`.
|
||||||
|
|
||||||
For help getting started with Flutter development, view the
|
|
||||||
[online documentation](https://flutter.dev/docs), which offers tutorials,
|
|
||||||
samples, guidance on mobile development, and a full API reference.
|
|
||||||
|
|
||||||
|
However, if you `import` this package to use any of its APIs directly, you
|
||||||
|
should add it to your `pubspec.yaml` as usual.
|
||||||
@ -1,39 +1,23 @@
|
|||||||
<!--
|
# flutter\_inappwebview\_platform\_interface
|
||||||
This README describes the package. If you publish this package to pub.dev,
|
|
||||||
this README's contents appear on the landing page for your package.
|
|
||||||
|
|
||||||
For information about how to write a good package README, see the guide for
|
A common platform interface for the [`flutter_inappwebview`][https://pub.dev/packages/flutter_inappwebview] plugin.
|
||||||
[writing package pages](https://dart.dev/guides/libraries/writing-package-pages).
|
|
||||||
|
|
||||||
For general information about developing packages, see the Dart guide for
|
This interface allows platform-specific implementations of the `flutter_inappwebview`
|
||||||
[creating packages](https://dart.dev/guides/libraries/create-library-packages)
|
plugin, as well as the plugin itself, to ensure they are supporting the
|
||||||
and the Flutter guide for
|
same interface.
|
||||||
[developing packages and plugins](https://flutter.dev/developing-packages).
|
|
||||||
-->
|
|
||||||
|
|
||||||
TODO: Put a short description of the package here that helps potential users
|
# Usage
|
||||||
know whether this package might be useful for them.
|
|
||||||
|
|
||||||
## Features
|
To implement a new platform-specific implementation of `flutter_inappwebview`, extend
|
||||||
|
[`InAppWebViewPlatform`](lib/src/inappwebview_platform.dart) with an implementation that performs the
|
||||||
|
platform-specific behavior, and when you register your plugin, set the default
|
||||||
|
`InAppWebViewPlatform` by calling
|
||||||
|
`InAppWebViewPlatform.instance = MyPlatformWebview()`.
|
||||||
|
|
||||||
TODO: List what your package can do. Maybe include images, gifs, or videos.
|
# Note on breaking changes
|
||||||
|
|
||||||
## Getting started
|
Strongly prefer non-breaking changes (such as adding a method to the interface)
|
||||||
|
over breaking changes for this package.
|
||||||
|
|
||||||
TODO: List prerequisites and provide or point to information on how to
|
See https://flutter.dev/go/platform-interface-breaking-changes for a discussion
|
||||||
start using the package.
|
on why a less-clean interface is preferable to a breaking change.
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
TODO: Include short and useful examples for package users. Add longer examples
|
|
||||||
to `/example` folder.
|
|
||||||
|
|
||||||
```dart
|
|
||||||
const like = 'sample';
|
|
||||||
```
|
|
||||||
|
|
||||||
## Additional information
|
|
||||||
|
|
||||||
TODO: Tell users more about the package: where to find more information, how to
|
|
||||||
contribute to the package, how to file issues, what response they can expect
|
|
||||||
from the package authors, and more.
|
|
||||||
@ -1,15 +1,14 @@
|
|||||||
# flutter_inappwebview_web
|
# flutter\_inappwebview\_web
|
||||||
|
|
||||||
A new Flutter project.
|
The Web Platform [iframe](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe)
|
||||||
|
implementation of [`flutter_inappwebview`][https://pub.dev/packages/flutter_inappwebview].
|
||||||
|
|
||||||
## Getting Started
|
## Usage
|
||||||
|
|
||||||
This project is a starting point for a Flutter
|
This package is [endorsed][https://flutter.dev/docs/development/packages-and-plugins/developing-packages#endorsed-federated-plugin],
|
||||||
[plug-in package](https://flutter.dev/developing-packages/),
|
which means you can simply use `flutter_inappwebview`
|
||||||
a specialized package that includes platform-specific implementation code for
|
normally. This package will be automatically included in your app when you do,
|
||||||
Android and/or iOS.
|
so you do not need to add it to your `pubspec.yaml`.
|
||||||
|
|
||||||
For help getting started with Flutter development, view the
|
|
||||||
[online documentation](https://flutter.dev/docs), which offers tutorials,
|
|
||||||
samples, guidance on mobile development, and a full API reference.
|
|
||||||
|
|
||||||
|
However, if you `import` this package to use any of its APIs directly, you
|
||||||
|
should add it to your `pubspec.yaml` as usual.
|
||||||
Loading…
x
Reference in New Issue
Block a user