Documentation Needed for Proper Configuration of things like Spaces in search

Created on 28 February 2024, 9 months ago

Almost opened this as a bug, as we couldn't use a "blank space" in the autocomplete search between words which was causing us some issues.

Turns out setting the "Limit characters" option to "Letters" in the field widget (probably same if set to "Numbers" or "Letters & Numbers") using a space between words (like exists in some of the term names that get returned when choice looks/searches for matches) just won't work.

As it appears you need to add a blank space in the "Allowed characters" option field for the widget to allow spaces in the search of terms which we absolutely needed because if a matching term (which could be multiple words) doesn't exist it needs to be automatically created.

I assumed setting Limit characters to letters would be like typical word searching (allowing for multiple words), my fault for making an assumption. However with the lack of documentation explaining things I initially thought something was broken yet no errors were produced.

I think some documentation explaining the situation is ideal. Especially when using a feature like limit characters (as there will never or should never be a number included for our use case on this...) thus why we set the limit characters to letters initially (figuring words only) - but that was just part of getting it to work right. If for our use it was just start typing till the term you need is available the space wouldn't be an issue - however for us if a term doesn't exist the vocabulary we setup is configured to allow new terms created if they don't already exist (and in some cases may be a multi-worded term).

I haven't tested leaving "Limit characters" to the default of "- Any -", tho I imagine that would have allowed spaces and or special characters by default, and likely why this hasn't come up before as an issue.

Having just that little extra knowledge would have probably saved me a half a day trying to figure out why things weren't working as expected.

As there doesn't appear to be a readme for advance help with this module, maybe including something along the lines of extra info/directions for the "Limit characters" option right in the widget settings saying something like:
If you change "Limit characters" to something other that "- Any -" for example "Letters" you will need to include any special characters if needed or "including a blank space" in the "Allowed characters" input field if you want to be able to search or match to multiple words using choice autocomplete.

Other than that, this module saved me a huge headache dealing with a custom theme were the default autocomplete widget option wouldn't allow the returned suggestions to be selected. - So Thank you, thank you, thank you for that...

πŸ“Œ Task
Status

Active

Version

1.3

Component

Code

Created by

πŸ‡ΊπŸ‡ΈUnited States sidgrafix

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Production build 0.71.5 2024