Skip to content

Shortcuts streamline & help page the second - #1612

Open
Denperidge wants to merge 6 commits into
fossar:masterfrom
Denperidge:keybindings
Open

Shortcuts streamline & help page the second#1612
Denperidge wants to merge 6 commits into
fossar:masterfrom
Denperidge:keybindings

Conversation

@Denperidge

Copy link
Copy Markdown
Contributor

Re-open because Github doesnt like force pushes. Alas. Cleaned up & finished version of #1609 !

@netlify

netlify Bot commented Aug 18, 2026

Copy link
Copy Markdown

Deploy Preview for selfoss canceled.

Name Link
🔨 Latest commit e342a0f
🔍 Latest deploy log https://app.netlify.com/projects/selfoss/deploys/6a8c197a97d9b00008914b58

Comment thread client/styles/main.scss Outdated
Comment thread client/js/shortcuts.ts Outdated

@jtojnar jtojnar left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks. This looks very good already, just few details.

Comment thread client/js/shortcuts.ts Outdated
Comment thread client/js/shortcuts.ts Outdated
Comment thread client/styles/main.scss Outdated
Comment thread client/js/templates/App.tsx Outdated
Comment thread client/js/templates/HelpShortcuts.tsx Outdated
Comment thread client/js/templates/HelpShortcuts.tsx Outdated
Comment thread client/js/shortcuts.ts Outdated
Comment thread client/js/templates/HelpShortcuts.tsx Outdated
Comment thread client/js/shortcuts.ts
Comment thread client/js/templates/App.tsx Outdated
@Denperidge

Copy link
Copy Markdown
Contributor Author

@jtojnar Thanks for the review! Do I amend the changes into the original commits, or apply them as individual commits?

@jtojnar

jtojnar commented Aug 19, 2026

Copy link
Copy Markdown
Member

Please amend/use fixup commits and then git rebase -i --autosquash so that the history remains clear and each commit has working selfoss with passing CI. The i18n changes can go to a separate commit since without any translations the UI will be in English anyway.

…ate-heavy format

All keybindings have been tested manually since conversion
…from the docs

- Adapted arrow left & arrow right to the symbol used in docs
- Exception: "item" is replaced by "entry" for consistency
- Exception: Renamed throws to throw to previous / throw to next

Link to docs as of development of this commit:
https://github.com/fossar/selfoss/blob/81187a39a1b1db0e2d48fb0fccad949ca771a635/docs/content/docs/usage/shortcuts.md
@Denperidge
Denperidge force-pushed the keybindings branch 4 times, most recently from 1731898 to c604290 Compare August 21, 2026 22:36
Comment thread client/js/templates/HelpShortcuts.tsx Outdated
readableKeycombo = <kbd>{keybinding.readableName}</kbd>;
} else if (keycombo.includes('+')) {
const keys = keycombo
.split('+') // key={key} required for TS

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

// key={key} required for TS

This is general react thing: https://react.dev/learn/rendering-lists

It should not really be necessary here as the keybindings will never change but the compiler unfortunately is not smart enough.

I am surprised it does not complain about the fragment containing dt + dd.

Comment thread client/js/templates/HelpShortcuts.tsx Outdated
Comment thread client/js/shortcuts.ts
Comment thread client/js/shortcuts.ts Outdated
Comment thread client/js/shortcuts.ts
description: 'show help',
action: () => {},
},
'[Shift]+?': {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

We should also add it to the static docs.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Sure! Although, perhaps finishing up the auto-generated docs table might be better to make sure nothing falls through the cracks properly? Shift+R is also undocumented in the docs as of now

@Denperidge
Denperidge force-pushed the keybindings branch 2 times, most recently from dd420ff to d918445 Compare August 23, 2026 16:54
@Denperidge
Denperidge requested a review from jtojnar August 23, 2026 16:55
@Denperidge

Copy link
Copy Markdown
Contributor Author

With the exception of your fragment comment, everything has been implemented! Some notes:

  • Created a general Dialog component with a close button & scroll freeze for future proofing
  • I resolved your review comments as i implemented things (as an easy to-do list), but feel free to open a new one/re-open an old one if it's not resolved to your standards

Comment thread client/js/templates/Dialog.tsx Outdated
Comment thread client/js/templates/Dialog.tsx Outdated
Comment thread client/js/shortcuts.ts Outdated
Thanks to Jan for getting it to display using <dialog>!
And dealing with a bunch of my questions.

Co-authored-by: Jan Tojnar <jtojnar@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants