Skip to content

feat: keymanweb 2.0 (UI + Keyboard + Example + Map)#124

Open
Meng-Heng wants to merge 55 commits intokeymanapp:kmw-redev/mhfrom
Meng-Heng:kmw-redev
Open

feat: keymanweb 2.0 (UI + Keyboard + Example + Map)#124
Meng-Heng wants to merge 55 commits intokeymanapp:kmw-redev/mhfrom
Meng-Heng:kmw-redev

Conversation

@Meng-Heng
Copy link
Collaborator

@Meng-Heng Meng-Heng commented Nov 5, 2024

Fix #119

Some pointers for reviews:

Run

  1. web.keyman.com
  2. website.localhost
  3. s.keyman.com
  4. api.keyman.com

Files & Folders

  1. feature: store files that has UI manipulation & UI-related functions.
  2. operation: store logic from getting the keyboard data for search to displaying the keyboard & example.
  3. state: localStorage that remember important user interaction on the elements.
  4. main.mjs: act as the center & the head of the JS files

Expected to see

  1. Desktop
    Screenshot 2569-01-12 at 2 31 25 in the afternoon
  2. Tablet
    Screenshot 2569-01-12 at 2 36 12 in the afternoon
  3. Phone
    Screenshot 2569-01-12 at 2 36 46 in the afternoon

Thank you.


Old redesign

I'm placing the layout in here for now along with the stylings but I still have more interfaces to work on, including getting the actual keyman keyboard.

image

@keymanapp-test-bot skip

@Meng-Heng Meng-Heng added the feat label Nov 5, 2024
@Meng-Heng Meng-Heng added this to the A18S14 milestone Nov 5, 2024
@darcywong00 darcywong00 modified the milestones: A18S15, A18S16 Nov 24, 2024
@Meng-Heng Meng-Heng marked this pull request as draft November 25, 2024 07:11
@darcywong00 darcywong00 modified the milestones: A18S16, A18S17 Dec 7, 2024
@darcywong00 darcywong00 modified the milestones: A18S17, A18S18 Dec 21, 2024
@darcywong00 darcywong00 modified the milestones: A18S18, A18S19 Jan 6, 2025
@darcywong00 darcywong00 modified the milestones: A18S19, A18S20 Jan 18, 2025
@darcywong00 darcywong00 modified the milestones: A18S20, B18S1 Feb 1, 2025
@darcywong00 darcywong00 modified the milestones: B18S1, B18S2 Feb 15, 2025
@darcywong00 darcywong00 added this to the A19S15 milestone Oct 24, 2025
@keyman-server keyman-server modified the milestones: A19S15, A19S16 Nov 8, 2025
@keyman-server keyman-server modified the milestones: A19S16, A19S17 Nov 22, 2025
@keyman-server keyman-server modified the milestones: A19S17, A19S18 Dec 6, 2025
@keyman-server keyman-server modified the milestones: A19S18, A19S19 Dec 21, 2025
@keyman-server keyman-server modified the milestones: A19S19, A19S20 Jan 3, 2026
@Meng-Heng Meng-Heng marked this pull request as ready for review January 12, 2026 07:23
@Meng-Heng
Copy link
Collaborator Author

Meng-Heng commented Jan 12, 2026

Please test it out and let me know.

Some pointers for reviews:

Run

  1. web.keyman.com
  2. website.local.proxy
  3. s.keyman.com
  4. api.keyman.com

Files & Folders

  1. feature: store files that has UI manipulation & UI-related functions.
  2. operation: store logic from getting the keyboard data for search to displaying the keyboard & example.
  3. state: localStorage that remember important user interaction on the elements.
  4. main.mjs: act as the center & the head of the JS files

Expected to see

  1. Desktop
    Screenshot 2569-01-12 at 2 31 25 in the afternoon
  2. Tablet
    Screenshot 2569-01-12 at 2 36 12 in the afternoon
  3. Phone
    Screenshot 2569-01-12 at 2 36 46 in the afternoon

Thank you.

@darcywong00 darcywong00 modified the milestones: A19S20, A19S21 Jan 17, 2026
@darcywong00
Copy link
Contributor

FYI the PHP unit tests failed with

[Mon Jan 12 05:03:45.182035 2026] [php7:warn] [pid 28] [client 172.17.0.1:51126] PHP Warning: require_once(inc/foot.php): failed to open stream: No such file or directory in /var/www/html/index.php on line 207
[Mon Jan 12 05:03:45.182072 2026] [php7:error] [pid 28] [client 172.17.0.1:51126] PHP Fatal error: require_once(): Failed opening required 'inc/foot.php' (include_path='/var/www/html/_includes:.') in /var/www/html/index.php on line 207
Error: Process completed with exit code 1.

@Meng-Heng
Copy link
Collaborator Author

Thank you, @darcywong00. I'll work on resolving that.

@mcdurdin
Copy link
Member

@Meng-Heng I would like to do a more detailed review. But in the interests of moving forward, here are some thoughts on a first-pass UI review:

  • key cap letters too small
  • no tooltips on controls at top right
  • dragging grabber down should shrink OSK, not make it disappear
  • "Please wait it's loading" --> needs tweak

The menu:

  • It needs a title on the top to make it clear it's a menu -- otherwise the 'Instruction' text looks like the title
  • "Instruction" --> "Help" --> this can be a small widget saying '[x] Show site help' under the main menu items
  • SIL logo has hand but no link
  • Keyboard Help --> How to use
  • key strokes --> keystrokes (Keyboard Help)
  • privacy policy can just be a link at the bottom next to KMW version
  • Keyman --> Visit Keyman should be 'get this keyboard on <windows|mac|etc>'
  • KeymanHelp --> Keyman Help
  • Whole menu looks clickable ... but it isn't
  • (Visible | Hidden) --> not clear what this is for, need to use a standard widget

Order of links:

  • How to use
  • Keyman Help
  • Download Keyman (aka Get this keyboard)
  • Bookmarklet
  • Website Plugin

Search box:

  • Not clear that you can type to search
  • Title "Results" of search results probably not needed
  • Clicking outside the search box doesn't hide it
  • + sign to add the keyboard to the site is too hidden - we need to be able to click anywhere on the keyboard box to add the keyboard --> not clear that keyboard name is clickable
  • Icons for supported platforms not needed here
  • "Most Downloads" --> "Popular Keyboards"
    -> don't show language for popular keyboards
  • Pressing Shift+Home does not select text
  • Rapid typing gives wrong results for keyboard search; e.g. "Angkor" does not find Khmer Angkor reliably
  • 'Show More' link does not work reliably -> e.g. for Khmer (NIDA) Basic it shows less content after clicking it
  • Don't show page controls if < 10 results

Added keyboards:

  • These should be shown in the banner area individually unless there is insufficient space
    • On desktop, hovering over a keyboard should give access to the 4 controls, clicking should select it
  • Unnecessary scrollbars visible
  • Highlighting is unclear - colours and backgrounds

Text 'Selected: US Basic keyboard' in the search box is a little confusing

Notice: Undefined variable: result in /var/www/html/prog/renderLanguageExample.php on line 266

  1. Instructions should be visible in the keyboard selection box to start with
  2. Perhaps the search box should be focused on first visit to push users towards choosing a keyboard
  3. Not sure 'pouplar keyboarsd' is all that helpful, a drill-down search would be more useful. Esp. given top 10 keyboards all African at this point.

Instructions:

  1. Search for any language, keyboard, or country

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

Status: In Progress

Development

Successfully merging this pull request may close these issues.

5 participants

Comments