-
Notifications
You must be signed in to change notification settings - Fork 29.7k
Add documentation for the secondary button #164555
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
Add documentation for the secondary button #164555
Conversation
|
@TahaTesser can you please check the pr u.u I would love to make more improvements if needed. |
| /// The secondary button is typically accessed using the right mouse | ||
| /// button on desktop platforms such as Windows, macOS, and Linux. |
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.
| /// The secondary button is typically accessed using the right mouse | |
| /// button on desktop platforms such as Windows, macOS, and Linux. | |
| /// The secondary button is typically accessed using the right mouse | |
| /// button on desktop platforms such as Windows, macOS, and Linux. |
If it's a mouse button, it does't necessarily only for Windows, macOS, and Linux. You can connect mouse to other devices.
According to some Google search, the secondary button is the right mouse button for right-handed users and left mouse button for the left-handed users.
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.
Thanks for suggestion! I'm sending changes
| /// | ||
| /// The secondary button is a mouse button that can be configured | ||
| /// based on the user's system settings. By default, it is the | ||
| /// right button for right-handed users and the left button for | ||
| /// left-handed users. |
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.
The secondary button is an abstraction not specific to mouse.
See https://api.flutter.dev/flutter/gestures/kSecondaryButton-constant.html which explains how it maps to stylus and mouse.
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.
Thanks for suggestion. To avoid own reinterpretation of the secondary button, I'm sending new documentation that references kSecondaryButton in a similar way to how the GestureDetector docs do.
bleroux
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!
TahaTesser
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
<!-- Thanks for filing a pull request! Reviewers are typically assigned within a week of filing a request. To learn more about code review, see our documentation on Tree Hygiene: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md --> In this PR, I've added extra comments about what the Secondary Button is, and in what cases it can be activated. Issue flutter#123049 ## 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. <!-- Links --> [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 --------- Co-authored-by: Darien Romero <[email protected]>
In this PR, I've added extra comments about what the Secondary Button is, and in what cases it can be activated. Issue #123049
Pre-launch Checklist
///).