Flutter快速覆盖层插件lightning_overlay的使用

Lightning Overlay

Lightning Overlay 是一个用于任何 Widget 的快速覆盖层插件。它可以在你的任意 Widget 上创建一个漂亮的覆盖效果。

注意事项

• 如果你希望使用自动启动功能，需要设置 delayDuration。同时还需要设置 pauseDuration 来控制反向动画。如果反向动画没有开始，你需要增加 pauseDuration。
• 如果你希望使用重复模式，需要设置较高的 pauseRepeatDelay（默认为 2 秒），因为当动画完成时，pauseRepeatDelay 将被触发并重新播放动画。

模式

它支持以下几种模式：

1. 自动启动延迟
2. 受控于 Lightning 控制器
3. 手势控制
4. 重复模式

同时，它还支持以下方向：

1. 左上角到右下角
2. 右下角到左上角

API

以下是 Lightning Overlay 的 API 说明表：

控制器

创建一个控制器并传递给 Lightning Widget：

LightningController controller = LightningController();

注意：由于 animateIn 需要完成覆盖动画，所以在调用 animateOut 之前需要等待。

示例代码

下面是完整的示例代码：

import 'package:flutter/material.dart';
import 'package:lightning_overlay/lightning_overlay.dart';

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

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
      ),
      home: const LightningCard(),
    );
  }
}

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

  [@override](/user/override)
  LightningCardState createState() => LightningCardState();
}

class LightningCardState extends State<LightningCard> {
  LightningController controller = LightningController();

  void animate() async {
    controller.animateIn();
    await Future.delayed(const Duration(milliseconds: 500));
    controller.animateOut();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      backgroundColor: Colors.black,
      body: Column(
        crossAxisAlignment: CrossAxisAlignment.center,
        mainAxisAlignment: MainAxisAlignment.center,
        children: [
          Center(
            child: Lightning(
              useGesture: false,
              maxValue: 600,
              borderRadius: 15,
              repeat: true,
              delayDuration: const Duration(milliseconds: 300),
              controller: controller,
              direction: LightningDirection.leftToRight,
              pauseDuration: const Duration(milliseconds: 200),
              durationIn: const Duration(milliseconds: 300),
              durationOut: const Duration(milliseconds: 450),
              overlayColor: Colors.white.withOpacity(0.1),
              child: Container(
                height: 300,
                width: 300,
                padding: const EdgeInsets.all(20),
                decoration: BoxDecoration(
                  color: Colors.blue,
                  borderRadius: BorderRadius.circular(15),
                ),
                child: Center(
                  child: Image.network(
                    "https://storage.googleapis.com/cms-storage-bucket/0dbfcc7a59cd1cf16282.png",
                    width: 200,
                  ),
                ),
              ),
            ),
          ),
          const SizedBox(
            height: 100,
          ),
          GestureDetector(
            onTap: () => animate(),
            child: Container(
              height: 70,
              width: 200,
              decoration: BoxDecoration(
                borderRadius: BorderRadius.circular(10),
                color: Colors.blue,
              ),
              child: const Center(
                child: Text(
                  "Animate",
                  style: TextStyle(
                    color: Colors.white,
                    fontWeight: FontWeight.w700,
                    fontSize: 20,
                  ),
                ),
              ),
            ),
          )
        ],
      ),
    );
  }

  [@override](/user/override)
  void dispose() {
    super.dispose();
  }
}