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

refactor(web): refactor JS based keyboard related class and file names 🎼 #12824

Open
wants to merge 6 commits into
base: feat/web/loadkmx
Choose a base branch
from

Conversation

ermshiperete
Copy link
Contributor

@ermshiperete ermshiperete commented Dec 11, 2024

This PR renames several JS keyboard related classes and files to make it easier in upcoming changes to distinguish between JS and KMX based keyboards.

Part-of: #11293
@keymanapp-test-bot skip

@keymanapp-test-bot
Copy link

keymanapp-test-bot bot commented Dec 11, 2024

User Test Results

Test specification and instructions

User tests are not required

@keymanapp-test-bot keymanapp-test-bot bot changed the title refactor(web): refactor JS based keyboard related class and file names refactor(web): refactor JS based keyboard related class and file names 🎼 Dec 11, 2024
@keymanapp-test-bot keymanapp-test-bot bot added this to the A18S17 milestone Dec 11, 2024
@ermshiperete ermshiperete marked this pull request as draft December 11, 2024 18:49
@ermshiperete ermshiperete force-pushed the refactor/web/jskeyboards branch from 27e7418 to c359fe7 Compare December 16, 2024 17:21
@ermshiperete ermshiperete force-pushed the refactor/web/jskeyboards branch from c359fe7 to b4d78ce Compare December 20, 2024 17:04
@ermshiperete ermshiperete marked this pull request as ready for review December 20, 2024 19:25
@darcywong00 darcywong00 modified the milestones: A18S17, A18S18 Dec 21, 2024
@darcywong00 darcywong00 modified the milestones: A18S18, A18S19 Jan 6, 2025
Copy link
Contributor

@jahorton jahorton Jan 8, 2025

Choose a reason for hiding this comment

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

My personal complaint here: in the long-term, the OSK should not need to be aware of whether the underlying keyboard is JS-based or LDML-based. There should be some common ancestor type between JSKeyboard and LDMLKeyboard (or similar) that provides the common properties that matter.

For example, the .isRTL flag would need to be available in some form for LDML keyboards, too.

  • needed to correctly order banner suggestions + expand long ones on the correct side
  • needed to select correct BKSP and ENTER key glyphs, which are directional

Keyboards will also have a name that's displayed to the user in some form, regardless of whether they're JS or LDML. (See TitleBar further below.)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Completely agree. However, I'd prefer to do that in a later PR since it's unclear (at least to me) how that would be done with LDML. We can (and will have to) deal with it when we get there.

This PR is just one step further in my work with integrating LDML keyboards into Web and will require many more PRs and probably also changes to the changes that were made in this PR.

@ermshiperete ermshiperete force-pushed the refactor/web/jskeyboards branch from b4d78ce to f8ed96a Compare January 14, 2025 14:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

3 participants