Search packages, repositories and app categories

GitHub repositoryMardaneus86/touch_indicator

touch_indicator

Flutter plugin to show consistent touch indicators on iOS and Android while screencasting or recording videos

touch_indicator project cover
Stars
13
Forks
6
Last push (UTC)
Jul 26, 2024
Project status
Active

Original README

English project snapshot. Visit GitHub for the latest content.

touch_indicator

When you are recording a screencast of your app, you often want to give visual indication of where your fingers are touching the screen. Showing that on Android is easy. On iOS it's less intuitive. touch_indicator makes it easier and consistent on both platforms.

You add this widget as the main widget where you want to display user touches. Usually this will be the direct child of your MaterialApp. It will show an indicator on every touching finger and is completely customizable.

Installation

Add the plugin to your pubspec.yaml:

dependencies:
  touch_indicator: ^2.0.0

Usage

Import the package in your Dart code:

import 'package:touch_indicator/touch_indicator.dart';

Wrap all routes in your app in the TouchIndicator widget:

class MyApp extends StatelessWidget {
  MaterialApp(
    title: 'Touch indicator example',
    builder: (context, child) => TouchIndicator(child: child!),
    home: MyHomePage(title: 'Flutter Demo Home Page'),
  );
}

Customization options

indicatorColor

Changes the color of the backdrop and icon. Default is Colors.blueGrey.

indicatorSize

Changes the size of the indicator. Default is 40.0.

indicator

By adding a Widget here, you can change the complete look of the touch indicators. Make sure to supply a proper indicatorSize in order for the indicators to be positioned at the center of your touchpoints.

forceInReleaseMode

When you want to show indicators when the app is running in release mode, make sure to enable this option. Default is false.

enabled

You can enable or disable display of the indicators on the fly with this option. Default is true.

Tim Klingeleers GitHub avatar
GitHub author

Tim Klingeleers ↗

LanguagesDart

Categories

Packages published by this repository

Dependencies used

Dependency list 3 items

  • flutter{"sdk":"flutter"}
  • flutter_testDevelopment{"sdk":"flutter"}
  • pedanticDevelopment^1.4.0

How do I choose a repository?

Start with your use case, compare repository activity, and check the original project before adopting it.

  1. Search by repository name, owner or description, then narrow the results by topic.
  2. Compare stars, forks and recent pushes. Stars show community interest, not a guarantee of quality.
  3. Read the README, license and issues on GitHub before using a project.

Sources and maintenance

“A repository is the most basic element of GitHub.”

GitHub Docs — About repositories ↗