Skip to content
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

feat: enhance recorder GUI & fix syntax highlighting #1183

Merged
merged 6 commits into from
Nov 13, 2023

Conversation

eglitise
Copy link
Collaborator

@eglitise eglitise commented Nov 8, 2023

This PR updates the GUI for the recorder functionality:

  • Change location from a toggleable panel to a separate tab
    • Prevents confusion between buttons for pausing the recording, closing the panel, and clearing recorded actions
    • Makes it easier to read the code when boilerplate is enabled
    • Avoids reducing the visible height of all other tabs (which sometimes broke the application layout)
  • Show language dropdown even when no code has been recorded
  • Update some icons and element sizes
    • Also applies to the session code box
  • Fix syntax highlighting (not shown in the video)
    • Also applies to the session code box and capabilities box
new-recorder-gui.mp4

Additionally, there is a fix for the copy code functionality in the session code box - it was not copying raw code.

@eglitise eglitise added enhancement New feature or request fix This resolves a user-facing problem labels Nov 8, 2023
@jlipps
Copy link
Member

jlipps commented Nov 8, 2023

Have not yet reviewed code. From a feature perspective I think this is great. My only concern is that when the user is interacting with the app on a different tab (e.g. source tab), there's no feedback that stuff is happening on the recording tab. Some ideas:

  • near the "Recording" tab header, keep a badge which is a count of commands recorded, so the user can see it ticking up
  • some kind of info message that quickly disappears showing the command added to the recorder

also open to other ideas!

@eglitise
Copy link
Collaborator Author

eglitise commented Nov 8, 2023

Hmm, I was thinking that having the recorder icon change to red would be enough to indicate that any action (other than gestures) will now generate code. Worst case, the user can always switch to the recorder tab to check.
Badge is probably doable, but counting actions like this does feel somewhat arbitrary.
Info message I'm not too keen on, it could easily get in the way of the user flow.

@eglitise
Copy link
Collaborator Author

For another improvement to the recorder GUI, I've fixed the syntax highlighting (this fix also applies to the session code box and capabilities box). Also removed the format-json package, whose utilized functionality could be replaced with a one-liner.

@eglitise eglitise changed the title feat: enhance recorder GUI feat: enhance recorder GUI & fix syntax highlighting Nov 11, 2023
@eglitise eglitise merged commit 7202798 into appium:main Nov 13, 2023
4 of 5 checks passed
@eglitise eglitise deleted the update-recorder-gui branch November 13, 2023 07:21
shiva-guntoju pushed a commit to shiva-guntoju/appium-inspector that referenced this pull request Feb 2, 2024
* feat: move recorder code box to separate tab

* fix: copy raw session code + improve style

* fix: get syntax highlighting to work again

* chore: remove format-json dependency

* chore: fix linting issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request fix This resolves a user-facing problem
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants