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

[Bug] Printing Tool Displays Unintuitive Key Labels Instead of Readable Key Names #1363

Closed
jeffersonjpr opened this issue Sep 20, 2024 · 5 comments
Labels

Comments

@jeffersonjpr
Copy link

Describe the Bug

Default tool key labels:
image

Example from Chrome's Print Feature:
image

QMK Configurator print feature:
image

Additional Context?

No response

@yanfali
Copy link
Collaborator

yanfali commented Sep 22, 2024

Sorry. Could you give more context. Which one is your preference? Unintuitive is somewhat subjective so it's difficult to understand. Maybe some annotation around which representation you think is problematic and some possible solutions.

@jeffersonjpr
Copy link
Author

I apologize if my explanation wasn't clear. Please take a look at these two keys:

image
The behavior is: if I hold the key, it activates layer 2; if I just tap it, it triggers other keys.

Notice the difference in how the key behavior is represented in the printing tool. It shows the enum definitions from the code rather than the actual symbols they represent.
image
The original representation in the configurator is just fine. I think the layout should remain the same in the printing tool.

@yanfali
Copy link
Collaborator

yanfali commented Oct 7, 2024

Interesting that it's doing that. Maybe it should be a toggle.

@yanfali
Copy link
Collaborator

yanfali commented Nov 7, 2024

Took some time to look at this today and the issue is how they keys are represented in the printing view. In the visual keymap there are specialized components for each of these container types. In the PrintKey.vue component we just have the single component and it tries it's best to do the right thing for each keycode.

One quick fix, would be to stop printing the QMK code and just show the display version.

image

If that's acceptable I'll open a PR.

yanfali added a commit that referenced this issue Nov 7, 2024
Issue [1363](#1363)

Change the PrintKey to show the `.name` instead of the `.code` attribute
because it's less human friendly. Remove some of the extraneous
formatting around the element.

This stems slightly from the different way we render Key components in
the printing vs editing.
yanfali added a commit that referenced this issue Nov 8, 2024
Issue [1363](#1363)

Change the PrintKey to show the `.name` instead of the `.code` attribute
because it's less human friendly. Remove some of the extraneous
formatting around the element.

This stems slightly from the different way we render Key components in
the printing vs editing.
@yanfali
Copy link
Collaborator

yanfali commented Nov 8, 2024

ok, this should be resolved. I'll close it for now. Thanks.

@yanfali yanfali closed this as completed Nov 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants