Giter Club home page Giter Club logo

ttpho / flutter_tilt Goto Github PK

View Code? Open in Web Editor NEW

This project forked from fluttercandies/flutter_tilt

1.0 1.0 0.0 24.79 MB

๐Ÿ‘€ Easily apply tilt parallax hover effects for Flutter, which supports tilt, light, shadow effects, and gyroscope sensors | ๅœจ Flutter ไธŠ่ฝปๆพๅˆ›ๅปบๅ€พๆ–œ่ง†ๅทฎๆ‚ฌๅœๆ•ˆๆžœ๏ผŒๆ”ฏๆŒๅ€พๆ–œใ€ๅ…‰็…งใ€้˜ดๅฝฑๆ•ˆๆžœๅ’Œ้™€่žบไปชไผ ๆ„Ÿๅ™จ

Home Page: https://pub.dev/packages/flutter_tilt

License: MIT License

Dart 100.00%

flutter_tilt's Introduction

GitHub stars Pub.dev likes

๐Ÿ““ Language: English | ไธญๆ–‡
๐ŸŽ Check out the Live Demo.
๐Ÿ’ก See the Migration Guide to learn how to migrate between breaking changes.



Flutter Tilt

stable package dev package pub points CodeFactor codecov top language

Easily Apply Tilt Parallax Hover Effects for Flutter!


Example Preview GIF Example Preview GIF - Parallax image
Example Preview GIF - Layout

Check out the Live Demo.


Table of contents ๐Ÿช„


Features โœจ

  • ๐Ÿ“ฆ Tilt effect
  • ๐Ÿ”ฆ Light effect
  • ๐Ÿ’ก Shadow effect
  • ๐Ÿ‘€ Parallax effect
  • ๐Ÿ“ฑ Gyroscope sensor support (Sensors compatibility)
  • ๐Ÿงฑ Multiple layouts
  • ๐Ÿ‘‡ Supports hover, touch and sensors events
  • ๐Ÿ–ผ๏ธ Smooth animation
  • โš™๏ธ Many custom parameters

Install ๐ŸŽฏ

Versions compatibility ๐Ÿฆ

Flutter 3.0.0+ 3.3.0+
flutter_tilt 2.0.0+ โŒ โœ…
flutter_tilt 1.0.0+ โœ… โŒ

Add package ๐Ÿ“ฆ

Run this command with Flutter,

$ flutter pub add flutter_tilt

or add flutter_tilt to pubspec.yaml dependencies manually.

dependencies:
  flutter_tilt: ^latest_version

Sensors compatibility ๐Ÿ“ฑ

Sensors are triggered only on these platforms.

Android iOS Web (HTTPS) macOS Linux Windows
โœ… โœ… Browser compatibility โŒ โŒ โŒ

Gesture priority ๐Ÿ“ฑ

When multiple gestures are enabled, they are triggered based on priority:

Touch > Hover > Sensors

Simple usage ๐Ÿ“–

Example: flutter_tilt/example

Tilt ๐Ÿ“ฆ

Tilt widget will have default tilt, shadow, and light effects.

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

...
Tilt(
  child: Container(
    width: 150.0,
    height: 300.0,
    color: Colors.grey,
  ),
),
... 

Parallax ๐Ÿ‘€

TiltParallax widget can only be used in the childLayout of Tilt widget.

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

...
Tilt(
  childLayout: const ChildLayout(
    outer: [
      /// Parallax here
      Positioned(
        child: TiltParallax(
          child: Text('Parallax'),
        ),
      ),
      /// Parallax here
      Positioned(
        top: 20.0,
        left: 20.0,
        child: TiltParallax(
          size: Offset(-10.0, -10.0),
          child: Text('Tilt'),
        ),
      ),
    ],
  ),
  child: Container(
    width: 150.0,
    height: 300.0,
    color: Colors.brown,
  ),
),
... 

Usage ๐Ÿ“–

Tilt widget parameters ๐Ÿค–

Parameter Type Default Description
child required Widget - Create a widget that its child widget can be tilted.
childLayout ChildLayout ChildLayout() Other child layouts.
e.g. parallax inner, outer, behind.
disable bool false Disable all effects.
fps int 60 Gesture triggered frames.
border BoxBorder? null BoxDecoration border.
borderRadius BorderRadiusGeometry? null BoxDecoration borderRadius.
clipBehavior Clip Clip.antiAlias Flutter clipBehavior.
tiltConfig TiltConfig TiltConfig() Tilt effect config.
lightConfig LightConfig LightConfig() Light effect config.
shadowConfig ShadowConfig ShadowConfig() Shadow effect config.
onGestureMove void Function(TiltDataModel, GesturesType)? null Gesture move callback.
onGestureLeave void Function(TiltDataModel, GesturesType)? null Gesture leave callback.

TiltParallax widget parameters ๐Ÿค–

Parameter Type Default Description
child required Widget - Create a widget with parallax.
size Offset Offset(10.0, 10.0) Parallax size (pixel).
filterQuality FilterQuality null Flutter FilterQuality.

ChildLayout ๐Ÿ“„

Parameter Type Default Description
outer List<Widget> <Widget>[] As with Stack, you can use the Stack layout to create widgets that are outer of the child.
e.g. parallax effects.
inner List<Widget> <Widget>[] As with Stack, you can use the Stack layout to create widgets that are inner of the child.
e.g. parallax effects.
behind List<Widget> <Widget>[] As with Stack, you can use the Stack layout to create widgets that are behind of the child.
e.g. parallax effects.

TiltConfig ๐Ÿ“„

Parameter Type Default Description
disable bool false Only disable the tilt effect.
initial Offset? null Initial tilt progress, range (x, y): (1, 1) to (-1, -1),
you can exceed the range, but the maximum tilt angle during gesture movement is always tilted according to [TiltConfig.angle].
e.g. (0.0, 0.0) center
(1.0, 1.0) Maximum tilt top left [TiltConfig.angle].
angle double 10.0 Maximum tilt angle.
e.g. 180 will flip.
direction List<TiltDirection>? null Tilt Direction, multiple directions, customized direction values.
enableReverse bool false Tilt reverse, can be tilted up or down.
filterQuality FilterQuality null Flutter FilterQuality.
enableGestureSensors bool true Gyroscope sensor triggered tilt.
sensorFactor double 10.0 Sensor trigger factor (sensitivity).
enableSensorRevert bool true Enable sensor tilt revert, will revert to the initial state.
sensorRevertFactor double 0.05 Sensor revert factor (damping), range of values: 0-1.
sensorMoveDuration Duration Duration(milliseconds: 50) Animation duration during sensor move.
enableGestureHover bool true Hover gesture triggered tilt.
enableGestureTouch bool true Touch gesture triggered tilt.
enableRevert bool true Enable tilt tevert, will revert to the initial state (touch, hover gestures only).
enableOutsideAreaMove bool true Tilt can continue to be triggered outside the area.
(only when the pointer is pressed and moved)
moveDuration Duration Duration(milliseconds: 100) Animation duration during gesture move (touch, hover gestures only).
leaveDuration Duration Duration(milliseconds: 300) Animation duration after gesture leave (touch, hover gestures only).
moveCurve Curve Curves.linear Animation curve during gesture move (touch, hover gestures only).
leaveCurve Curve Curves.linear Animation curve after gesture leave (touch, hover gestures only).

LightConfig ๐Ÿ“„

Parameter Type Default Description
disable bool false Only disable the light effect.
color Color Color(0xFFFFFFFF) Light color.
minIntensity double 0.0 Color minimum opacity, also initial opacity.
maxIntensity double 0.5 Color maximum opacity for tilt progresses.
direction LightDirection LightDirection.around Light direction.
Affects:
[ShadowConfig.direction] (not affected after configuration).
enableReverse bool false Reverse light direction.
Affects:
[ShadowConfig.direction] (not affected after configuration).
[ShadowConfig.enableReverse] (not affected after configuration).

ShadowConfig ๐Ÿ“„

Parameter Type Default Description
disable bool false Only disable the shadow effect.
color Color Color(0xFF9E9E9E) Shadow color.
minIntensity double 0.0 Color minimum opacity, also initial opacity.
maxIntensity double 0.5 Color maximum opacity as tilt progresses.
offsetInitial Offset Offset(0.0, 0.0) Initial value of shadow offset (pixel).
e.g. (0.0, 0.0) center.
(40.0, 40.0) Offset 40 pixels to the top left.
offsetFactor double 0.1 Shadow offset factor, relative to current widget size.
spreadInitial double 0.0 Initial value of shadow spread radius (pixel).
spreadFactor double 0.0 Shadow spread radius factor, relative to current widget size.
minBlurRadius double 10.0 Minimum blur radius, also initial blur radius.
maxBlurRadius double 20.0 Maximum blur radius for tilt progresses.
direction ShadowDirection? null Shadow direction.
enableReverse bool? null Reverse shadow direction.

License ๐Ÿ“„

MIT License
Open sourced under the MIT license.

ยฉ AmosHuKe

flutter_tilt's People

Contributors

amoshuke avatar

Stargazers

Dung Nguyen avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.