README.md

README

Introduction

Welcome to FLUFF, the package that provides convenience functions to develop your Flutter app, based on packages from pub.dev. FLUFF means Flutter Leveraging User Functions from Friends.

Features

Extensions

BuildContext Extensions

• isLargeScreen: if the Adaptative Scaffold Breakpoint "large" is reached
• shareFile(String path): share a file with share_plus
• shareFiles(List<String> path): share files with share_plus

DateTime Extensions

• ymd
• yMMMMd({bool includeYear = true}): e.g 2005 January 5, January 5
• yMMMd({bool includeYear = true}): e.g 2005 Jan 5, Jan 5
• monthCamelCaseLong: e.g January
• monthCamelCaseShort: e.g Jan
• ymdInt
• hms
• hmsInt

Object Extensions

• logInfo(String message)
• logSevere(String message)
• logShout(String message)
• logWarning(String message)
• logFine(String message)
• logFiner(String message)
• logFinest(String message)
• logConfig(String message)

String Extensions

• typewriter(...) : converts a String into an animated typewriter widget

TzDateTimeExtensions

• withTimeOfDay(TimeOfDay) : return this with values of given TimeOfDay

Uri Extensions

• launch : launch this [Uri]

Repositories

AudioRepo :

• play(String assetPath)
• loadAssets(List<String> paths) : load assets to player caches
• dispose() : dispose all players
• setLowLatencyMode(bool lowLatency) : optimize for short files or not

ConnectivityRepo :

• hasConnectivity()

HttpRepo :

• fetchUrl(String) : fetch given URL and return response body

IoRepo :

• cacheDirPath : application's cache directory path
• extDirPath : application's top-level storage directory path

DeviceInfoRepo :

• id : Android/iOS device ID
• name : Android/iOS device name
• appInfo : Application info (version, package name, build number)
• isVersionSatisfied(int major, int minor, int patch) : check if app version is >= major.minor.patch

SoundRepo :

• init(List<String> assets)
• play(String assetName, {double volume = 0.6})
• dispose()
• stop(int handleId)
• stopAll()
• pause(int handleId)
• resume(int handleId)

TimeZoneRepo :

• setDefaultLocalTimeZone() : set timezone location to local timezone's location
• now : TZDateTime : returns current date & time according to current timezone

VolumeRepo :

• mute()
• unmute()
• setAverageVolume() : restore volume to median value
• volume : get current volume level