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

Added Language-Specific Placeholders and Prompts for Scribe Keyboard #285

Merged
merged 5 commits into from
Jan 1, 2025

Conversation

akshayw1
Copy link
Contributor

@akshayw1 akshayw1 commented Jan 1, 2025

Contributor checklist


Description

This PR addresses a major issue for adding functionality to the Scribe keyboard. It ensures that all labels and placeholder texts are added for the command buttons in the Scribe-Android keyboard, while also considering language-specific prompts from the helper files. Here's what was implemented:

  • The user presses the Scribe key and selects a command.
  • Instead of just a text input, a proxy with a label and greyed-out placeholder text is shown.
  • The placeholder text is replaced once the user starts typing.
  • If the user deletes all the text, the placeholder text reappears.
  • The label text within the proxy cannot be deleted (only editable once the user starts typing).

Modular Code and Language Support:

  • The changes have been modularized to ensure that the placeholders and prompts are dynamically fetched based on the language of the keyboard.
  • Language-specific helper files (e.g., ENInterfaceVariables, FRInterfaceVariables, etc.) are used to handle prompts and labels in the corresponding language.
  • The structure ensures the keyboard adapts seamlessly to various languages without code duplication, making it scalable for future language additions.

Screenshots of Changes

image image image

Testing

  • Manual Testing: I have manually tested the functionality to ensure that the placeholder text behaves as expected (appears initially, disappears when typing, reappears if text is deleted) in different languages.
  • Language-Specific Testing: Ensured that placeholders and prompts are fetched correctly based on the selected keyboard language using the helper files for each language.
  • Linting: Ran ./gradlew lintKotlin and resolved any lint issues.
  • Build Compatibility: The build passes without issues, and no regressions were found during testing.

Related issue

Copy link

github-actions bot commented Jan 1, 2025

Thank you for the pull request!

The Scribe team will do our best to address your contribution as soon as we can. The following is a checklist for maintainers to make sure this process goes as well as possible. Feel free to address the points below yourself in further commits if you realize that actions are needed :)

If you're not already a member of our public Matrix community, please consider joining! We'd suggest using Element as your Matrix client, and definitely join the General and Android rooms once you're in. Also consider joining our bi-weekly Saturday dev syncs. It'd be great to have you!

Maintainer checklist

  • The linting and formatting workflows within the PR checks do not indicate new errors in the files changed

  • The CHANGELOG has been updated with a description of the changes for the upcoming release and the corresponding issue (if necessary)

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

First PR Commit Check

  • The commit messages for the remote branch should be checked to make sure the contributor's email is set up correctly so that they receive credit for their contribution
    - The contributor's name and icon in remote commits should be the same as what appears in the PR
    - If there's a mismatch, the contributor needs to make sure that the email they use for GitHub matches what they have for git config user.email in their local Scribe-Android repo (can be set with git config --global user.email "GITHUB_EMAIL")

@andrewtavis andrewtavis self-requested a review January 1, 2025 22:55
Copy link
Member

@andrewtavis andrewtavis left a comment

Choose a reason for hiding this comment

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

All's working really well here, @akshayw1, and this is a great first step to getting the command functionality up and running! I'll be making a few issues based on the current state of the application right now. Maybe these include the work that needs to be done you were referring to, but of course let me know if there are other issues you think we need to make! Also feel free to pick up another issue 😊

@andrewtavis andrewtavis merged commit 512f27c into scribe-org:main Jan 1, 2025
4 checks passed
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