Skip to content

[UX] Help component #3135

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

Merged
merged 16 commits into from
Jan 1, 2024
Merged

[UX] Help component #3135

merged 16 commits into from
Jan 1, 2024

Conversation

arielj
Copy link
Collaborator

@arielj arielj commented Oct 14, 2023

This PR adds a component to have Help for users built in into the app.

We can use this to add information about the components in the interface, details about how to use specific screens or features, anything we want. The idea is to allow people to find answers on their own without leaving the app and also adds an opportunity to translate all that information.

I added it as an experimental feature for now, I only added a few basic strings.

Important:

  • it needs Electron 26 to be able to use the popover API, this is needed to be able to show an element ABOVE dialogs like the install or setting dialogs, since those are in the top layer and we need this new API to put elements in there
  • because of this I understand it wouldn't work on some machines so this is not to merge until we figure out how to upgrade Electron safely

This is a super basic example of how it works since I added only a few things there:

help.mp4

We can put anything for the element's content using the hasHelp hook.


Use the following Checklist if you have changed something on the Backend or Frontend:

  • Tested the feature and it's working on a current and clean install.
  • Tested the main App features and they are still working on a current and clean install. (Login, Install, Play, Uninstall, Move games, etc.)
  • Created / Updated Tests (If necessary)
  • Created / Updated documentation (If necessary)

@arielj arielj added the pr:testing This PR is in testing, don't merge. label Oct 14, 2023
@Etaash-mathamsetty
Copy link
Member

Etaash-mathamsetty commented Oct 14, 2023

electron 27 works properly, 26 has known bugs. 27 has been released, so it should be safer to upgrade to it. there's still the issue with the gamepad navigation on electron 27.

@arielj
Copy link
Collaborator Author

arielj commented Oct 14, 2023

electron 27 works properly, 26 has known bugs. 27 has been released, so it should be safer to upgrade to it. there's still the issue with the gamepad navigation on electron 27.

I see, looks like it has issues focusing elements inside an element with scroll when using the spatial navigation

the gamepad works fine, the issue is the spatial navigation (same issue happens moving with the keyboard)

the controls work fine in screens that are not scrollable like the login or the game page

do you know if there's a reported issue for that problem?

EDIT: if I get inside the container that has scroll using tab then the game pad works fine

@arielj
Copy link
Collaborator Author

arielj commented Oct 14, 2023

I found a workaround for the problem, I made a PR to upgrade to Electron 27 and once that's done I can update this one #3136

@flavioislima
Copy link
Member

I found a workaround for the problem, I made a PR to upgrade to Electron 27 and once that's done I can update this one #3136

do you want to merge this PR before the next release?

@arielj
Copy link
Collaborator Author

arielj commented Oct 30, 2023

I found a workaround for the problem, I made a PR to upgrade to Electron 27 and once that's done I can update this one #3136

do you want to merge this PR before the next release?

nono, it's too barebones, it's gonna be useless for everyone the way it is now, not even useful as an experimental feature to release yet

I think it can be merged after the next release once I fix the conflicts and that issue that I needed electron 27 to fix to have that for us to test more internally and to start adding help content

@arielj arielj requested review from a team, flavioislima, CommandMC, Etaash-mathamsetty, Nocccer and imLinguin and removed request for a team December 16, 2023 23:42
@arielj arielj added pr:ready-for-review Feature-complete, ready for the grind! :P and removed pr:testing This PR is in testing, don't merge. labels Dec 16, 2023
"allowpopups",
"useragent",
"popover",
"popovertarget"
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

typescript doesn't understand these properties, they are too new

Copy link
Member

@flavioislima flavioislima left a comment

Choose a reason for hiding this comment

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

lgtm

@arielj arielj merged commit 60434a5 into main Jan 1, 2024
@arielj arielj deleted the help-component branch January 1, 2024 23:02
@Heroic-Games-Launcher Heroic-Games-Launcher locked and limited conversation to collaborators Jan 1, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
pr:ready-for-review Feature-complete, ready for the grind! :P
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants