How to pass callback in Flutter

by

This is a more general answer for future viewers.

Callback types

There are a few different types of predefined callbacks:

final VoidCallback myVoidCallback = () {};
final ValueGetter<int> myValueGetter = () => 42;
final ValueSetter<int> myValueSetter = (value) {};
final ValueChanged<int> myValueSetter = (value) {};

Notes:

  • VoidCallback is an anonymous function that takes no arguments and returns no value.
  • ValueGetter is an anonymous function that returns a value, which you provide for someone who wants to get it.
  • ValueSetter is an anonymous function that takes a value as an argument, which you can use to set some other value.
  • ValueChanged has the same function signature and is used the same way as ValueSetter, but its name emphasizes that the given value actually changed (and was not just set with the same value again).

See this answer for more details.

Ways to write the callback

Good

When you are asked to provide a callback to an API, you can directly write the callback:

onPressed: () {},

Or you can supply the callback variable name (without parentheses):

onPressed: myVoidCallback,

Less good

It would be unnecessarily verbose to use both forms (but you could if you included the parentheses after the variable name):

onPressed: () {
  myVoidCallback();
},

This one is equivalent (but also unnecessarily verbose):

onPressed: () => myVoidCallback(),

Just use one of the “Good” forms from above.

Still good

The exception would be if you wanted to do something like call a value setter when the parameter is only asking for a void callback:

onPressed: () => myValueSetter(42),

More Related Contents:

  1. How to wait for forEach to complete with asynchronous callbacks?
  2. What is a Future and how do I use it?
  3. Is there a difference in how member variables are initialized in Dart?
  4. Flutter: How to correctly use an Inherited Widget?
  5. What is the difference between named and positional parameters in Dart?
  6. How to upload images and file to a server in Flutter?
  7. How do you detect the host platform from Dart code?
  8. How to import platform specific dependency in Flutter/Dart? (Combine Web with Android/iOS)
  9. How to implement Dark mode and Light Mode in flutter?
  10. How do I do the “frosted glass” effect in Flutter?
  11. How to Async/await in List.forEach() in Dart
  12. How to change the application launcher icon on Flutter?
  13. Flutter plugin not installed error; When running ‘flutter doctor’
  14. Flutter StreamBuilder vs FutureBuilder
  15. How to detect swipe in flutter
  16. Sizing elements to percentage of screen width/height
  17. Style BottomNavigationBar in Flutter
  18. Async/Await/then in Dart/Flutter
  19. TextField inside of Row causes layout exception: Unable to calculate size
  20. How to solve the “Type Null is not a subtype of type …” error?
  21. Vertical viewport was given unbounded height
  22. How can I layout widgets based on the size of the parent?
  23. Could not open settings generic class cache for settings file ‘
  24. How to run code after some delay in Flutter?
  25. How to shift focus to the next TextField in Flutter?
  26. InheritedWidget with Scaffold as child doesn’t seem to be working
  27. Preserving state between tab view pages
  28. Dart Future.wait for multiple futures and get back results of different types
  29. Flutter Navigation pop to index 1
  30. How can I detect if my Flutter app is running in the web?

Leave a Comment