v2.0.0-dev.0

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

v1.2.0

Dependency Updates

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

v1.1.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

v1.0.0

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

v0.4.0

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!!

List of changes

What's Changed

• Fix function parameter default values by @sidrao2006 in #131
• Fix js script import path by @sidrao2006 in #133
• Don't checkout the repo unnecessarily by @sidrao2006 in #134
• Revert "Don't checkout the repo unnecessarily" by @sidrao2006 in #136
• Add workflow to auto build and deploy example Github Pages by @sidrao2006 in #135
• Update icons and html template for example web app by @sidrao2006 in #132
• Fix example web deploy path by @sidrao2006 in #137
• Enable gh pages manual deployment by @sidrao2006 in #138
• Add necessary permissions to deploy example by @sidrao2006 in #139
• Add firebase bucket URL required to build the example by @sidrao2006 in #140
• Disallow jobs from running concurrently by @sidrao2006 in #141
• Fix release pre-check syntax error by @sidrao2006 in #143
• Update gitignore (pubspec.lock) by @sidrao2006 in #145
• Add pubignore file by @sidrao2006 in #144
• Update release labeler strategy and refactor/format js scripts by @sidrao2006 in #142
• Wait on tests before deploying the example by @sidrao2006 in #146
• Fix revert labeler behaviour (async-await) by @sidrao2006 in #148
• Enable manual triggers for all workflows using workflow_dispatch by @sidrao2006 in #147
• Check out scripts to run release pre-check by @sidrao2006 in #149
• Fix check run permission error in release pre check by @sidrao2006 in #150
• Add link to online demo to README by @sidrao2006 in #151
• Add emojis to README by @sidrao2006 in #152
• Update package description by @sidrao2006 in #154
• Update package description in README by @sidrao2006 in #155
• Drop support for deprecated API - verboseLog by @sidrao2006 in #156
• De-clutter README by removing unnecessary badges by @sidrao2006 in #157
• Update labeler permissions for release labeler by @sidrao2006 in #161
• Update example app's dependencies by @sidrao2006 in #153
• Fix invalid object error in release labeler by @sidrao2006 in #162
• Release v0.4.0 - Drop support for verboseLog by @sidrao2006 in #160

Full Changelog: v0.3.1...v0.4.0

v0.3.1

Dependency Updates

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

v0.3.0

Stable Null safety release

v0.2.0

Dependency Updates

• Minimum version constraint for flutter_cache_manager is now v3.1.2

Features/Updates

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

It's likely that support for verboseLog will end in v1.0.0.

• 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

v0.1.0

• 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

v0.0.1

Initial Release (Non null-safe)