Flutter粘性布局插件flutter_sticky_widgets的使用

Flutter中，flutter_sticky_widgets 插件提供了类似CSS中 position: sticky; 的功能。它允许创建一种UI模式，在这种模式下，我们希望某些组件随着页面滚动到某个特定位置后固定在屏幕上，而不是继续随页面滚动消失。

示例效果

快速开始

导入包

首先需要在你的Dart文件中导入此插件：

import 'package:flutter_sticky_widgets/flutter_sticky_widgets.dart';

完整示例代码

下面是一个完整的例子，展示了如何使用 StickyContainer 和 StickyWidget 来创建一个带有悬浮按钮的应用程序：

import 'package:flutter/material.dart';
import 'package:flutter_sticky_widgets/flutter_sticky_widgets.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(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(),
    );
  }
}

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

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

class _MyHomePageState extends State<MyHomePage> {
  late ScrollController _controller;

  @override
  void initState() {
    _controller = ScrollController();
    super.initState();
  }

  @override
  void dispose() {
    _controller.dispose();
    super.dispose();
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Sticky Widgets Example'),
      ),
      body: StickyContainer(
        displayOverFlowContent: true,
        stickyChildren: [
          StickyWidget(
            initialPosition: StickyPosition(bottom: 20, right: 20),
            finalPosition: StickyPosition(
                bottom: MediaQuery.of(context).size.height - 80, right: 20),
            controller: _controller,
            child: Container(
              width: 40,
              height: 40,
              decoration: const BoxDecoration(
                shape: BoxShape.circle,
                color: Colors.green,
              ),
              child: const Center(child: Icon(Icons.pause)),
            ),
          ),
        ],
        child: ListView.builder(
          controller: _controller,
          itemCount: 50,
          itemBuilder: ((context, index) {
            return ListTile(
              title: Text("Tile $index"),
            );
          }),
        ),
      ),
    );
  }
}

关键参数说明

StickyWidget

• initialPosition (StickyPosition)：指定滚动开始前组件的位置。
• finalPosition (StickyPosition)：指定滚动到一定程度后组件将固定的最终位置。
• controller (ScrollController)：用于检测滚动状态，并且必须与同一个 Scrollable 组件（如 ListView）关联。
• callback (Function(double)?)：可选回调函数，在每次滚动时触发，接收当前滚动偏移量作为参数。

StickyContainer

• child (Widget)：通常应为 Scrollable 组件，如 ListView 等。
• stickyChildren (List<StickyWidget>)：包含一个或多个 StickyWidget。
• displayOverFlowContent (bool)：是否显示超出容器范围的内容，默认为 false。

StickyPosition

这是一个自定义类，用来表示 StickyWidget 的初始和最终位置。需要注意的是，对于 initialPosition 和 finalPosition，应该传递相同的参数组合（例如，都使用 top 和 left 或者 bottom 和 right）。