-
Notifications
You must be signed in to change notification settings - Fork 29.8k
Fix WidgetStateProperty documentation
#154298
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix WidgetStateProperty documentation
#154298
Conversation
| /// The cursor for a mouse pointer when it enters or is hovering over the | ||
| /// widget. | ||
| /// | ||
| /// If [mouseCursor] is a [WidgetStateProperty<MouseCursor>], |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can imagine someone reading this and then being confused as to why their WidgetStateProperty<MouseCursor> object doesn't work as an argument for mouseCursor.
There are other similar files that include a description of WidgetStateMouseCursor as a footnote, but I think ideally the explanation should focus on this type.
87e7a62 to
51ebc75
Compare
This comment was marked as outdated.
This comment was marked as outdated.
bfd64d4 to
de201b8
Compare
de201b8 to
1a36091
Compare
WidgetStateProperty upkeepWidgetStateProperty documentation
MitchellGoodwin
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! This should be much clearer.
| /// from the user. | ||
| /// | ||
| /// States are defined by https://material.io/design/interaction/states.html#usage, | ||
| /// States are defined by https://m3.material.io/foundations/interaction/states, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch and update! 👍
flutter/flutter@8591d0c...29d40f7 2024-11-05 andrewrkolos@gmail.com increase subsharding for `Windows build_tests` from 8 to 9 (flutter/flutter#158146) 2024-11-05 polinach@google.com Reland2: Revert "Revert "Add a warning/additional handlers for parsing`synthetic-package`."" (flutter/flutter#158184) 2024-11-05 polinach@google.com Reland1: "Revert "Add and plumb `useImplicitPubspecResolution` across `flutter_tools`."" (flutter/flutter#158126) 2024-11-05 engine-flutter-autoroll@skia.org Roll Packages from 796afa3 to 7219431 (11 revisions) (flutter/flutter#158179) 2024-11-05 kustermann@google.com Make native asset integration test more robust, thereby allowing smooth auto-update of packages via `flutter update-packages` (flutter/flutter#158170) 2024-11-05 mohellebiabdessalem@gmail.com Readability change to `flutter.groovy`, align on null assignment, reduce unused scope for some methods, apply static where possible (flutter/flutter#157471) 2024-11-05 engine-flutter-autoroll@skia.org Roll Flutter Engine from 7207a8fbec93 to f56401062e42 (1 revision) (flutter/flutter#158169) 2024-11-05 32538273+ValentinVignal@users.noreply.github.com Add test for `raw_scrollbar.shape.0.dart` (flutter/flutter#158094) 2024-11-05 engine-flutter-autoroll@skia.org Roll Flutter Engine from 418609dd5b58 to 7207a8fbec93 (1 revision) (flutter/flutter#158156) 2024-11-05 bruno.leroux@gmail.com Refactor DropdownMenu tests (flutter/flutter#157913) 2024-11-05 engine-flutter-autoroll@skia.org Roll Flutter Engine from 6271a92a376f to 418609dd5b58 (3 revisions) (flutter/flutter#158152) 2024-11-05 fluttergithubbot@gmail.com Marks Linux_pixel_7pro flavors_test to be flaky (flutter/flutter#156956) 2024-11-05 matanlurey@users.noreply.github.com Further remove web-only considerations that are no longer necessary (flutter/flutter#158143) 2024-11-05 polinach@google.com Add optional parameter to FlutterTesterDevices. (flutter/flutter#158133) 2024-11-05 engine-flutter-autoroll@skia.org Roll Flutter Engine from 75acceedca41 to 6271a92a376f (2 revisions) (flutter/flutter#158148) 2024-11-05 matanlurey@users.noreply.github.com Extract and restore a test that a blank native assets project still builds (flutter/flutter#158141) 2024-11-04 matanlurey@users.noreply.github.com Remove references to the HTML renderer in public docs. (flutter/flutter#158035) 2024-11-04 engine-flutter-autoroll@skia.org Roll Flutter Engine from f880b56b6ede to 75acceedca41 (1 revision) (flutter/flutter#158137) 2024-11-04 nate.w5687@gmail.com Fix `WidgetStateProperty` documentation (flutter/flutter#154298) 2024-11-04 engine-flutter-autoroll@skia.org Roll Flutter Engine from 25c7e471e2ef to f880b56b6ede (5 revisions) (flutter/flutter#158132) 2024-11-04 engine-flutter-autoroll@skia.org Roll Flutter Engine from 05cb5d7f7939 to 25c7e471e2ef (12 revisions) (flutter/flutter#158127) 2024-11-04 737941+loic-sharma@users.noreply.github.com Remove use_modular_headers! from Swift Podfiles (flutter/flutter#156257) 2024-11-04 victorsanniay@gmail.com Disable failing native assets test (flutter/flutter#158119) 2024-11-04 nate.w5687@gmail.com Fix `NestedScrollView` inner position logic (flutter/flutter#157756) 2024-11-04 jacksongardner@google.com Add benchmarks for single-threaded Skwasm. (flutter/flutter#158027) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages Please CC camillesimon@google.com,stuartmorgan@google.com on the revert to ensure that a human is aware of the problem. To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
Changes:
WidgetStateMouseCursor.WidgetStateFooconstructors now accurately describe what happens when used incorrectly.WidgetStatePropertya little section about equality checks.