Implement UX Logging and Fix LLM Translation Shortcut Functionality #3241
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
ayanaar
force-pushed
the
3204-keyboard-attribution
branch
from
b93b5b3
to
bbd4c84
Compare
MpcOS77
approved these changes
Aug 10, 2024
eemeli
reviewed
Aug 20, 2024
| @@ -59,7 +59,10 @@ export const LLMTranslationProvider: React.FC = ({ children }) => { | |||
| stateRef.current.set(mt, { | |||
| loading: false, | |||
| selectedOption: characteristic, | |||
There was a problem hiding this comment.
It's a bit confusing that "selected option" and "characteristic" are names for essentially the same value, which is typed only as a string. These values should be typed more strictly, with something like
type Characteristic = 'rephrased' | 'formal' | 'informal'Also, the variable names should be consistent, so selectedCharacteristic instead of selectedOption.
Comment on lines
4
to
8
| export type SelState = { | ||
| loading: boolean; | ||
| selectedOption: string; | ||
| llmTranslation: string; | ||
| llmTranslations: Record<string, string>; | ||
| }; |
There was a problem hiding this comment.
It's unclear why this refactor is included in a fix for keyboard shortcuts.
translate/src/modules/translationform/utils/editFieldShortcuts.ts
Outdated
Show resolved
Hide resolved
translate/src/modules/translationform/utils/editFieldShortcuts.ts
Outdated
Show resolved
Hide resolved
ayanaar
changed the title
eemeli
approved these changes
Aug 29, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fully fixes #3204
This PR includes the following changes:
Refactored the LLM hook: The LLM hook (
useLLMTranslation) was refactored to return a function that is called outside of the callback. This change was made to address issues with theuseHandleCtrlShiftArrowfunction, which previously caused the keyboard shortcut to stop functioning correctly after an LLM translation was generated.Added UX logging: Implemented UX logging for when LLM translations are copied into the editor using the keyboard shortcut. This helps track the adoption and usage of the LLM translation feature.
Issue Resolved
Note
As discussed with @eemeli, there is a need for further refactoring to fully address this issue. Specifically, issue #3305 - "When the main edit box is not in focus, the global arrow key combinations (ArrowDown or ArrowUp) do not function as expected" - should be addressed in the future. While the current changes enable the feature to function as expected, a more comprehensive solution is still needed to address the underlying issue in the existing code.