Skip to content

[pointer_interceptor] Add iOS implementation and platform interface #5233

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
LouiseHsu wants to merge 57 commits into from
Closed

[pointer_interceptor] Add iOS implementation and platform interface #5233

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
57 commits
Select commit Hold shift + click to select a range
e10c9d8
initial working commit
LouiseHsu Oct 25, 2023
6d3f6ca
fixed compiler error, move testing factory to runner, remove default …
LouiseHsu Oct 25, 2023
f16a10b
clean up, remove dependency on ios version
LouiseHsu Oct 30, 2023
09fa93f
remove extraneous files in platform interface
LouiseHsu Oct 30, 2023
f04c392
unused exports
LouiseHsu Oct 30, 2023
ee38fa7
Merge branch 'main' into pointer-interceptor-ios
LouiseHsu Oct 30, 2023
6c610b9
update versioning + changelog
LouiseHsu Oct 30, 2023
45a02df
Merge branch 'pointer-interceptor-ios' of github.com:LouiseHsu/packag…
LouiseHsu Oct 30, 2023
736b4b1
fix yaml issue
LouiseHsu Oct 31, 2023
badba67
fix example
LouiseHsu Oct 31, 2023
8c979d2
fix imports
LouiseHsu Oct 31, 2023
7af12bb
some more clean up, formatting
LouiseHsu Oct 31, 2023
276461c
add publish_to none
LouiseHsu Oct 31, 2023
bda6870
remove extra analysis_options
LouiseHsu Oct 31, 2023
29a3cc1
update platform interface pubspec.yaml
LouiseHsu Oct 31, 2023
78aa1e3
add public member comments, renaming
LouiseHsu Oct 31, 2023
b9bc419
remove extraneous analysis files
LouiseHsu Oct 31, 2023
f968902
remove extra test files
LouiseHsu Nov 1, 2023
f9294ab
more linter stuff
LouiseHsu Nov 1, 2023
3854eb9
lower versioning
LouiseHsu Nov 1, 2023
ef7f76f
lower versioning for platform interface
LouiseHsu Nov 1, 2023
819d7d4
version lowering
LouiseHsu Nov 1, 2023
6067505
fixing ios plugin overriding default ios behaviour
LouiseHsu Nov 2, 2023
994a8ae
remove old ios implementation
LouiseHsu Nov 3, 2023
68a4d8c
fix tests
LouiseHsu Nov 7, 2023
2bcdde2
update ios test
LouiseHsu Nov 7, 2023
fbf0e04
formatting
LouiseHsu Nov 7, 2023
85f0899
Merge branch 'main' into pointer-interceptor-ios
LouiseHsu Nov 7, 2023
6c18fa9
pr comments, update changelog/readme
LouiseHsu Nov 8, 2023
e6a8a09
remove empty test dir in example
LouiseHsu Nov 8, 2023
a67da96
rename web.dart to pointer_interceptor_web.dart, remove "intercepting…
LouiseHsu Nov 8, 2023
f38a019
update podspec
LouiseHsu Nov 9, 2023
800fba2
update READMEs, CHANGELOGs, remove extraneous files, various clean up…
LouiseHsu Nov 10, 2023
b73c75c
move pointer_interceptor_ios into part of pointer_interceptor
LouiseHsu Nov 13, 2023
b309e31
remove accidental prints
LouiseHsu Nov 13, 2023
4edc671
add publish to none
LouiseHsu Nov 13, 2023
60ec17b
add ios configuration to example package
LouiseHsu Nov 13, 2023
7092edf
fix licensing and podfile
LouiseHsu Nov 13, 2023
196a9dd
add licensing to swift files
LouiseHsu Nov 13, 2023
d5bf4c9
podfile
LouiseHsu Nov 13, 2023
75a19a8
refactor web into own package, move integration tests, rewrite exampl…
LouiseHsu Nov 14, 2023
b53e4f8
licensing, formatting
LouiseHsu Nov 14, 2023
afb90bd
fix integration test
LouiseHsu Nov 14, 2023
7b4d1be
formatting
LouiseHsu Nov 15, 2023
fa36d02
fix pbxproj
LouiseHsu Nov 15, 2023
d40abd2
fix pbxproj?
LouiseHsu Nov 15, 2023
340bd5c
pbxproj
LouiseHsu Nov 15, 2023
a766eb8
fix ios platform tests, add unit tests
LouiseHsu Nov 15, 2023
1e5c612
pbxproj
LouiseHsu Nov 15, 2023
d8a7fd2
add placeholder integration tests
LouiseHsu Nov 16, 2023
39c0439
formatting
LouiseHsu Nov 16, 2023
0d099f4
update README
LouiseHsu Nov 16, 2023
99bfefa
Merge branch 'main' into pointer-interceptor-ios
LouiseHsu Nov 16, 2023
e8f3445
PR comments
LouiseHsu Nov 16, 2023
836cdb9
Merge branch 'pointer-interceptor-ios' of github.com:LouiseHsu/packag…
LouiseHsu Nov 16, 2023
ba3fd60
fix test
LouiseHsu Nov 16, 2023
a4df634
some pr comments
LouiseHsu Nov 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
update READMEs, CHANGELOGs, remove extraneous files, various clean up… 
…, PR comments
  • Loading branch information
@LouiseHsu
LouiseHsu committed Nov 10, 2023
commit 800fba2a13b424ddb267b60c008d4a78b3cc5832
2 changes: 1 addition & 1 deletion packages/pointer_interceptor/pointer_interceptor/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
## 0.9.4
* Add iOS implementation
* Adds iOS implementation

## 0.9.3+7

Expand Down
39 changes: 37 additions & 2 deletions packages/pointer_interceptor/pointer_interceptor/example/.metadata
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,42 @@
# This file should be version controlled and should not be manually edited.

version:
revision: e6bd95bc5caa5e34c5b0285a559673984374b7ea
channel: master
revision: "969911d1d09d6c4f145e9ce27c08093e8c285561"
channel: "main"

project_type: app

# Tracks metadata for the flutter migrate command
migration:
platforms:
- platform: root
create_revision: 969911d1d09d6c4f145e9ce27c08093e8c285561
base_revision: 969911d1d09d6c4f145e9ce27c08093e8c285561
- platform: android
create_revision: 969911d1d09d6c4f145e9ce27c08093e8c285561
base_revision: 969911d1d09d6c4f145e9ce27c08093e8c285561
- platform: ios
create_revision: 969911d1d09d6c4f145e9ce27c08093e8c285561
base_revision: 969911d1d09d6c4f145e9ce27c08093e8c285561
- platform: linux
create_revision: 969911d1d09d6c4f145e9ce27c08093e8c285561
base_revision: 969911d1d09d6c4f145e9ce27c08093e8c285561
- platform: macos
create_revision: 969911d1d09d6c4f145e9ce27c08093e8c285561
base_revision: 969911d1d09d6c4f145e9ce27c08093e8c285561
- platform: web
create_revision: 969911d1d09d6c4f145e9ce27c08093e8c285561
base_revision: 969911d1d09d6c4f145e9ce27c08093e8c285561
- platform: windows
create_revision: 969911d1d09d6c4f145e9ce27c08093e8c285561
base_revision: 969911d1d09d6c4f145e9ce27c08093e8c285561

# User provided section

# List of Local paths (relative to this file) that should be
# ignored by the migrate tool.
#
# Files that are not part of the templates will be ignored by default.
unmanaged_files:
- 'lib/main.dart'
- 'ios/Runner.xcodeproj/project.pbxproj'
10 changes: 10 additions & 0 deletions packages/pointer_interceptor/pointer_interceptor/lib/src/dummy_pointer_interceptor_ios.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,11 @@
// TODO(louisehsu): Replace this empty file with PointerInterceptorIOS Implementation.
Copy link
Collaborator

@stuartmorgan-g stuartmorgan-g Nov 9, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can presumably be reverted? The iOS implementation is its own package.

Copy link
Contributor Author

@LouiseHsu LouiseHsu Nov 9, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This actually can't be reverted, I think
Since we're trying not to break any existing implementations, I think there are cases where they are using the pointer_interceptor with ios. Currently, the ios implementation in the old pointer_interceptor package does nothing. I wanted to keep the existing no-op behaviour, but also allow them to opt in for the ios implementation
Basically since this file is empty, without the pointer_interceptor_ios plugin, it will use the NoopPointerInterceptor as a default. However, if they do use the new ios package, it will use that implementation because that's the only iOS implementation available. And since I think that theres no way to override a platform implementation with another package (flutter/flutter#80374), this is just a slightly hacky way of doing it until we make the new ios implementation the default.

Copy link
Contributor

@cyanglaz cyanglaz Nov 9, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we eventually will likely to have the new behavior to be the default, maybe we should print a message to warn users that the no-op behavior will be deprecated soon, and the developer should remove the widget if they want no-op in mobile. (and introduce how to opt-in the new plugin probably)

Copy link
Contributor Author

@LouiseHsu LouiseHsu Nov 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good! Ill add that.

Copy link
Collaborator

@stuartmorgan-g stuartmorgan-g Nov 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wanted to keep the existing no-op behaviour, but also allow them to opt in for the ios implementation
Basically since this file is empty, without the pointer_interceptor_ios plugin, it will use the NoopPointerInterceptor as a default.

You can just not have an ios entry in the app-facing package at all to get this behavior.

Copy link
Collaborator

@stuartmorgan-g stuartmorgan-g Nov 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking at pub.dev, pointer_interceptor is only used in a very small number of published packages; presumably most of the use is in applications. Given that, I would just make adding the iOS implementation a breaking version change, rather than have a warning->deprecation->replacement cycle (which would need to end with a breaking version change anyway).

Copy link
Contributor Author

@LouiseHsu LouiseHsu Nov 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay! If we're okay with breaking changes, Ill go ahead and refactor pointer_interceptor_ios to be part of the package. it's definitely cleaner, anyways.


/***=
* This file is a temporary solution as this allows existing usages of PointerInterceptor
* on iOS to maintain their no-op behaviour. Eventually, this file will be replaced with the
* iOS implementation of pointer_interceptor.
*
* Please note this no-op behavior is being deprecated soon, so developers should remove
* the widget from mobile. If you wish to instead opt-in to the new iOS implementation,
* please include both pointer_interceptor_ios and pointer_interceptor in your pubspec.yaml
*/
9 changes: 5 additions & 4 deletions packages/pointer_interceptor/pointer_interceptor/lib/src/pointer_interceptor_web.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,11 @@ class PointerInterceptorWeb extends PointerInterceptorPlatform {
}

@override
Widget buildWidget(
{required Widget child,
bool debug = false,
Key? key}) {
Widget buildWidget({
required Widget child,
bool debug = false,
Key? key,
}) {
final String viewType = _getViewType(debug: debug);

if (!_registered) {
Expand Down
4 changes: 1 addition & 3 deletions packages/pointer_interceptor/pointer_interceptor/pubspec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,7 @@ dependencies:
dev_dependencies:
flutter_test:
sdk: flutter
# pointer_interceptor_ios:
# path: ../pointer_interceptor_ios

topics:
- web
- widgets
- widgets
2 changes: 1 addition & 1 deletion packages/pointer_interceptor/pointer_interceptor_ios/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## 1.0.0
## 0.9.0

* Initial release.

17 changes: 6 additions & 11 deletions packages/pointer_interceptor/pointer_interceptor_ios/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,10 @@
# pointer_interceptor_ios
# pointer\_interceptor\_ios

A new Flutter plugin project.
The iOS implementation of [`pointer interceptor`][1].

## Getting Started
## Usage

This project is a starting point for a Flutter
[plug-in package](https://flutter.dev/developing-packages/),
a specialized package that includes platform-specific implementation code for
Android and/or iOS.

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.
This package is NOT [endorsed][2]. To use this package, please include this into your `pubspec.yaml` along with [`pointer_interceptor`][1].

[1]: https://pub.dev/packages/pointer_interceptor
[2]: https://flutter.dev/docs/development/packages-and-plugins/developing-packages#endorsed-federated-plugin
21 changes: 7 additions & 14 deletions packages/pointer_interceptor/pointer_interceptor_ios/example/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,9 @@
# pointer_interceptor_ios_example
# Platform Implementation Test App

Demonstrates how to use the pointer_interceptor_ios plugin.
This is a test app for manual testing and automated integration testing
of this platform implementation. It is not intended to demonstrate actual use of
this package, since the intent is that plugin clients use the app-facing
package.

## Getting Started

This project is a starting point for a Flutter application.

A few resources to get you started if this is your first Flutter project:

- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)

For help getting started with Flutter development, view the
[online documentation](https://docs.flutter.dev/), which offers tutorials,
samples, guidance on mobile development, and a full API reference.
Unless you are making changes to this implementation package, this example is
very unlikely to be relevant.
40 changes: 20 additions & 20 deletions ...es/pointer_interceptor/pointer_interceptor_ios/example/ios/Flutter/AppFrameworkInfo.plist
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,25 @@
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>CFBundleDevelopmentRegion</key>
<string>en</string>
<key>CFBundleExecutable</key>
<string>App</string>
<key>CFBundleIdentifier</key>
<string>io.flutter.flutter.app</string>
<key>CFBundleInfoDictionaryVersion</key>
<string>6.0</string>
<key>CFBundleName</key>
<string>App</string>
<key>CFBundlePackageType</key>
<string>FMWK</string>
<key>CFBundleShortVersionString</key>
<string>1.0</string>
<key>CFBundleSignature</key>
<string>????</string>
<key>CFBundleVersion</key>
<string>1.0</string>
<key>MinimumOSVersion</key>
<string>11.0</string>
<key>CFBundleDevelopmentRegion</key>
<string>en</string>
<key>CFBundleExecutable</key>
<string>App</string>
<key>CFBundleIdentifier</key>
<string>dev.flutter</string>
<key>CFBundleInfoDictionaryVersion</key>
<string>6.0</string>
<key>CFBundleName</key>
<string>pointer_interceptor_ios_example</string>
<key>CFBundlePackageType</key>
<string>FMWK</string>
<key>CFBundleShortVersionString</key>
<string>1.0</string>
<key>CFBundleSignature</key>
<string>????</string>
<key>CFBundleVersion</key>
<string>1.0</string>
<key>MinimumOSVersion</key>
<string>11.0</string>
</dict>
</plist>
Loading