Flutter覆盖层管理插件flutter_overlay的使用

简介

flutter_overlay 是一个为Flutter提供的透明浮动层，可以编程式地显示和关闭子组件。它支持iOS、Android和Web平台。

目录

• Examples
• Getting Started
• Contribution

Examples

查看更多的例子请参考：Examples

Getting Started

Step1: 编写你的overlay

首先你需要编写你想要作为覆盖层显示的内容。以下是一个简单的对话框示例：

_dialog() {
  return GestureDetector(
    onTap: () {
      Navigator.pop(context, 'close');
    },
    child: Container(
      decoration: BoxDecoration(color: Colors.black38),
      child: Center(
        child: CircularProgressIndicator(valueColor: AlwaysStoppedAnimation(Colors.redAccent)),
      ),
    ),
  );
}

Step2: 显示你的overlay

接下来，你可以通过调用 HiOverlay.show 方法来显示这个覆盖层：

HiOverlay.show(
  context,
  child: _dialog(),
).then((value) {
  print('---received:$value');
});

Step3: 关闭你的overlay

最后，你可以通过 Navigator.pop 来关闭这个覆盖层：

Navigator.pop(context, 'close');

Contribution

欢迎提交Issue或Pull request。如果你想要更改API或者做一些大的改动，请先创建一个issue进行讨论。

完整示例demo

下面是一个完整的示例demo，演示了如何在Flutter项目中使用 flutter_overlay 插件：

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

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'flutter_overlay demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(title: 'flutter_overlay demo'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  MyHomePage({Key key, this.title}) : super(key: key);
  final String title;

  @override
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  void _show() {
    HiOverlay.show(
      context,
      child: _dialog(),
    ).then((value) {
      print('---received:$value');
    });
  }

  Widget _dialog() {
    return GestureDetector(
      onTap: () {
        Navigator.pop(context, 'close');
      },
      child: Container(
        decoration: BoxDecoration(color: Colors.black38),
        child: Center(
          child: CircularProgressIndicator(
              valueColor: AlwaysStoppedAnimation(Colors.redAccent)),
        ),
      ),
    );
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            Text(
              'Please click the button in the lower right corner.',
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _show,
        tooltip: 'Show',
        child: Icon(Icons.fiber_manual_record_outlined),
      ),
    );
  }
}

这个示例展示了如何创建一个带有浮动按钮的应用程序，点击按钮后会弹出一个半透明的覆盖层，其中包含一个红色的圆形进度条。用户点击覆盖层的任意位置都可以关闭它。

希望这些信息对你有所帮助！如果你有任何问题或需要进一步的帮助，请随时提问。