Flutter触摸涟漪效果插件ripple_touch的使用

添加一个触摸时的涟漪效果。

安装

在你的 pubspec.yaml 文件的依赖项中添加 ripple_touch。然后导入它：

import 'package:ripple_touch/RippleManager.dart';

如何使用

在应用启动时初始化叠加层（推荐）。

// 初始化
@override
void initState() {
  super.initState();
  Future.delayed(Duration.zero).then((value) => RippleManager().init(context));
}

// 销毁
RippleManager().dispose();

对于更详细的示例，请查看 example 文件夹。

示例

以下是一个完整的示例代码，展示了如何在 Flutter 应用中使用 ripple_touch 插件。

import 'package:flutter/material.dart';
import 'package:ripple_touch/RippleManager.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(colorScheme: ColorScheme.fromSeed(seedColor: Colors.teal), useMaterial3: false,),
      home: const MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key});

  @override
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {

  @override
  void initState() {
    super.initState();
    Future.delayed(Duration.zero).then((value) => RippleManager().init(
      context,
      fadeInDuration: const Duration(milliseconds: 300),
      fadeOutDuration: const Duration(milliseconds: 0),
      enableRippleOnSwipe: true,
      isAnimationReverse: true,  // 反向动画
      extraScale: 0.0, // 新增参数
    ));
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        backgroundColor: Colors.teal,
        title: const Text("Demo"),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            const Text('Tap anywhere in the app'),
            MaterialButton(
              color: Colors.orange[300],
              child: const Text("Navigate to newPage"),
              onPressed: () {
                Navigator.of(context).push(MaterialPageRoute(builder: (context) => const PageTwo()));
              },
            )
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton.extended(
        label: const Text("Use custom touch widget"),
        icon: const Icon(Icons.star),
        backgroundColor: Colors.teal[300],
        onPressed: () {
          RippleManager().dispose();
          RippleManager().init(context, customChild: const Icon(Icons.star, color: Colors.orange, size: 50));
        },
      ),
    );
  }
}

class PageTwo extends StatefulWidget {
  const PageTwo({super.key});

  @override
  State<PageTwo> createState() => _PageTwoState();
}

class _PageTwoState extends State<PageTwo> {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        backgroundColor: Colors.teal,
        title: const Text("page Two"),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            MaterialButton(
              color: Colors.indigo[200],
              child: const Text("Navigate back"),
              onPressed: () {
                Navigator.of(context).pop();
              },
            )
          ],
        ),
      ),
    );
  }
}

演示

如果你缺少了某些功能或有任何问题，请随时提交一个 issue 或贡献代码！