Clarify primary and secondary actions in DetailedList#4212
Clarify primary and secondary actions in DetailedList#4212mhsmith merged 12 commits intobeeware:mainfrom
Conversation
johnzhou721
left a comment
There was a problem hiding this comment.
This looks pretty good already -- a couple of nits, and a direction to extend this in if you're interested.
|
Below is the latest draft. Are there any additional comments before creating the pull request? |
|
If you do want to update the "refresh" documentation, then you might as well do it in this PR. There's no point in creating a separate one. Some CI checks failed: you can see them at the bottom of the PR page, and you should also have received an email. Follow the links for instructions on how to resolve them. |
|
Also, please don't click the "resolve conversation" button; let the person who started the conversation do that. Automatic resolution when accepting a suggestion is OK. |
Sure, no problem, I'm still learning the platform, thanks for letting me know. |
I resolved the CI errors and started working on "refresh" documentation, |
Clarified the actions available in DetailedList across platforms, including refresh action details.
Documented refresh behavior along with clarifications.
| * On **GTK**, a right click on the selected row, displays the buttons for primary and secondary action. | ||
| * On **macOS**, a right click on the selected row, displays a context menu with the primary and secondary actions. | ||
| * On **Qt**, primary and secondary actions are displayed as buttons shown in the rows of the DetailedList. | ||
| Items in a DetailedList can respond to a primary action, a secondary action, and a refresh action. The implementation of each action varies by platform: |
There was a problem hiding this comment.
Items don't respond to a refresh action, hence the phrase "as a whole" further down.
| @@ -0,0 +1 @@ | |||
| Clarified platform-specific behavior for primary and secondary actions, and documented refresh behavior, in DetailedList. | |||
There was a problem hiding this comment.
Minor updates to the documentation should go in the misc category so they don't clutter the release notes.
| * On **macOS**, pulling on the trackpad triggers a refresh. | ||
| * On **iOS** and **Android**, pulling the list triggers a refresh. |
There was a problem hiding this comment.
These are both "pull-down" interactions, there's no need to make a distinction based on the hardware.
|
I've fixed the remaining issues. Thanks for the contribution! |
|
It was a great experience, thanks for being patient with me. |
The previous documentation described platform behavior in general terms, which was misleading for Android. This update explicitly describes how each platform implements primary and secondary actions: Android uses a long press menu, iOS uses swipe gestures, GTK and macOS use right-click menus, Qt displays standalone buttons, and Windows does not currently support actions.
Fixes: #3727