搜索插件、代码仓与 APP 分类

插件详情v3.0.1

get_time_ago

一个 Dart 包,用于将 `DateTime` 对象转换并格式化为人类可读的“多久以前”字符串,例如“20 秒前”、“1 分钟前”或“7 小时前”。

AndroidiOSWebmacOSWindowsLinux
近 30 天下载
1.1万
喜欢数
168
Pub 分数
160

安装插件

flutter pub add get_time_ago

插件介绍

基于插件公开信息、社区数据与项目使用情况整理的选型参考。

一个轻量级的 Dart 包,可将 DateTime 对象转换为人类可读的“多久以前”字符串,例如“20 秒前”或“7 小时前”。它简化了应用中相对时间戳的显示,通过以自然、对话式格式呈现时间来提升用户体验。该包支持多个平台,并且易于与 Flutter 项目集成。

适合场景

  • 在社交媒体应用中显示帖子时间戳
  • 在聊天界面中显示消息发送时间
  • 使用相对时间标签更新活动动态
  • 通过自然语言时间提升用户界面可读性
  • 实时应用程序中的事件持续时间跟踪

主要特点

  • 简单的 DateTime 到字符串转换
  • 支持多种语言(通过本地化)
  • 跨平台兼容性
  • 所需的样板代码最少
  • 可配置的精度和输出格式

适合对象

  • Flutter 开发人员构建实时应用
  • 需要直观时间显示的应用程序
  • 专注于用户体验的项目,包含带时间戳的内容
  • 寻求最小化日期格式化解决方案的开发者

使用建议

  • 不支持自定义区域设置格式化
  • 仅限相对时间格式,不包括绝对日期
  • 需要手动处理时区差异

原始 README

以下为关联源码仓库的 README 原文快照,最新内容请访问源码仓库。

get_time_ago

A Dart package that converts and formats DateTime objects into human-readable 'time ago' strings, such as '20 seconds ago', 'a minute ago', or '7 hours ago'. This package provides an easy way to display relative time differences in your Flutter or Dart applications. It supports various time units (seconds, minutes, hours, days, etc.) and automatically adjusts the format based on how recent the event occurred. Ideal for displaying timestamps in news feeds, social media posts, or chat messages.

pub package [Stars][repo] [Forks][repo] [Watchers][repo] [Contributors][repo]

[GitHub code size in bytes][repo] [GitHub repo size][repo] [GitHub language count][repo] [GitHub top language][repo] [GitHub Sponsors][repo]

[GitHub release (latest by date)][releases] [GitHub release (latest by date)][releases] [GitHub last commit][repo] [GitHub issues][issues] [GitHub pull requests][pulls] [GitHub License][license]

Table of Contents

Breaking Changes for the Version ^2.0.0

1. Added justNow Method in Messages Interface

In version 2.0.0, a new method justNow(int seconds) has been added to the Messages interface. This method is responsible for providing a custom message when the elapsed time is less than 15 seconds.

Impact on Custom Implementations:

If you have implemented any custom locales by extending the Messages interface, you will need to update your implementation to include the new justNow method. Failing to implement this method will result in compilation errors.

Example of Custom Locale Update:

Before:

class MyCustomMessages implements Messages {
  @override
  String prefixAgo() => '';

  @override
  String suffixAgo() => 'ago';

  // Implement the other methods here...
}

After (Version 2.0.0):

class MyCustomMessages implements Messages {
  @override
  String prefixAgo() => '';

  @override
  String suffixAgo() => 'ago';

  @override
  String justNow(int seconds) => 'just now';  // New method

  // Implement the other methods here...
}

This section explains the breaking change, the impact it has on custom implementations, and provides an example of how to update existing code to comply with the new changes in version ^2.0.0.

Demo

Click here to experience the demo in a Web App

Installation

Add get_time_ago as a dependency in your pubspec.yaml file.

dependencies:
  get_time_ago: ^latest_version

Usage

Format any DateTime object into get_time_ago format by following steps:

// Import the plugin
import 'package:get_time_ago/get_time_ago.dart';

// Pass DateTime object as argument in the method
var _dateTime = DateTime.now().subtract(const Duration(minutes: 10)); // [DateTime] object
print(GetTimeAgo.parse(_dateTime)); // 10 minutes ago

// Formatting with locale
print(GetTimeAgo.parse(_dateTime, locale:'es')); // hace 10 minutos
Formatting String as get_time_ago

If you have saved a DateTime object as a String into a variable, database or cloud, then you have to first convert the String into DateTime object and then pass it as argument in parse method of get_time_ago plugin to format it into get_time_ago format by following steps:

// Import the plugin
import 'package:get_time_ago/get_time_ago.dart';

var _timestamp = '2021-05-10 05:21:37.712498'; // [DateTime] formatted as String.
var _convertedTimestamp = DateTime.parse(_timestamp); // Converting into [DateTime] object
var result = GetTimeAgo.parse(_convertedTimestamp);
print(result);
Setting default locale

If you want to change your default locale, then call setDefaultLocale method and pass the locale code as the argument.

// Import the plugin
import 'package:get_time_ago/get_time_ago.dart';

@override
void initState() {
  super.initState();
  GetTimeAgo.setDefaultLocale('fr'); // Sets the default locale to French
}
Setting Custom Locale & Messages

Implementing and Adding Custom Messages

class CustomMessages implements Messages {
  /// Prefix added before the time message.
  @override
  String prefixAgo() => '';

  /// Suffix added after the time message.
  @override
  String suffixAgo() => 'ago';

  /// Message when the elapsed time is less than 15 seconds.
  @override
  String justNow(int seconds) => 'just now';

  /// Message for when the elapsed time is less than a minute.
  @override
  String secsAgo(int seconds) => '$seconds seconds';

  /// Message for when the elapsed time is about a minute.
  @override
  String minAgo(int minutes) => 'a minute';

  /// Message for when the elapsed time is in minutes.
  @override
  String minsAgo(int minutes) => '$minutes minutes';

  /// Message for when the elapsed time is about an hour.
  @override
  String hourAgo(int minutes) => 'an hour';

  /// Message for when the elapsed time is in hours.
  @override
  String hoursAgo(int hours) => '$hours hours';

  /// Message for when the elapsed time is about a day.
  @override
  String dayAgo(int hours) => 'a day';

  /// Message for when the elapsed time is in days.
  @override
  String daysAgo(int days) => '$days days';

  /// Word separator to be used when joining the parts of the message.
  @override
  String wordSeparator() => ' ';
}

Overriding en Locale Messages with Custom Messages

GetTimeAgo.setCustomLocaleMessages('en', CustomMessages());

Supported Languages

  • Arabic
  • English
  • Spanish
  • Persian (Farsi)
  • French
  • Hindi
  • Portuguese (Brazil)
  • Portuguese (Brazil alternate)
  • Simplified Chinese
  • Traditional Chinese
  • Japanese
  • Occitan
  • Korean
  • German
  • Indonesian
  • Turkish
  • Urdu
  • Vietnamese
  • Romanian
  • Dutch
  • Nepali
  • Italian
  • Open to accept PR for adding more languages

Contributing

If you would like to contribute to this project, feel free to fork the repository, make your changes, and submit a pull request. Please follow the guidelines in the CONTRIBUTING.md file.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributors

Made with contrib.rocks.

Support My Work

Your support helps me dedicate more time to developing high-quality, impactful projects in the open-source community. Sponsor me, and together, let’s bring even more innovation to life!

Sponsor

ko-fi

"Buy Me A Coffee"

Connect With Me

GitHub: nixrajput Linkedin: nixrajput Instagram: nixrajput Twitter: nixrajput07 Telegram: nixrajput [Gmail: nkr.nikhi.nkr@gmail.com][gmail]

Activities

Alt

[gmail]: mailto:nkr.nikhil.nkr@gmail.com [releases]: https://github.com/nixrajput/get_time_ago/releases [repo]: https://github.com/nixrajput/get_time_ago [issues]: https://github.com/nixrajput/get_time_ago/issues [license]: https://github.com/nixrajput/get_time_ago/blob/master/LICENSE [pulls]: https://github.com/nixrajput/get_time_ago/pulls

所属分类

依赖

依赖清单 1 项

  • intl>=0.19.0 <0.21.0

源码仓库

使用此插件的项目