Skip to content

Prepare the flutter.material.RawMaterialButton.mouseCursor doc template for themeable mouse cursors - #88470

Merged
HansMuller merged 1 commit into
flutter:masterfrom
jpnurmi:button-mouse-cursor-doc
Feb 4, 2022
Merged

HansMuller merged 1 commit into
flutter:masterfrom
jpnurmi:button-mouse-cursor-doc

Conversation

@jpnurmi

@jpnurmi jpnurmi commented Aug 18, 2021

Copy link
Copy Markdown
Member

Prepare the docs for themeable mouse cursors by moving

If this property is null, [MaterialStateMouseCursor.clickable] will be used.

outside the template, because when adding themeable mouse cursors, the description changes to something like:

If null, then the value of [FloatingActionButtonThemeData.mouseCursor] is used. If that is also null, then [MaterialStateMouseCursor.clickable] is used.

Coincidentally, this also fixes IconButton.mouseCursor docs that ended up having duplicate defaults in #63885.

Related issues

Motivated by themeable mouse cursors: #88371
Fixes IconButton.mouseCursor docs: #63885

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 feature I am adding, or Hixie said the PR is test-exempt.
  • All existing and new tests are passing.

@flutter-dashboard

Copy link
Copy Markdown

It looks like this pull request may not have tests. Please make sure to add tests before merging. If you need an exemption to this rule, contact Hixie on the #hackers channel in Chat.

If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix?

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

@flutter-dashboard flutter-dashboard Bot added p: material_ui material_ui package in flutter/packages framework flutter/packages/flutter repository. See also f: labels. labels Aug 18, 2021
@google-cla google-cla Bot added the cla: yes label Aug 18, 2021
@jpnurmi

jpnurmi commented Aug 18, 2021

Copy link
Copy Markdown
Member Author

IconButton.mouseCursor docs:

Before After
Screenshot from 2021-08-18 22-28-56 Screenshot from 2021-08-18 22-36-23

@Hixie

Hixie commented Aug 18, 2021

Copy link
Copy Markdown
Contributor

test-exempt: only affects comments

@HansMuller
HansMuller self-requested a review August 20, 2021 18:04
@flutter-dashboard

Copy link
Copy Markdown

This pull request executed golden file tests, but it has not been updated in a while (20+ days). Test results from Gold expire after as many days, so this pull request will need to be updated with a fresh commit in order to get results from Gold.

For more guidance, visit Writing a golden file test for package:flutter.

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

@HansMuller HansMuller left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is OK however RawMaterialButton isn't really used much any more. It would be better to adjust the InkWell.mouseCursor API doc, make that the template, and replace {@macro flutter.material.RawMaterialButton.mouseCursor} with {@macro flutter.material.InkWell.mouseCursor}

@jpnurmi

jpnurmi commented Jan 14, 2022

Copy link
Copy Markdown
Member Author

Thanks for the suggestion (and for taking care of the other mouse cursor changes). There's one important difference between RawMaterialButton.mouseCursor and InkWell.mouseCursor:

 /// The cursor for a mouse pointer when it enters or is hovering over the
-/// button.
+/// widget.
 ///
 /// If [mouseCursor] is a [MaterialStateProperty<MouseCursor>],
 /// [MaterialStateProperty.resolve] is used for the following [MaterialState]s:
 ///
-///  * [MaterialState.pressed].
 ///  * [MaterialState.hovered].
 ///  * [MaterialState.focused].
 ///  * [MaterialState.disabled].

@HansMuller HansMuller left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@fluttergithubbot

Copy link
Copy Markdown
Contributor

This pull request is not suitable for automatic merging in its current state.

  • Please get at least one approved review if you are already a member or two member reviews if you are not a member before re-applying this label. Reviewers: If you left a comment approving, please use the "approve" review action instead.

@goderbauer goderbauer left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@HansMuller
HansMuller merged commit 4b82d47 into flutter:master Feb 4, 2022
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 4, 2022
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 4, 2022
engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Feb 4, 2022
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 4, 2022
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 4, 2022
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 4, 2022
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 8, 2022
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 8, 2022
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 8, 2022
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 8, 2022
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 8, 2022
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 8, 2022
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 8, 2022
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 8, 2022
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 8, 2022
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 8, 2022
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 8, 2022
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 8, 2022
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 8, 2022
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 8, 2022
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 8, 2022
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 8, 2022
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

framework flutter/packages/flutter repository. See also f: labels. p: material_ui material_ui package in flutter/packages

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants