Flutter日期时间选择插件calendar_time的使用

Flutter日期时间选择插件calendar_time的使用

calendar_time 是一个用于将 DateTime 转换为人类可读字符串的插件，它实现了类似于 MomentJS 的 calendarTime 功能，并提供了一些其他有用的工具。以下是该插件的详细使用说明和一个完整的示例 Demo。

使用方法

1. toHuman

将 DateTime 转换为人类可读的字符串。例如，今天的日期会显示为 “Today at {current time}”。

import 'package:calendar_time/calendar_time.dart';

void main() {
  print(CalendarTime(DateTime.now()).toHuman); // Today at {current time}
}

示例输出：

• Today at {current time}
• Tomorrow at {time}
• Yesterday at {time}
• {day} at {time}
• Last {day} at {time}
• date time (超出最近或即将来临的几周)

你还可以使用 .toHumanMultiLine 将日期和时间分成两行显示。

print(CalendarTime(DateTime.now()).toHumanMultiLine);

2. format

将 DateTime 格式化为指定的时间格式。

import 'package:calendar_time/calendar_time.dart';

void main() {
  print(CalendarTime(DateTime.now()).format("yyyy-MM-dd HH:mm")); // 2023-10-05 14:30
}

你可以参考 intl 文档 获取更多格式化选项。

3. isToday

判断给定的 DateTime 是否是今天。

import 'package:calendar_time/calendar_time.dart';

void main() {
  final calendarTime = CalendarTime(DateTime.now());
  print(calendarTime.isToday); // true
}

4. isTomorrow

判断给定的 DateTime 是否是明天。

import 'package:calendar_time/calendar_time.dart';

void main() {
  final calendarTime = CalendarTime(DateTime.now().add(Duration(days: 1)));
  print(calendarTime.isTomorrow); // true
}

5. isNextWeek

判断给定的 DateTime 是否是下周。

import 'package:calendar_time/calendar_time.dart';

void main() {
  final calendarTime = CalendarTime(DateTime.now().add(Duration(days: 8)));
  print(calendarTime.isNextWeek); // true
}

6. isYesterday

判断给定的 DateTime 是否是昨天。

import 'package:calendar_time/calendar_time.dart';

void main() {
  final calendarTime = CalendarTime(DateTime.now().subtract(Duration(days: 1)));
  print(calendarTime.isYesterday); // true
}

7. isLastWeek

判断给定的 DateTime 是否是上周。

import 'package:calendar_time/calendar_time.dart';

void main() {
  final calendarTime = CalendarTime(DateTime.now().subtract(Duration(days: 8)));
  print(calendarTime.isLastWeek); // true
}

8. startOfToday

返回今天开始的时间（00:00:00）。

import 'package:calendar_time/calendar_time.dart';

void main() {
  final calendarTime = CalendarTime(DateTime.now());
  print(calendarTime.startOfToday); // 2023-10-05 00:00:00
}

9. startOfDay

返回给定日期当天的开始时间（00:00:00）。

import 'package:calendar_time/calendar_time.dart';

void main() {
  final calendarTime = CalendarTime(DateTime(2020, 1, 1));
  print(calendarTime.startOfDay); // 2020-01-01 00:00:00
}

10. startOfYesterday

返回昨天开始的时间（00:00:00）。

import 'package:calendar_time/calendar_time.dart';

void main() {
  final calendarTime = CalendarTime(DateTime.now());
  print(calendarTime.startOfYesterday); // 2023-10-04 00:00:00
}

11. startOfLastWeek

返回上周开始的时间（00:00:00）。

import 'package:calendar_time/calendar_time.dart';

void main() {
  final calendarTime = CalendarTime(DateTime.now());
  print(calendarTime.startOfLastWeek); // 2023-09-28 00:00:00
}

12. endOfToday

返回今天结束的时间（23:59:59:999:999）。

import 'package:calendar_time/calendar_time.dart';

void main() {
  final calendarTime = CalendarTime(DateTime.now());
  print(calendarTime.endOfToday); // 2023-10-05 23:59:59.999999
}

13. endOfDay

返回给定日期当天的结束时间（23:59:59:999:999）。

import 'package:calendar_time/calendar_time.dart';

void main() {
  final calendarTime = CalendarTime(DateTime(2020, 1, 1));
  print(calendarTime.endOfDay); // 2020-01-01 23:59:59.999999
}

14. endOfTomorrow

返回明天结束的时间（23:59:59:999:999）。

import 'package:calendar_time/calendar_time.dart';

void main() {
  final calendarTime = CalendarTime(DateTime.now());
  print(calendarTime.endOfTomorrow); // 2023-10-06 23:59:59.999999
}

15. endOfNextWeek

返回下周结束的时间（23:59:59:999:999）。

import 'package:calendar_time/calendar_time.dart';

void main() {
  final calendarTime = CalendarTime(DateTime.now());
  print(calendarTime.endOfNextWeek); // 2023-10-11 23:59:59.999999
}

完整示例 Demo

以下是一个完整的示例，展示了如何在 Flutter 应用中使用 calendar_time 插件来处理日期和时间。

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

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

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

class MyHomePage extends StatefulWidget {
  @override
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  DateTime selectedDate = DateTime.now();
  String humanReadableDate = '';

  @override
  void initState() {
    super.initState();
    updateHumanReadableDate();
  }

  void updateHumanReadableDate() {
    setState(() {
      humanReadableDate = CalendarTime(selectedDate).toHuman;
    });
  }

  Future<void> _selectDate(BuildContext context) async {
    final DateTime? picked = await showDatePicker(
      context: context,
      initialDate: selectedDate,
      firstDate: DateTime(2020),
      lastDate: DateTime(2025),
    );

    if (picked != null && picked != selectedDate) {
      setState(() {
        selectedDate = picked;
        updateHumanReadableDate();
      });
    }
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Calendar Time Demo'),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            Text(
              'Selected Date:',
              style: TextStyle(fontSize: 18),
            ),
            SizedBox(height: 10),
            Text(
              '$selectedDate',
              style: TextStyle(fontSize: 16),
            ),
            SizedBox(height: 20),
            ElevatedButton(
              onPressed: () => _selectDate(context),
              child: Text('Select Date'),
            ),
            SizedBox(height: 20),
            Text(
              'Human Readable Date:',
              style: TextStyle(fontSize: 18),
            ),
            SizedBox(height: 10),
            Text(
              humanReadableDate,
              style: TextStyle(fontSize: 16, fontWeight: FontWeight.bold),
            ),
          ],
        ),
      ),
    );
  }
}

说明

1. 导入依赖：首先确保在 pubspec.yaml 文件中添加了 calendar_time 依赖。

   dependencies:
     flutter:
       sdk: flutter
     calendar_time: ^1.0.0