updat 1.2.0 icon indicating copy to clipboard operation
updat: ^1.2.0 copied to clipboard

Updat is a simple-to-use reliable flutter-native updater that handles your application's updates.

Updat - The simple-to-use, flutter-based desktop update package #

Logo

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.

License Pub.dev Github Issues

Demo #

demo

Installing #

To get started simply type flutter pub add updat in your terminal.

🎉 Done, It's that simple.

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 ⚡️.

or use the UpdatWindowManager, and let updat handle everything on autopilot. Just place it right after your MaterialApp.

Want to learn how to integrate Updat in your app?

Integration Instructions

Configuration #

Available UpdatWidget arguments #

ParameterTypeValueDefault
currentVersionStringRequired. Must be a semantic version. This is the current package's version.N/A
getLatestVersionFuture<String>Required. Must be a semantic version. This should request the latest version to the serverN/A
getBinaryUrlFuture<String>Required. This should provide the link download the binary for a certain app version. Arguments: latestVersionN/A
appNmeStringRequired. The Application's name. It is used to name the binaries when downloading.N/A
getChangelogFuture<String>This will render a plain text view of the changelog.N/A
callbackvoid Function(UpdatStatus)A callback that is called when the UpdatStatus gets updated.N/A
getDownloadFileLocationFuture<File>Choose where to download the update.N/A
updateChipBuilderWidget Function(...)Overrides the default update chip.N/A
updateDialogBuilderWidget Function(...)Overrides the default update dialog.N/A
openOnDownloadboolWhether Updat should open the installer automatically once it has been downloaded.true
closeOnInstallboolWhether Updat should close the application automatically once it has been downloaded.false

Theming #

Logo

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

  • defaultChip which is an elevatedButton that only shows when an update is available. Shown by default.

  • defaultChipWithCheckFor which is an elevatedButton that shows under all conditions, allowing to recheck for updates.

  • defaultChipWithSilentDownload which is an elevatedButton that only shows when an update is downloaded and ready to install.

  • flatChip which is an textButton that only shows when an update is available

  • flatChipWithCheckFor which is an textButton that shows under all condition, allowing to recheck for updates.

  • flatChipWithSilentDownload which is an textButton that only shows when an update is downloaded and ready to install.

  • floatingExtendedChip which is a compact version of the dialog, which is a bit bigger and grabs user's attention more easily.

  • floatingExtendedChipWithSilentDownload which is a compact version of the dialog, which is a bit bigger and grabs user's attention more easily, and only shows when the update is ready to be installed.

Dialogs

  • defaultDialog which is the default, M2 and M3 dialog that shows by default.
2
likes
140
pub points
29%
popularity

Publisher

verified publisher iconeduardom.dev

Updat is a simple-to-use reliable flutter-native updater that handles your application's updates.

Repository (GitHub)

Documentation

API reference

License

Icon for licenses.AGPL-3.0 (LICENSE)

Dependencies

flutter, flutter_markdown, http, path, path_provider, pub_semver, url_launcher, window_manager

More

Packages that depend on updat