show_touches 0.0.1 copy "show_touches: ^0.0.1" to clipboard
show_touches: ^0.0.1 copied to clipboard

Show finger touch effects for Flutter, with support for multiple fingers, controllers, custom widgets, and animations.

GitHub stars Pub.dev likes

πŸ““ Language: English | δΈ­ζ–‡



Show Touches

stable package dev package pub points CodeFactor codecov top language

Show finger touch effects for Flutter!


preview1.gif

Table of contents πŸͺ„ #


Features ✨ #

  • πŸ‘‡ Multiple fingers (pointers)
  • πŸ”§ Controller control
  • βš™οΈ Customizable pointer widgets and animations

Install 🎯 #

Versions compatibility 🐦 #

Flutter 3.3.0+
show_touches 0.0.1+ βœ…

Platforms compatibility πŸ“± #

Android iOS Web macOS Windows Linux
βœ… βœ… βœ… βœ… βœ… βœ…

Add package πŸ“¦ #

Run this command with Flutter,

$ flutter pub add show_touches

or add show_touches to pubspec.yaml dependencies manually.

dependencies:
  show_touches: ^latest_version

Simple usage πŸ“– #

Example: show_touches/example

ShowTouches πŸ“¦ #

ShowTouches widget will have default gesture logic and pointer widgets.

/// Import show_touches
import 'package:show_touches/show_touches.dart';

MaterialApp(
  builder: ShowTouches.init(),
  home: XxxPage(),
);

/// or

ShowTouches(child: XxxPage()),

Usage πŸ“– #

ShowTouches widget parameters πŸ€– #

Parameter Type Default Description
child required Widget - -
enable bool true true (enable)
false (disable)
controller ShowTouchesController? null ShowTouchesController to control the pointer.
pointerBuilder PointerBuilder? null Custom pointer widget, but it will cause the defaultPointerStyle to be invalid.
defaultPointerStyle DefaultPointerStyle DefaultPointerStyle() Default style for the pointer widget when pointerBuilder is not used.
showDuration Duration Duration(milliseconds: 50) Show animation duration (pointer).
removeDuration Duration Duration(milliseconds: 200) Remove animation duration (pointer).

PointerBuilder πŸ“„ #

Example:


ShowTouches(
  pointerBuilder: (
    BuildContext context,
    int pointerId,
    Offset position,
    Animation<double> animation,
  ) {
    final Animation<double> scaleAnimation = Tween<double>(
      begin: 2.0,
      end: 1.0,
    ).animate(animation);

    return Positioned(
      left: position.dx - 30.0,
      top: position.dy - 30.0,
      child: IgnorePointer(
        ignoring: true,
        child: ScaleTransition(
          scale: scaleAnimation,
          child: FadeTransition(
            opacity: animation,
            child: Container(
              width: 60,
              height: 60,
              color: Colors.black,
            ),
          ),
        ),
      ),
    );
  },
  child: XxxPage(),
),

Parameter Type Description
context BuildContext -
pointerId int Pointer (touch) ID.
position Offset Current touch position.
animation Animation<double> Animation controller.

ShowTouchesController πŸ“„ #

You can use the controller to control the pointers in the ShowTouches widget,
or you can implement your own gesture logic to control the pointers.

Example:


final ShowTouchesController controller = ShowTouchesController();

......

@override
void dispose() {
  controller.dispose();
  super.dispose();
}

......

Listener(
  onPointerDown: (event) => controller.addPointer(...),
  onPointerMove: (event) => controller.updatePointer(...),
  onPointerUp: (event) => controller.removePointer(...),
  onPointerCancel: (event) => controller.removePointer(...),
  behavior: HitTestBehavior.translucent,
  child: child,
);

Get all pointer data

controller.data to get all the pointer data (Map<int, PointerData>).

Map<int, PointerData> -> key: pointerId, value: PointerData

PointerData
Parameter Type Description
pointerId int Pointer (touch) ID.
positionState ValueNotifier<Offset> Current touch position.
animationController AnimationController Animation controller.
pointerOverlayEntry OverlayEntry? Pointer OverlayEntry.

addPointer()

Parameter Type Default Description
context required BuildContext - -
pointerId required int - Pointer (touch) ID.
position required Offset - Current touch position.
animationController required AnimationController - Animation controller.
pointerBuilder PointerBuilder? null Custom pointer widget, but it will cause the defaultPointerStyle to be invalid.
defaultPointerStyle DefaultPointerStyle DefaultPointerStyle() Default style for the pointer widget when pointerBuilder is not used.

updatePointer()

Parameter Type Default Description
pointerId required int - Pointer (touch) ID.
position required Offset - Current touch position.

removePointer()

Parameter Type Default Description
pointerId required int - Pointer (touch) ID.

disposePointer()

Parameter Type Default Description
pointerId required int - Pointer (touch) ID.

Contributors ✨ #

AmosHuKe
AmosHuKe

License πŸ“„ #

MIT License
Open sourced under the MIT license.

Β© AmosHuKe

3
likes
160
pub points
0%
popularity
screenshot

Publisher

verified publisheramooos.com

Show finger touch effects for Flutter, with support for multiple fingers, controllers, custom widgets, and animations.

Repository (GitHub)
View/report issues

Topics

#widget #pointer #touch

Documentation

API reference

License

MIT (license)

Dependencies

flutter

More

Packages that depend on show_touches