패키지 상세v0.0.1

flutter_date_kit

intl 패키지를 사용하여 날짜 형식을 쉽게 지정할 수 있는 Flutter 패키지입니다.

AndroidiOSWebmacOSWindowsLinux

pub.dev API 문서 소스 코드

30일 다운로드: 29
좋아요: 1
Pub 점수: 150

패키지 설치

flutter pub add flutter_date_kit

패키지 개요

공개 정보를 바탕으로 생성한 선택 가이드입니다.

flutter_date_kit은 intl 패키지를 활용하여 날짜 형식을 간소화하기 위해 설계된 Flutter 패키지입니다. 다양한 지역 설정과 패턴에서 날짜를 파싱하고 포맷하며 표시하는 직관적인 메서드를 제공합니다. 개발자 경험을 중심으로 설계되어, 다양한 플랫폼에서 날짜 작업 시 반복 코드를 줄여줍니다. 모든 주요 Flutter 플랫폼(안드로이드, iOS, 웹, macOS, Windows, 리눅스)을 지원하며, 각 플랫폼에서 일관된 동작을 보장합니다. 지역화된 날짜 표시 또는 복잡한 날짜 조작이 필요한 앱에 적합합니다.

사용 사례

다양한 로캘에서 날짜 형식 지정
사용자 입력 날짜 파싱
상대적 시간 표시 (예: '2시간 전')
캘린더 형식 로컬라이제이션
시간대 변환 처리
국제화된 날짜 선택기 만들기

주요 기능

내부에서 intl를 사용하는 간단한 API
로컬라이제이션 및 지역 설정 인식 형식을 지원
크로스 플랫폼 일관성
일반적인 날짜 패턴을 위한 내장 도구
사용자 정의 형식 지정을 위한 확장 가능
경량 종속성

적합한 대상

글로벌 대상 사용자를 위한 앱
날짜 중심의 사용자 인터페이스 컴포넌트
현지화 중심 프로젝트
최소한의 날짜 처리 코드를 원하는 개발자
intl를 이미 사용하는 프로젝트가 존재합니다

고려 사항

의존성으로 intl 패키지가 필요합니다
서식 지정에 국한됨—고급 날짜 산술 없음
기본이 아닌 로케일에 대해 추가 설정이 필요할 수 있습니다
고주파 날짜 연산에 최적화되지 않음
내장된 날짜 검증 없음

원본 README

연결된 소스 저장소의 README 원문 스냅샷입니다. 최신 내용은 저장소에서 확인하세요.

Flutter Date Kit

A comprehensive Flutter package that provides easy-to-use date formatting and manipulation utilities using the intl package. This package offers a complete toolkit of date formatting methods, extension methods, and utility functions for DateTime objects.

✨ Features

🗓️ Multiple Date Formats: Support for various date formats including dd/MM/yyyy, yyyy-MM-dd, ISO formats, and more
⏰ Time Formatting: Format time in 12-hour and 24-hour formats
🔧 Extension Methods: Convenient extension methods for DateTime objects
📱 Flutter Ready: Built specifically for Flutter applications
🧪 Well Tested: Comprehensive test coverage
📚 Well Documented: Clear documentation and examples
⚡ Performance Optimized: Singleton pattern for better performance
🛡️ Error Handling: Proper error handling for date parsing operations
🛠️ Utility Functions: Date manipulation and validation utilities

🚀 Getting started

Add this to your package's pubspec.yaml file:

dependencies:
  flutter_date_kit: ^latest

📁 File Structure

The package is organized into a modular structure for better maintainability:

lib/
├── flutter_date_kit.dart              # Main entry point (exports all components)
└── src/
    ├── date_format_service.dart    # DateFormatService class with singleton pattern
    ├── date_time_extensions.dart   # DateTime extension methods
    ├── string_date_extensions.dart # String extension methods for date parsing
    ├── date_formats.dart          # DateFormat instances and patterns
    └── date_utils.dart            # Utility functions for date operations

This structure provides:

Better Organization: Each file has a specific responsibility
Easier Maintenance: Changes to specific functionality are isolated
Improved Readability: Smaller, focused files are easier to understand
Better Testing: Individual components can be tested separately

📖 Usage

💡 Tip: Check out the example app for a comprehensive demonstration of all features with a beautiful UI!

🚀 Quick Start: Run ./run_example.sh to launch the example app directly!

import 'package:flutter_date_kit/flutter_date_kit.dart';

void main() {
  // Using the singleton instance (recommended for better performance)
  final formatted = DateFormatService.instance.formatToDdMmYyyy(DateTime.now());
  print(formatted); // "25/12/2023"
  
  // Or create a new instance (backward compatibility)
  final formatter = DateFormatService();
  final date = DateTime(2023, 12, 25, 14, 30, 45);
  
  // Basic date formatting
  print(formatter.formatToDdMmYyyy(date)); // "25/12/2023"
  print(formatter.formatToYyyyMmDd(date)); // "2023-12-25"
  print(formatter.formatToShortDate(date)); // "25 Dec 2023"
  
  // Date with time
  print(formatter.formatToDateWithTime(date)); // "25 Dec 2023, 2:30 PM"
  print(formatter.formatToFullDateTime(date)); // "2023-12-25 14:30:45"
  
  // Time formatting
  print(formatter.formatToTime12Hour(date)); // "2:30 PM"
  print(formatter.formatToTime24Hour(date)); // "14:30"
  
  // Other formats
  print(formatter.formatToDayOfWeek(date)); // "Mon"
  print(formatter.formatToMonthYear(date)); // "December 2023"
}

Using Extension Methods (Most Convenient)

import 'package:flutter_date_kit/flutter_date_kit.dart';

void main() {
  final date = DateTime(2023, 12, 25, 14, 30, 45);
  
  // Extension methods make formatting even easier
  print(date.toDdMmYyyy()); // "25/12/2023"
  print(date.toYyyyMmDd()); // "2023-12-25"
  print(date.toShortDate()); // "25 Dec 2023"
  print(date.toDateWithTime()); // "25 Dec 2023, 2:30 PM"
  print(date.toTime12Hour()); // "2:30 PM"
  print(date.toTime24Hour()); // "14:30"
  print(date.toMonthYear()); // "December 2023"
  
  // Date utility extensions
  print(date.isToday); // false
  print(date.isYesterday); // false
  print(date.isTomorrow); // false
  print(date.age); // 0 (if date is today)
  print(date.quarter); // 4
  print(date.weekOfYear); // 52
  
  // Date manipulation
  final tomorrow = date.addDays(1);
  final yesterday = date.subtractDays(1);
  final daysDiff = date.differenceInDays(DateTime.now());
  
  // Date boundaries
  print(date.startOfDay); // 2023-12-25 00:00:00.000
  print(date.endOfDay); // 2023-12-25 23:59:59.000
  print(date.startOfWeek); // 2023-12-25 00:00:00.000 (Monday)
  print(date.endOfWeek); // 2023-12-31 00:00:00.000 (Sunday)
  print(date.startOfMonth); // 2023-12-01 00:00:00.000
  print(date.endOfMonth); // 2023-12-31 00:00:00.000
}

Using String Date Parsing and Formatting

import 'package:flutter_date_kit/flutter_date_kit.dart';

void main() {
  final formatter = DateFormatService.instance;
  
  // Parse yyyy-MM-dd strings and format them
  print(formatter.parseAndFormatDdMmYyyy('2023-12-25')); // "25/12/2023"
  print(formatter.parseAndFormatShortDate('2023-12-25')); // "25 Dec 2023"
  print(formatter.parseAndFormatMonthAbbr('2023-12-25')); // "Dec"
  print(formatter.parseAndFormatDayOfWeek('2023-12-25')); // "Mon"
  print(formatter.parseAndFormatYear('2023-12-25')); // "2023"
  print(formatter.parseAndFormatMonthYear('2023-12-25')); // "December 2023"
  
  // Parse dd/MM/yyyy strings and format them
  print(formatter.parseDdMmYyyyAndFormatYyyyMmDd('25/12/2023')); // "2023-12-25"
  print(formatter.parseDdMmYyyyAndFormatShortDate('25/12/2023')); // "25 Dec 2023"
  print(formatter.parseDdMmYyyyAndFormatMonthAbbr('25/12/2023')); // "Dec"
  
  // Using string extension methods
  print('2023-12-25'.parseYyyyMmDdToDdMmYyyy()); // "25/12/2023"
  print('2023-12-25'.parseYyyyMmDdToShortDate()); // "25 Dec 2023"
  print('2023-12-25'.parseYyyyMmDdToMonthAbbr()); // "Dec"
  print('25/12/2023'.parseDdMmYyyyToYyyyMmDd()); // "2023-12-25"
  print('25/12/2023'.parseDdMmYyyyToShortDate()); // "25 Dec 2023"
  
  // String validation
  print('2023-12-25'.isValidYyyyMmDd); // true
  print('25/12/2023'.isValidDdMmYyyy); // true
  print('12/25/2023'.isValidMmDdYyyy); // true
  print('invalid-date'.isValidYyyyMmDd); // false
}

Using DateUtils for Advanced Operations

import 'package:flutter_date_kit/flutter_date_kit.dart';

void main() {
  // Current date and time utilities
  print(DateUtils.getCurrentDateDdMmYyyy()); // "25/12/2023"
  print(DateUtils.getCurrentDateYyyyMmDd()); // "2023-12-25"
  print(DateUtils.getCurrentTime24Hour()); // "14:30"
  print(DateUtils.getCurrentTime12Hour()); // "2:30 PM"
  
  // Date validation
  print(DateUtils.isValidYyyyMmDd('2023-12-25')); // true
  print(DateUtils.isValidDdMmYyyy('25/12/2023')); // true
  print(DateUtils.isValidMmDdYyyy('12/25/2023')); // true
  
  // Date manipulation
  final date = DateTime(2023, 12, 25);
  print(DateUtils.addDays(date, 7)); // 2024-01-01
  print(DateUtils.subtractDays(date, 7)); // 2023-12-18
  
  // Date boundaries
  print(DateUtils.startOfDay(date)); // 2023-12-25 00:00:00.000
  print(DateUtils.endOfDay(date)); // 2023-12-25 23:59:59.000
  print(DateUtils.startOfWeek(date)); // 2023-12-25 00:00:00.000 (Monday)
  print(DateUtils.endOfWeek(date)); // 2023-12-31 00:00:00.000 (Sunday)
  print(DateUtils.startOfMonth(date)); // 2023-12-01 00:00:00.000
  print(DateUtils.endOfMonth(date)); // 2023-12-31 00:00:00.000
  
  // Date comparisons
  print(DateUtils.isToday(date)); // false
  print(DateUtils.isYesterday(date)); // false
  print(DateUtils.isTomorrow(date)); // false
  
  // Date differences
  final otherDate = DateTime(2023, 12, 30);
  print(DateUtils.differenceInDays(otherDate, date)); // 5
  print(DateUtils.differenceInHours(otherDate, date)); // 120
  print(DateUtils.differenceInMinutes(otherDate, date)); // 7200
  
  // Age calculation
  final birthDate = DateTime(1990, 6, 15);
  print(DateUtils.getAge(birthDate)); // 33
  
  // Calendar utilities
  print(DateUtils.isLeapYear(2024)); // true
  print(DateUtils.daysInMonth(2023, 2)); // 28
  print(DateUtils.getQuarter(date)); // 4
  print(DateUtils.getWeekOfYear(date)); // 52
}

Error Handling

import 'package:flutter_date_kit/flutter_date_kit.dart';

void main() {
  try {
    // This will throw a FormatException
    final result = DateFormatService.instance.parseAndFormatDdMmYyyy('invalid-date');
  } catch (e) {
    print('Error: $e'); // Error: FormatException: Invalid date format. Expected yyyy-MM-dd, got: invalid-date
  }
  
  // Safe validation
  if ('2023-12-25'.isValidYyyyMmDd) {
    final result = DateFormatService.instance.parseAndFormatDdMmYyyy('2023-12-25');
    print(result); // "25/12/2023"
  }
}

📋 Available Format Methods

DateFormatService Methods

Method	Format	Example Output
`formatToDdMmYyyy()`	dd/MM/yyyy	"25/12/2023"
`formatToYyyyMmDd()`	yyyy-MM-dd	"2023-12-25"
`formatToShortDate()`	dd MMM yyyy	"25 Dec 2023"
`formatToDateWithTime()`	dd MMM yyyy, h:mm a	"25 Dec 2023, 2:30 PM"
`formatToFullDateTime()`	yyyy-MM-dd HH:mm:ss	"2023-12-25 14:30:45"
`formatToIsoWithTimezone()`	yyyy-MM-dd'T'HH:mm:ssZ	"2023-12-25T14:30:00+00:00"
`formatToTime12Hour()`	h:mm a	"2:30 PM"
`formatToTime24Hour()`	HH:mm	"14:30"
`formatToFullTime()`	HH:mm:ss	"14:30:45"
`formatToDayOfWeek()`	E	"Mon"
`formatToMonthAbbr()`	MMM	"Dec"
`formatToMonthFull()`	MMMM	"December"
`formatToYear()`	y	"2023"
`formatToMonthYear()`	MMMM yyyy	"December 2023"
`formatToMmDdYyyy()`	MM/dd/yyyy	"12/25/2023"
`formatToFullDayDate()`	EEEE, MMMM d, yyyy	"Monday, December 25, 2023"
`formatToYyyyMmDdHhMm()`	yyyy-MM-dd HH:mm	"2023-12-25 14:30"

String Parsing Methods (DateFormatService)

Method	Input Format	Output Format	Example
`parseAndFormatDdMmYyyy()`	yyyy-MM-dd	dd/MM/yyyy	"2023-12-25" → "25/12/2023"
`parseAndFormatShortDate()`	yyyy-MM-dd	dd MMM yyyy	"2023-12-25" → "25 Dec 2023"
`parseAndFormatMonthAbbr()`	yyyy-MM-dd	MMM	"2023-12-25" → "Dec"
`parseAndFormatDayOfWeek()`	yyyy-MM-dd	E	"2023-12-25" → "Mon"
`parseAndFormatYear()`	yyyy-MM-dd	y	"2023-12-25" → "2023"
`parseAndFormatMonthYear()`	yyyy-MM-dd	MMMM yyyy	"2023-12-25" → "December 2023"
`parseDdMmYyyyAndFormatYyyyMmDd()`	dd/MM/yyyy	yyyy-MM-dd	"25/12/2023" → "2023-12-25"
`parseDdMmYyyyAndFormatShortDate()`	dd/MM/yyyy	dd MMM yyyy	"25/12/2023" → "25 Dec 2023"
`parseDdMmYyyyAndFormatMonthAbbr()`	dd/MM/yyyy	MMM	"25/12/2023" → "Dec"

Extension Methods

Method	Format	Example Output
`toDdMmYyyy()`	dd/MM/yyyy	"25/12/2023"
`toYyyyMmDd()`	yyyy-MM-dd	"2023-12-25"
`toShortDate()`	dd MMM yyyy	"25 Dec 2023"
`toDateWithTime()`	dd MMM yyyy, h:mm a	"25 Dec 2023, 2:30 PM"
`toFullDateTime()`	yyyy-MM-dd HH:mm:ss	"2023-12-25 14:30:45"
`toIsoWithTimezone()`	yyyy-MM-dd'T'HH:mm:ssZ	"2023-12-25T14:30:00+00:00"
`toTime12Hour()`	h:mm a	"2:30 PM"
`toTime24Hour()`	HH:mm	"14:30"
`toFullTime()`	HH:mm:ss	"14:30:45"
`toDayOfWeek()`	E	"Mon"
`toMonthAbbr()`	MMM	"Dec"
`toMonthFull()`	MMMM	"December"
`toYear()`	y	"2023"
`toMonthYear()`	MMMM yyyy	"December 2023"
`toMmDdYyyy()`	MM/dd/yyyy	"12/25/2023"
`toFullDayDate()`	EEEE, MMMM d, yyyy	"Monday, December 25, 2023"
`toYyyyMmDdHhMm()`	yyyy-MM-dd HH:mm	"2023-12-25 14:30"

String Extension Methods

Method	Input Format	Output Format	Example
`parseYyyyMmDdToDdMmYyyy()`	yyyy-MM-dd	dd/MM/yyyy	"2023-12-25" → "25/12/2023"
`parseYyyyMmDdToShortDate()`	yyyy-MM-dd	dd MMM yyyy	"2023-12-25" → "25 Dec 2023"
`parseYyyyMmDdToMonthAbbr()`	yyyy-MM-dd	MMM	"2023-12-25" → "Dec"
`parseYyyyMmDdToDayOfWeek()`	yyyy-MM-dd	E	"2023-12-25" → "Mon"
`parseYyyyMmDdToYear()`	yyyy-MM-dd	y	"2023-12-25" → "2023"
`parseYyyyMmDdToMonthYear()`	yyyy-MM-dd	MMMM yyyy	"2023-12-25" → "December 2023"
`parseDdMmYyyyToYyyyMmDd()`	dd/MM/yyyy	yyyy-MM-dd	"25/12/2023" → "2023-12-25"
`parseDdMmYyyyToShortDate()`	dd/MM/yyyy	dd MMM yyyy	"25/12/2023" → "25 Dec 2023"
`parseDdMmYyyyToMonthAbbr()`	dd/MM/yyyy	MMM	"25/12/2023" → "Dec"
`isValidYyyyMmDd`	-	bool	"2023-12-25" → true
`isValidDdMmYyyy`	-	bool	"25/12/2023" → true
`isValidMmDdYyyy`	-	bool	"12/25/2023" → true

DateTime Extension Properties

Property	Type	Description	Example
`isToday`	bool	Checks if date is today	`date.isToday`
`isYesterday`	bool	Checks if date is yesterday	`date.isYesterday`
`isTomorrow`	bool	Checks if date is tomorrow	`date.isTomorrow`
`age`	int	Gets age from birth date	`birthDate.age`
`quarter`	int	Gets quarter of year	`date.quarter`
`weekOfYear`	int	Gets week of year	`date.weekOfYear`
`startOfDay`	DateTime	Start of day (00:00:00)	`date.startOfDay`
`endOfDay`	DateTime	End of day (23:59:59)	`date.endOfDay`
`startOfWeek`	DateTime	Start of week (Monday)	`date.startOfWeek`
`endOfWeek`	DateTime	End of week (Sunday)	`date.endOfWeek`
`startOfMonth`	DateTime	Start of month	`date.startOfMonth`
`endOfMonth`	DateTime	End of month	`date.endOfMonth`
`startOfYear`	DateTime	Start of year	`date.startOfYear`
`endOfYear`	DateTime	End of year	`date.endOfYear`

DateTime Extension Methods

Method	Description	Example
`addDays(int days)`	Adds days to date	`date.addDays(7)`
`subtractDays(int days)`	Subtracts days from date	`date.subtractDays(7)`
`differenceInDays(DateTime other)`	Days difference	`date.differenceInDays(other)`
`differenceInHours(DateTime other)`	Hours difference	`date.differenceInHours(other)`
`differenceInMinutes(DateTime other)`	Minutes difference	`date.differenceInMinutes(other)`

🏗️ Architecture

The package is organized into several modules for better maintainability:

flutter_date_kit.dart: Main entry point with DateFormatService and extensions
src/date_formats.dart: Date format patterns and pre-configured DateFormat instances
src/date_utils.dart: Utility functions for date manipulation and validation

🔧 Performance Optimizations

Singleton Pattern: DateFormatService uses a singleton pattern to avoid creating multiple instances
Pre-configured Formats: DateFormat instances are pre-configured for better performance
Extension Methods: Use the singleton instance internally for optimal performance

🛡️ Error Handling

The package provides comprehensive error handling:

FormatException: Thrown when parsing invalid date strings
Validation Methods: Safe validation methods to check date format validity
Try-Catch Support: All parsing methods support try-catch error handling

📚 Additional information

This package is built on top of the intl package, which provides internationalization and localization facilities for Dart and Flutter applications.

Dependencies

intl: ^0.20.2 - For date formatting functionality
flutter: ">=1.17.0" - Flutter framework

Contributing

Feel free to contribute to this package by:

Forking the repository
Creating a feature branch
Making your changes
Adding tests
Submitting a pull request

License

This package is licensed under the BSD-3-Clause license.

카테고리

날짜 및 시간 유틸리티

의존성

의존성 목록 1 개

intl^0.20.2

소스 저장소

chathur-aureus/flutter_date_kit

flutter_date_kit

☆ 0 스타⑂ 0 포크

DartShell

이 패키지를 사용하는 프로젝트

아직 데이터가 없습니다.