Highlight autocompletion if it is the word typed

[andrewtavis]

Terms

• I have searched open and closed feature requests
• I agree to follow Scribe-iOS' Code of Conduct

Description

This issue a a simple one to reflect system behavior where when the keyboard suggests the exact word the user has typed as a completion it's usually enclosed in quotes. What Scribe could do for this is lightly change the background of the autocompletion if the word is the given word. This is also done in some other keyboard apps, and I think it's more appealing than the word in quotes.

The background of the completion key would thus need to be conditionally changed and reset as the user continues typing :)

Contribution

Happy to support someone who wants to try this issue 😊

[techsandu]

Hey @andrewtavis can you please assign this in my name? I will look into this and come back.

[andrewtavis]

Sure thing, @techsandu! Thanks for reaching out!

Would you like me to give you a detailed breakdown of where to look in the codes? Happy to send something along to contextualize this for you 😊

[andrewtavis]

In case it would be helpful, the assignment of the word is within this function:

Scribe-iOS/Keyboards/KeyboardsBase/KeyboardViewController.swift

Line 360 in fb268f4

func conditionallySetAutoActionBtns() {

So basically we need to do a comparison of the word that's in the proxy with completionWords[0], as naturally the first suggestion would be the one we want a slightly different coloration for given alphabetization. If memory serves me, currentPrefix also saves the value being typed in any given moment, so that would be what we're comparing completionWords[0] to, and in case they are the same we'd be changing the color argument of the function setBtn in conditionallySetAutoActionBtns linked to above 😊

As far as a color, I'm open to suggestions, but maybe something like keyColor with an alpha would be in order? Would be very happy to answer any other questions you have about this!

[andrewtavis]

@techsandu, checking in with you on this :) Let me know if you need any assistance 😊

[cameronslee]

Hi @andrewtavis, Could you assign this issue to me? This is my first contribution to an open source project and I have a pull request ready to submit. I'm still a little bit confused about the process of contributing so any guidance would be much appreciated!

[andrewtavis]

Happy to assign it given you have a PR, @cameronslee23 :) I'll check the contribution later on today and get back to you, but so far you're following the process very well! 😊

[andrewtavis]

PR was exactly what we're looking for in contributions, @cameronslee23 😊 Thanks for updating the changelog as well. The only thing I added was a period at the end of the entry in there 🙃 Hope to work with you more in the future! 🚀

[andrewtavis]

@cameronslee23, one thing to check is whether your email is set up correctly for GitHub. You're currently not listed in the contributors. This Stack Overflow question talks about it :) Would be great if you could fix that as you'd be our 10th contributor, which would actually allow me to apply to get Scribe onto a list of projects that are good for new developers (10 contributor minimum) 😊

[cameronslee]

@andrewtavis Thank you! I updated my email settings so hopefully I show up on the list soon! Hope to work with you in the future as well :)

[andrewtavis]

You should be in there in a few days, @cameronslee23 :) Sometimes takes a bit for this setting to update 😊

Thanks again!

[andrewtavis]

@cameronslee23, you're still not in the contributors, which is unexpected at this point 🤔 I do want you to get your due credit 😊

Besides this, just wanted to let you know that this feature unlocked another one in #256! 🥳 Might be an easy one for you to do if you had interest, but aside from that thanks again for the work here that allows us to add other cool things! 🚀

[cameronslee]

@andrewtavis Yeah I'm not sure why I'm not on the list, all of the settings check out correctly to my understanding. I just took a look at #256 and would be happy to work on it!

[andrewtavis]

Maybe it’s just gonna take a bit :) We’ll see 😊 Will check in with you on #256 over there! 🚀

[andrewtavis]

If the email that you use for GitHub is the same that you have for git config --global user.email "[email protected]" then we should be good :) Might be that the first commit can’t be applied to your account, so you’ll be in there after #256 :)