Clarify performacne of SingleTickerProviderStateMixin vs TickerProviderStateMixin #164870

yakagami · 2025-03-09T16:45:19Z

Adds the following line to TickerProviderStateMixin:

Using one [TickerProviderStateMixin] twice is more efficient than two [SingleTickerProviderStateMixin]s.

This is based on a discussion on Flutter Discord with @chunhtai. From what I understood, creating multiple SingleTickerProviderStateMixins is more expensive because you need two different state which is relatively costly compared to having just one. Not sure if this line should should be qualified like "Using one [TickerProviderStateMixin] twice is generally more efficient than two [SingleTickerProviderStateMixin]s" or similar.

This change should be reviewed for correctness as I don't actually understand enough about the difference between TickerProviderStateMixin and SingleTickerProviderStateMixin.

Closes #164869

Example case where this was relevant (click)

I was avoiding using TickerProviderStateMixin like so:

    _animationController = AnimationController.unbounded(vsync: this)
      ..addListener(() {
        _updateScale(_animationController.value);
      });
   
    //could have just set `vsync` to `this` if using `TickerProviderStateMixin`
    WidgetsBinding.instance.addPostFrameCallback((_) {
      _verticalAnimationController =
          AnimationController.unbounded(vsync: _verticalController.position.context.vsync)
            ..addListener(() {
              _verticalController.jumpTo(_verticalAnimationController.value);
            });

      _horizontalAnimationController =
          AnimationController.unbounded(vsync: _horizontalController.position.context.vsync)
            ..addListener(() {
              _horizontalController.jumpTo(_horizontalAnimationController.value);
            });
    });

Instead of just:

    _animationController = AnimationController.unbounded(vsync: this)
      ..addListener(() {
        _updateScale(_animationController.value);
      });

    _verticalAnimationController = AnimationController.unbounded(vsync: this)
      ..addListener(() {
        _verticalController.jumpTo(_verticalAnimationController.value);
      });

    _horizontalAnimationController = AnimationController.unbounded(vsync: this)
      ..addListener(() {
        _horizontalController.jumpTo(_horizontalAnimationController.value);
      });

Pre-launch Checklist

I read the Contributor Guide and followed the process outlined there for submitting PRs.
I read the Tree Hygiene wiki page, which explains my responsibilities.
I read and followed the Flutter Style Guide, including Features we expect every widget to implement.
I signed the CLA.
I listed at least one issue that this PR fixes in the description above.
I updated/added relevant documentation (doc comments with ///).
I added new tests to check the change I am making, or this PR is test-exempt.
I followed the breaking change policy and added Data Driven Fixes where supported.
All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

…erStateMixin

chunhtai

looking at the code, I can be sure this statement is true.

Using one [TickerProviderStateMixin] twice is more efficient than two [SingleTickerProviderStateMixin]s

chunhtai · 2025-03-10T15:55:25Z

packages/flutter/lib/src/widgets/ticker_provider.dart

 /// If you only have a single [Ticker] (for example only a single
 /// [AnimationController]) for the lifetime of your [State], then using a
 /// [SingleTickerProviderStateMixin] is more efficient. This is the common case.
+/// Using one [TickerProviderStateMixin] twice is more efficient than two


When creating multiple [AnimationController]s, using a single state with [TickerProviderStateMixin] as vsync for all [AnimationController]s is more efficient than creating multiple states with [SingleTickerProviderStateMixin].

and there should be a new line in between this and previous paragraph.

chunhtai

LGTM

gspencergoog

chunhtai · 2025-03-10T22:27:00Z

looks like there is trailing space

║ /b/s/w/ir/x/w/flutter/packages/flutter/lib/src/widgets/ticker_provider.dart:305: trailing U+0020 space character

yakagami · 2025-03-10T23:34:50Z

Should be fixed now.

…erProviderStateMixin (flutter/flutter#164870)

@chunhtai

…erStateMixin (flutter#164870) Adds the following line to [TickerProviderStateMixin](https://api.flutter.dev/flutter/widgets/TickerProviderStateMixin-mixin.html): >Using one [TickerProviderStateMixin] twice is more efficient than two [SingleTickerProviderStateMixin]s. This is based on a discussion on Flutter Discord with @chunhtai. From what I understood, creating multiple `SingleTickerProviderStateMixin`s is more expensive because you need two different state which is relatively costly compared to having just one. Not sure if this line should should be qualified like "Using one [TickerProviderStateMixin] twice is *generally* more efficient than two [SingleTickerProviderStateMixin]s" or similar. This change should be reviewed for correctness as I don't actually understand enough about the difference between `TickerProviderStateMixin` and `SingleTickerProviderStateMixin`. Closes flutter#164869 <details> <summary> Example case where this was relevant (click) </summary> I was avoiding using `TickerProviderStateMixin` like so: ```dart _animationController = AnimationController.unbounded(vsync: this) ..addListener(() { _updateScale(_animationController.value); }); //could have just set `vsync` to `this` if using `TickerProviderStateMixin` WidgetsBinding.instance.addPostFrameCallback((_) { _verticalAnimationController = AnimationController.unbounded(vsync: _verticalController.position.context.vsync) ..addListener(() { _verticalController.jumpTo(_verticalAnimationController.value); }); _horizontalAnimationController = AnimationController.unbounded(vsync: _horizontalController.position.context.vsync) ..addListener(() { _horizontalController.jumpTo(_horizontalAnimationController.value); }); }); ``` Instead of just: ```dart _animationController = AnimationController.unbounded(vsync: this) ..addListener(() { _updateScale(_animationController.value); }); _verticalAnimationController = AnimationController.unbounded(vsync: this) ..addListener(() { _verticalController.jumpTo(_verticalAnimationController.value); }); _horizontalAnimationController = AnimationController.unbounded(vsync: this) ..addListener(() { _horizontalController.jumpTo(_horizontalAnimationController.value); }); ``` </details> ## Pre-launch Checklist - [x] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [x] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [x] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [x] I signed the [CLA]. - [x] I listed at least one issue that this PR fixes in the description above. - [x] I updated/added relevant documentation (doc comments with `///`). - [x] I added new tests to check the change I am making, or this PR is [test-exempt]. - [x] I followed the [breaking change policy] and added [Data Driven Fixes] where supported. - [x] All existing and new tests are passing. If you need help, consider asking for advice on the #hackers-new channel on [Discord].  [Contributor Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview [Tree Hygiene]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md [test-exempt]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests [Flutter Style Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md [Features we expect every widget to implement]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement [CLA]: https://cla.developers.google.com/ [flutter/tests]: https://github.com/flutter/tests [breaking change policy]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes [Discord]: https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md [Data Driven Fixes]: https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md

Clarify performacne of SingleTickerProviderStateMixin vs TickerProvid…

b3a0472

…erStateMixin

github-actions bot added the framework flutter/packages/flutter repository. See also f: labels. label Mar 9, 2025

chunhtai reviewed Mar 10, 2025

View reviewed changes

yakagami added 3 commits March 10, 2025 14:27

add newline between paragraphs

8fb6340

use better clarification per review

cc51a29

fix line length over 80 chars

1b61dc5

chunhtai approved these changes Mar 10, 2025

View reviewed changes

gspencergoog approved these changes Mar 10, 2025

View reviewed changes

yakagami added 2 commits March 10, 2025 19:32

remove trailing whitespace

d80e07d

Merge branch 'master' into master

dd97b72

Merge branch 'master' into master

3beeaf8

chunhtai added the autosubmit Merge PR when tree becomes green via auto submit App label Mar 11, 2025

auto-submit bot added this pull request to the merge queue Mar 11, 2025

Merged via the queue into flutter:master with commit 7bf8837 Mar 11, 2025
75 checks passed

flutter-dashboard bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Mar 11, 2025

engine-flutter-autoroll mentioned this pull request Mar 11, 2025

Roll Flutter from b16430b2fd57 to 7bf883711647 (22 revisions) flutter/packages#8848

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 11, 2025

7bf8837 Clarify performacne of SingleTickerProviderStateMixin vs Tick…

251c37e

…erProviderStateMixin (flutter/flutter#164870)

engine-flutter-autoroll mentioned this pull request Mar 11, 2025

Roll Flutter from b16430b2fd57 to 9d2dcea4ab46 (23 revisions) flutter/packages#8849

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 11, 2025

7bf8837 Clarify performacne of SingleTickerProviderStateMixin vs Tick…

76bf80d

…erProviderStateMixin (flutter/flutter#164870)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 11, 2025

7bf8837 Clarify performacne of SingleTickerProviderStateMixin vs Tick…

ab37010

…erProviderStateMixin (flutter/flutter#164870)

This was referenced Mar 11, 2025

Roll Flutter from b16430b2fd57 to 463e7516406b (24 revisions) flutter/packages#8850

Closed

Roll Flutter from b16430b2fd57 to 1cfbc3c10622 (25 revisions) flutter/packages#8851

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 11, 2025

7bf8837 Clarify performacne of SingleTickerProviderStateMixin vs Tick…

f78f8fa

…erProviderStateMixin (flutter/flutter#164870)

engine-flutter-autoroll mentioned this pull request Mar 11, 2025

Roll Flutter from b16430b2fd57 to 61a5fe792957 (26 revisions) flutter/packages#8852

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 11, 2025

7bf8837 Clarify performacne of SingleTickerProviderStateMixin vs Tick…

dd53415

…erProviderStateMixin (flutter/flutter#164870)

engine-flutter-autoroll mentioned this pull request Mar 12, 2025

Roll Flutter from b16430b2fd57 to eef31a1c2b73 (34 revisions) flutter/packages#8856

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 12, 2025

7bf8837 Clarify performacne of SingleTickerProviderStateMixin vs Tick…

3109c70

…erProviderStateMixin (flutter/flutter#164870)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 15, 2025

7bf8837 Clarify performacne of SingleTickerProviderStateMixin vs Tick…

bd4c3cd

…erProviderStateMixin (flutter/flutter#164870)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 15, 2025

7bf8837 Clarify performacne of SingleTickerProviderStateMixin vs Tick…

7539c14

…erProviderStateMixin (flutter/flutter#164870)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 16, 2025

7bf8837 Clarify performacne of SingleTickerProviderStateMixin vs Tick…

f6044ff

…erProviderStateMixin (flutter/flutter#164870)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 16, 2025

7bf8837 Clarify performacne of SingleTickerProviderStateMixin vs Tick…

4ab2809

…erProviderStateMixin (flutter/flutter#164870)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 16, 2025

7bf8837 Clarify performacne of SingleTickerProviderStateMixin vs Tick…

7decb58

…erProviderStateMixin (flutter/flutter#164870)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 17, 2025

7bf8837 Clarify performacne of SingleTickerProviderStateMixin vs Tick…

8573b71

…erProviderStateMixin (flutter/flutter#164870)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 20, 2025

7bf8837 Clarify performacne of SingleTickerProviderStateMixin vs Tick…

7ebe257

…erProviderStateMixin (flutter/flutter#164870)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 25, 2025

7bf8837 Clarify performacne of SingleTickerProviderStateMixin vs Tick…

bd2bf3f

…erProviderStateMixin (flutter/flutter#164870)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 25, 2025

7bf8837 Clarify performacne of SingleTickerProviderStateMixin vs Tick…

41cab42

…erProviderStateMixin (flutter/flutter#164870)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 26, 2025

7bf8837 Clarify performacne of SingleTickerProviderStateMixin vs Tick…

f02346a

…erProviderStateMixin (flutter/flutter#164870)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 26, 2025

7bf8837 Clarify performacne of SingleTickerProviderStateMixin vs Tick…

573939f

…erProviderStateMixin (flutter/flutter#164870)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 26, 2025

7bf8837 Clarify performacne of SingleTickerProviderStateMixin vs Tick…

42ecffc

…erProviderStateMixin (flutter/flutter#164870)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 26, 2025

7bf8837 Clarify performacne of SingleTickerProviderStateMixin vs Tick…

97a244c

…erProviderStateMixin (flutter/flutter#164870)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 26, 2025

7bf8837 Clarify performacne of SingleTickerProviderStateMixin vs Tick…

08e8d1a

…erProviderStateMixin (flutter/flutter#164870)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 26, 2025

7bf8837 Clarify performacne of SingleTickerProviderStateMixin vs Tick…

57d273c

…erProviderStateMixin (flutter/flutter#164870)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 26, 2025

7bf8837 Clarify performacne of SingleTickerProviderStateMixin vs Tick…

1fed9d0

…erProviderStateMixin (flutter/flutter#164870)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 26, 2025

7bf8837 Clarify performacne of SingleTickerProviderStateMixin vs Tick…

22dbb82

…erProviderStateMixin (flutter/flutter#164870)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 27, 2025

7bf8837 Clarify performacne of SingleTickerProviderStateMixin vs Tick…

ccc1878

…erProviderStateMixin (flutter/flutter#164870)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 27, 2025

7bf8837 Clarify performacne of SingleTickerProviderStateMixin vs Tick…

acce621

…erProviderStateMixin (flutter/flutter#164870)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 27, 2025

7bf8837 Clarify performacne of SingleTickerProviderStateMixin vs Tick…

65f5ec2

…erProviderStateMixin (flutter/flutter#164870)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 27, 2025

7bf8837 Clarify performacne of SingleTickerProviderStateMixin vs Tick…

5d7c042

…erProviderStateMixin (flutter/flutter#164870)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 27, 2025

7bf8837 Clarify performacne of SingleTickerProviderStateMixin vs Tick…

6af398a

…erProviderStateMixin (flutter/flutter#164870)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 27, 2025

7bf8837 Clarify performacne of SingleTickerProviderStateMixin vs Tick…

2bad041

…erProviderStateMixin (flutter/flutter#164870)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 27, 2025

7bf8837 Clarify performacne of SingleTickerProviderStateMixin vs Tick…

51627ea

…erProviderStateMixin (flutter/flutter#164870)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 27, 2025

7bf8837 Clarify performacne of SingleTickerProviderStateMixin vs Tick…

38eaae5

…erProviderStateMixin (flutter/flutter#164870)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 28, 2025

7bf8837 Clarify performacne of SingleTickerProviderStateMixin vs Tick…

b1ef1ea

…erProviderStateMixin (flutter/flutter#164870)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 20, 2025

7bf8837 Clarify performacne of SingleTickerProviderStateMixin vs Tick…

b0dbf6e

…erProviderStateMixin (flutter/flutter#164870)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 20, 2025

7bf8837 Clarify performacne of SingleTickerProviderStateMixin vs Tick…

8187187

…erProviderStateMixin (flutter/flutter#164870)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 21, 2025

7bf8837 Clarify performacne of SingleTickerProviderStateMixin vs Tick…

bfcf6fd

…erProviderStateMixin (flutter/flutter#164870)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Clarify performacne of SingleTickerProviderStateMixin vs TickerProviderStateMixin #164870

Clarify performacne of SingleTickerProviderStateMixin vs TickerProviderStateMixin #164870

Uh oh!

yakagami commented Mar 9, 2025 •

edited

Loading

Uh oh!

chunhtai left a comment

Uh oh!

chunhtai Mar 10, 2025

Uh oh!

yakagami Mar 10, 2025

Uh oh!

chunhtai left a comment

Uh oh!

gspencergoog left a comment

Uh oh!

chunhtai commented Mar 10, 2025

Uh oh!

yakagami commented Mar 10, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Clarify performacne of SingleTickerProviderStateMixin vs TickerProviderStateMixin #164870

Clarify performacne of SingleTickerProviderStateMixin vs TickerProviderStateMixin #164870

Uh oh!

Conversation

yakagami commented Mar 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

Uh oh!

chunhtai left a comment

Choose a reason for hiding this comment

Uh oh!

chunhtai Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

yakagami Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

chunhtai left a comment

Choose a reason for hiding this comment

Uh oh!

gspencergoog left a comment

Choose a reason for hiding this comment

Uh oh!

chunhtai commented Mar 10, 2025

Uh oh!

yakagami commented Mar 10, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

yakagami commented Mar 9, 2025 •

edited

Loading