Autosuggest in Spry - Working with ColdFusion

A few days ago I blogged about how to do autosuggest in Spry. In that example, the autosuggest data was based on an XML file loaded as a Spry dataset. While this worked, it was pretty static. What would be more useful is if we could integrate with a database. There are a few options we can pass to the Spry Autosuggest feature to enable this. Our last example created the widget with this line:

<script type="text/javascript"> var theSuggest = new Spry.Widget.AutoSuggest("mySuggest","resultsDIV", "dsCharacters","name", {hoverSuggestClass:'highlight'}); </script>

The options (or in this case, option) at the end simply specified the CSS class to use when hovering over the list of suggested items. As I had mentioned, there are more options you can use.

For my next demo, I’m going to add the following options:

  • minCharsType: As you can guess, this is the minimum number of characters you need to type before the autosuggest feature fires.
  • containsString: Normally autosuggest will only match when the search string and the suggestion start with the same letters. If you set containsString to true, then the match can be anywhere.
  • loadFromServer: This is the important one for this demo. It tells Spry that for every attempt at an autosuggest, Spry should reload the dataset from the server. This is what will make our autosuggest more dynamic.
  • urlParam: When Spry talks to the server, it will create a URL variable with this name. </ul> So lets focus on the last two as they are them most critical. The first thing I will do is switch my dataset from a simple XML file to a ColdFusion file. <script> var dsCharacters = new Spry.Data.XMLDataSet("data.cfm","authors/author"); </script> I then update my autosuggest widget code to contain the new options I listed above: <script type="text/javascript"> var theSuggest = new Spry.Widget.AutoSuggest("mySuggest","resultsDIV", "dsCharacters","NAME", {hoverSuggestClass:'highlight',minCharsType:3,loadFromServer:true,urlParam:'search',containsString:true}); </script> Note that I used urlParam:'search'. Spry will add ?search=X to the URL, where X is the value in the text field. In case you are wondering - if my original URL already had a URL param in it, Spry is smart enough to add &search=X instead. (Nice!) So at this point - let me describe what happens. As you type in the box, when you get to 3 characters, Spry will fire off a HTTP request to get the data. When you change the text, Spry will fire off again. Pretty simple, eh? The ColdFusion behind this is nothing more than a simple SQL statement. For the demo, this is the code I used: <!--- Ensure we have both the value and at least 3 chars. ---> <cfif not structKeyExists(url, "search") or len(trim(url.search)) lte 2> <cfabort> </cfif> <cfquery name="getauthors" datasource="camden_blog" maxrows="250"> select distinct name from tblblogcomments where name like <cfqueryparam cfsqltype="cf_sql_varchar" value="%#url.search#%" maxlength="255"> </cfquery> <cfif not structKeyExists(application, "toxml")> <cfset application.toxml = createObject("component", "toxml")> </cfif> <cfset result = application.toxml.queryToXml(getauthors,"authors","author")> <cfcontent type="text/xml"><cfoutput>#result#</cfoutput> Note that I check for the existence of the the URL param, and I ensure it is 3 characters long. Why do I bother? Didn't I tell Spry to not fire unless there are 3 characters? Don't forget that your AJAX files need to be secure just like any other file. Someone could easily dig into my code and start trying to hack around with data.cfm. So to see this in action, go here: http://ray.camdenfamily.com/sprysuggest/index2.html Search for 'cam' to get some results. Or just try anything. The data is based on the names of people who post comments here so there should be a very wide variety. View source on the page to see the complete HTML/JS. And yes - it would work faster if I switched to JSON. (Although I'm not 100% sure if autosuggest works with JSON datasets. If it does not, it is a bug!)
Raymond Camden's Picture

About Raymond Camden

Raymond is a developer advocate. He focuses on JavaScript, serverless and enterprise cat demos. If you like this article, please consider visiting my Amazon Wishlist or donating via PayPal to show your support. You can even buy me a coffee!

Lafayette, LA https://www.raymondcamden.com

Comments