Skip to content
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.

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

[FEATURE] Document iOS Shake Detection Limitations #246

Open
MrLepage opened this issue Jan 8, 2025 · 0 comments
Open

[FEATURE] Document iOS Shake Detection Limitations #246

MrLepage opened this issue Jan 8, 2025 · 0 comments
Assignees
Labels
enhancement New feature or request new issue New issue which has not been checked yet

Comments

@MrLepage
Copy link

MrLepage commented Jan 8, 2025

Description

The shake detection feature is currently not enabled for iOS:

if (OperatingSystem.isAndroid || OperatingSystem.isMacOS) {
    _shakeDetector = ShakeDetector.autoStart(
        onPhoneShake: navigateToCallListScreen,
        shakeThresholdGravity: 4,
    );
}

However, this limitation is not documented anywhere in the README or API documentation. Users might expect shake detection to work on iOS since it's not explicitly mentioned as unsupported.

Proposed Documentation Update

Add a note in the README and API documentation about platform support.

Why

Clear documentation about platform support helps users:

  1. Understand what features to expect on each platform
  2. Plan alternative implementations if needed
  3. Avoid spending time debugging "non-working" features

Question

Could you explain why shake detection is not activated on iOS?
Is there a technical limitation or specific reason for this platform exclusion?

@MrLepage MrLepage added enhancement New feature or request new issue New issue which has not been checked yet labels Jan 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request new issue New issue which has not been checked yet
Projects
None yet
Development

No branches or pull requests

2 participants