dynamic_cached_fonts 2.0.0-dev.0

dynamic_cached_fonts: ^2.0.0-dev.0 copied to clipboard

Breaking Changes and Migration Guide #

1. If you have been using the package without modifying cacheStalePeriod or maxCacheObjects, no changes are required. However, any previously cached font files will be ignored and should be deleted by running the migration tool.

2. If you have modified cacheStalePeriod or maxCacheObjects, you'll have to pass the same values to any method that downloads, caches or loads fonts, otherwise the provided configuration will be ignored. Any previously cached font files will continue to remain in their respective cache folders and will be used by the package. Running the migration tool will have no effect on these font files.

3. A migration tool has been provided -> DynamicCachedFonts.runMigrationTool()

For more details, see #247

Dependency Updates

• Added support for v12.x of firebase_storage. Minimum supported version continues to be v8.0.0

Dependency Updates

• Added support for v11.x of firebase_storage. Minimum supported version continues to be v8.0.0
• Added support for the v3.x of dart sdk. Minimum supported version continues to be v2.12.0

Internal Updates

• Add DynamicCachedFontsCacheManager.unsetCustomCacheManager method to unset custom cache managers used for testing

Features/Updates

• Add DynamicCachedFonts.cacheFontStream and DynamicCachedFonts.loadCachedFamilyStream static methods to cache and load font and return the font files as Streams
• Add loadStream instance method to DynamicCachedFonts to load font files as Streams

Internal Updates

• Update loadCachedFamily's implementation
• Remove all reserved characters from the url to generate safer cache keys

BREAKING CHANGE: verboseLog, which was deprecated in v0.2.0, has been removed. DynamicCachedFonts.toggleVerboseLogging should be used instead

The online demo (i.e, the hosted example app) is now available. Check it out here!!

Dependency Updates

• Added support for the latest version of firebase_storage. Minimum supported version continues to be v8.0.0

Stable Null safety release

Dependency Updates

• Minimum version constraint for flutter_cache_manager is now v3.1.2

Features/Updates

• verboseLog is now deprecated in all APIs. DynamicCachedFonts.toggleVerboseLogging should be used instead to toggle verbose logging

• loadCachedFont and loadCachedFamily now throws a StateError if the font has not been cached

• UnsupportedError is thrown if the downloaded file is not a .ttf or .otf font file

• DynamicCachedFonts.load and loadCachedFamily now return Future<Iterable<FileInfo>> instead of void

• cacheFont and loadCachedFont now return Future<FileInfo> instead of void

No migration is required for the above 2 changes since a method/variable that expects void allows any other type as well.

• DynamicCachedFonts.load now exits and throws immediately if font has already been loaded
• Add DynamicCachedFonts.custom and RawDynamicCachedFonts.custom methods to make the API testable
• cacheKeyFromUrl is now exported for testing. It generates the cache key, used by the cache manager, from a given url

Internal Updates

• Improve file format verification logic
• Update DynamicCachedFonts.load logic

• Add complete web cache support
• Update documentation for some public and private APIs
• Disable RawDynamicCachedFonts' default constructor
• Improve logging in RawDynamicCachedFonts.loadCachedFont and font extension verification

Initial Release