Updat - The simple-to-use, flutter-based desktop update package
Updat is a simple-to-use reliable flutter-native updater that handles your application's updates. All you need is a place to host your files and a place to check for the latest version.
Demo
Installing
To get started simply type flutter pub add updat in your terminal.
Getting Started
Integration with your app requires just a few lines of code, add the following widget wherever you want your updat widget to be:
UpdatWidget(
currentVersion: "1.0.0",
getLatestVersion: () async {
// Here you should fetch the latest version. It must be semantic versioning for update detection to work properly.
return "1.0.1";
},
getBinaryUrl: (latestVersion) async {
// Here you provide the link to the binary the user should download. Make sure it is the correct one for the platform!
return "https://github.com/latest/release/bin.exe";
},
// Lastly, enter your app name so we know what to call your files.
appName: "Updat Example",
),
That should get you up and running in just a few seconds
Configuration
Available Updat arguments
| Parameter | Type | Value | Default |
|---|---|---|---|
currentVersion |
String |
Required. Must be a semantic version. This is the current package's version. | N/A |
getLatestVersion |
Future<String> |
Required. Must be a semantic version. This should request the latest version to the server | N/A |
getBinaryUrl |
Future<String> |
Required. This should provide the link download the binary for a certain app version. Arguments: latestVersion |
N/A |
appNme |
String |
Required. The Application's name. It is used to name the binaries when downloading. | N/A |
getChangelog |
Future<String> |
This will render a plain text view of the changelog. | N/A |
callback |
void Function(UpdatStatus) |
A callback that is called when the UpdatStatus gets updated. | N/A |
getDownloadFileLocation |
Future<File> |
Choose where to download the update. | N/A |
updateChipBuilder |
Widget Function(...) |
Overrides the default update chip. | N/A |
updateDialogBuilder |
Widget Function(...) |
Overrides the default update dialog. | N/A |
openOnDownload |
bool |
Whether Updat should open the installer automatically once it has been downloaded. | true |
closeOnInstall |
bool |
Whether Updat should close the application automatically once it has been downloaded. | false |
Theming
Updat is extremely easy to theme. We also use updateChipBuilder and updateDialogBuilder internally to design our widgets, so you have the same customizability we do. We provide a couple of themes to get you started.
To change the theme simply add the desired theme to the builder and you're set.
Chips
-
defaultChipwhich is an elevatedButton that only shows when an update is available. Shown by default. -
defaultChipWithCheckForwhich is an elevatedButton that shows under all condition, allowing to recheck for updates. -
flatChipwhich is an textButton that only shows when an update is available -
flatChipWithCheckForwhich is an textButton that shows under all condition, allowing to recheck for updates.
Dialogs
defaultwhich is the default, M2 and M3 dialog that shows by default.
318 Jan 8, 2023
72 Dec 2, 2022
417 Dec 29, 2022
39 Oct 1, 2022
20 Dec 8, 2022
987 Jan 6, 2023
60 Dec 2, 2022