Flutter时间规划插件time_planner的使用

Time Planner 是一个美观、易于使用且可定制的时间规划插件，适用于 Flutter 的移动、桌面和 Web 平台。它可以帮助用户在时间表上展示任务。

截图

Mobile	Dark

Desktop	Web

在线演示

您可以在这里查看在线演示：Web Demo

使用方法

1. 添加依赖到 pubspec.yaml 文件中

dependencies:
  time_planner: ^0.1.2+1

2. 导入 time_planner 库

import 'package:time_planner/time_planner.dart';

3. 使用 TimePlanner

List<TimePlannerTask> tasks = [
  TimePlannerTask(
    color: Colors.purple,
    dateTime: TimePlannerDateTime(day: 0, hour: 14, minutes: 30),
    minutesDuration: 90,
    daysDuration: 1,
    onTap: () {},
    child: Text(
      'this is a task',
      style: TextStyle(color: Colors.grey[350], fontSize: 12),
    ),
  ),
];

TimePlanner(
  startHour: 6,
  endHour: 23,
  headers: [
    TimePlannerTitle(
      date: "3/10/2021",
      title: "sunday",
    ),
    TimePlannerTitle(
      date: "3/11/2021",
      title: "monday",
    ),
    TimePlannerTitle(
      date: "3/12/2021",
      title: "tuesday",
    ),
  ],
  tasks: tasks,
)

多天任务

您可以使用 daysDuration 来创建多天任务：

TimePlannerTask(
  color: Colors.blue,
  dateTime: TimePlannerDateTime(day: 0, hour: 14, minutes: 30),
  minutesDuration: 180,
  daysDuration: 3,
  onTap: () {},
  child: Text(
    'Multi-day task',
    style: TextStyle(color: Colors.white, fontSize: 12),
  ),
),

样式自定义

您可以使用 TimePlannerStyle 来自定义样式：

style: TimePlannerStyle(
  backgroundColor: Colors.blueGrey[900],
  cellHeight: 60,
  cellWidth: 60,
  dividerColor: Colors.white,
  showScrollBar: true,
  horizontalTaskPadding: 5,
  borderRadius: const BorderRadius.all(Radius.circular(8)),
),

滚动行为设置

如果您希望在桌面或 Web 平台上允许鼠标拖动，请添加以下代码：

class MyCustomScrollBehavior extends MaterialScrollBehavior {
  @override
  Set<PointerDeviceKind> get dragDevices => {
    PointerDeviceKind.touch,
    PointerDeviceKind.mouse,
  };
}

MaterialApp(
  scrollBehavior: MyCustomScrollBehavior(),
  // ...
);

完整示例

以下是一个完整的示例，包含随机生成任务的功能：

import 'dart:math';
import 'package:flutter/gestures.dart';
import 'package:flutter/material.dart';
import 'package:time_planner/time_planner.dart';

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

class MyCustomScrollBehavior extends MaterialScrollBehavior {
  @override
  Set<PointerDeviceKind> get dragDevices => {
    PointerDeviceKind.touch,
    PointerDeviceKind.mouse,
  };
}

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Time planner Demo',
      scrollBehavior: MyCustomScrollBehavior(),
      theme: ThemeData(
        primarySwatch: Colors.blue,
        visualDensity: VisualDensity.adaptivePlatformDensity,
      ),
      home: const MyHomePage(title: 'Time planner'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key, required this.title}) : super(key: key);

  final String title;

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

class _MyHomePageState extends State<MyHomePage> {
  List<TimePlannerTask> tasks = [];

  void _addObject(BuildContext context) {
    List<Color?> colors = [
      Colors.purple,
      Colors.blue,
      Colors.green,
      Colors.orange,
      Colors.lime[600]
    ];

    setState(() {
      tasks.add(
        TimePlannerTask(
          color: colors[Random().nextInt(colors.length)],
          dateTime: TimePlannerDateTime(
              day: Random().nextInt(14),
              hour: Random().nextInt(18) + 6,
              minutes: Random().nextInt(60)),
          minutesDuration: Random().nextInt(90) + 30,
          daysDuration: Random().nextInt(4) + 1,
          onTap: () {
            ScaffoldMessenger.of(context).showSnackBar(const SnackBar(
                content: Text('You click on time planner object')));
          },
          child: Text(
            'this is a demo',
            style: TextStyle(color: Colors.grey[350], fontSize: 12),
          ),
        ),
      );
    });

    ScaffoldMessenger.of(context).showSnackBar(
        const SnackBar(content: Text('Random task added to time planner!')));
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
        centerTitle: true,
      ),
      body: Center(
        child: TimePlanner(
          startHour: 6,
          endHour: 23,
          use24HourFormat: false,
          setTimeOnAxis: false,
          style: TimePlannerStyle(
            showScrollBar: true,
            interstitialEvenColor: Colors.grey[50],
            interstitialOddColor: Colors.grey[200],
          ),
          headers: const [
            TimePlannerTitle(date: "3/10/2021", title: "sunday"),
            TimePlannerTitle(date: "3/11/2021", title: "monday"),
            TimePlannerTitle(date: "3/12/2021", title: "tuesday"),
            // ... 其他日期标题
          ],
          tasks: tasks,
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: () => _addObject(context),
        tooltip: 'Add random task',
        child: const Icon(Icons.add),
      ),
    );
  }
}

通过以上步骤，您可以在 Flutter 应用中轻松集成并使用 time_planner 插件来管理您的时间规划需求。