Search packages, repositories and app categories

GitHub repositoryalihadi5125/smooth_compass

smooth_compass

alihadi5125/smooth_compass open-source repository details.

smooth_compass project cover
Stars
10
Forks
18
Last push (UTC)
Sep 12, 2022
Project status
Active

Original README

English project snapshot. Visit GitHub for the latest content.

Smooth Compass

Customizable flutter package to find direction using device motion sensors.

Image Image
SmoothCompass with default Widget SmoothCompass with custom Widget

Features

  • Extensive, yet easy to use
  • Preconfigured UI with customizable styling
  • Custom builder
  • Locale support
  • Smooth Rotation
  • Values in degrees

Usage

Make sure to check out examples

Installation

Add the following line to pubspec.yaml:

dependencies:
  smooth_compass: ^1.0.2
Basic setup

The complete example is available here.

SmoothCompass requires you to provide compassBuilder which returns:

  • degrees is the directional value.
  • turns is the value for compass rotation.
  • compassAsset the (default) widget for compass.

SmoothCompass Optional Arguments Height, Width, Duration and compassAsset:

  • compassAsset is the customizable widget for compass. if not provider default will shown.

Default Widget:

SmoothCompass(
 rotationSpeed: 200,
 height: 300,
 width: 300,
// compassAsset:CustomWidget(),   you custom compass widget here
 compassBuilder: (context,AsyncSnapshot<CompassModel>? compassData,Widget compassAsset){
   return compassAsset;
    },
  ),

Custom Widget:

SmoothCompass(
 rotationSpeed: 200,
 height: 300,
 width: 300,
  compassAsset:Container(
  height:200,
  width:200,
    decoration:BoxDecoration(
    shape:BoxShape.circle,
    image:DecorationImage(
    image:AssetImage("path for compass image"),
    fit:BoxFit.cover
   )
  ),
),
 compassBuilder: (context,AsyncSnapshot<CompassModel>? compassData,Widget compassAsset){
   return compassAsset;
    },
  ),
Support

for any queries or issue contact at:

  • alihadi5125@gmail.com
  • fadiktk000@gmail.com
Muhammad Ali GitHub avatar
GitHub author

Muhammad Ali ↗

Senior Flutter Developer at JMM Technologies.

JMM TechnologiesAbbottabad, KPK, Pakistan
LanguagesDartRubySwiftKotlinObjective-C

Packages published by this repository

Dependencies used

Dependency list 5 items

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 ↗