AutoCompletePlugin

This plugin allows you to create an autocomplete input field based on Yahoo's User Interface Library.

All this plugin does is implement Arthur Clemens' TWiki:Plugins/AutoCompleteAddOn as a plugin, which allows users to provide an autocomplete text box using the %AUTOCOMPLETE% syntax, and also in TWikiForms (shown below).

screenshot.png

Usage

Before you can use this plugin, you need to set up some data for the autocomplete. Examples can be found at AutoCompletePluginTestData.

In Topics and Templates

This plugin expands the %AUTOCOMPLETE{...}% variable, which takes the parameters described in AutoCompletePlugin#Parameters.

In TWikiForms

To use this plugin in TWikiForms, create a form template as descibed in TWikiForms#Defining_a_Form. This plugin adds the autocomplete type of field. To pass the parameters required by the plugin, place them in the Values column. An example is shown below:

Name Type Size Values Tooltip message Attributes
Username autocomplete 25em datatopic="Sandbox.AutoCompletePluginTestData" datasection="usernames" delimchar="," itemformat="item[0] + ' (' + item[1] + ')'"    

You can use many of same attributes as you would in topics, except the following:

  • name
  • size
  • value
  • class
  • formname

Parameters

Parameter Comment Default Example
name A unique name for the textfield required name="users"
datatopic The topic with data. Should be formatted as comma-separated string, or as an array of arrays (see AutoCompletePluginTestData#usernames for an example). Use with datasection. required datatopic="Sandbox.AutoCompletePluginTestData"
datasection The topic section with data. Use with datatopic. required datasection="usernames"
size The width of the input field in em or px. 20em size="20em" or size="200px"
value Default value of the input field none value="AutoCompletePlugin"
tabindex The tabindex of the textfield none tabindex="2"
class Name of css class to add to the input field none class="twikiInputField"
formname Name of the form which the input field is part of none form="userlist"
itemformat The format of an item string in the autocomplete list. Use if the autocomplete list should display different names than the input field - for instance with full person names. The javascript input argument is item. item itemformat="item[0] + ' (' + item[1] + ')'"
delimchar Used to accept multiple delimeted queries. none delimchar=","
onblur, onfocus, onchange, onselect, onmouseover, onmouseout Javascript parameters for the textfield. none onfocus="twiki.Form.clearBeforeFocusText(this);"
itemselecthandler Defines a javascript function to be executed when an item is selected. See http://developer.yahoo.com/yui/autocomplete/#customevents. none itemselecthandler="submitJumpForm"

Example

If installed, the following should create an jump box (TWiki 4.1):

Source:

<script type="text/javascript">
var SubmitJump = function(sType, aArgs) {
    document.myJumpForm.submit();
}
</script>
<form name="myJumpForm" action="%SCRIPTURLPATH{"view"}%/%BASEWEB%/%BASETOPIC%">%AUTOCOMPLETE{ name="topic" datatopic="Sandbox.AutoCompletePluginTestData"  datasection="topiclist" value="Jump" formname="myJumpForm" class="twikiInputField patternFormFieldDefaultColor" onfocus="clearDefaultandCSS(this);" onblur="setDefaultText(this);" itemselecthandler="SubmitJump" size="128px" }%</form>

Rendered:

%AUTOCOMPLETE{ name="topic" datatopic="Sandbox.AutoCompletePluginTestData" datasection="topiclist" value="Jump" formname="myJumpForm" class="twikiInputField patternFormFieldDefaultColor" onfocus="clearDefaultandCSS(this);" onblur="setDefaultText(this);" itemselecthandler="SubmitJump" size="128px" }%

Installation Instructions

%$INSTALL_INSTRUCTIONS%

Plugin Files

File: Description:
%$MANIFEST%

Plugin Info

Plugin Author(s): TWiki:Main.AndrewRJones
Copyright: © 2007, TWiki:Main.AndrewRJones
License: GPL (Gnu General Public License)
Plugin Version: %$VERSION%
Change History:  
14585 Bugs:Item4469 - Removed extra self-closing div-tag tail; Fixed Jump Form example
14413 Bugs:Item4369 - Allow users to define their own item select handler
14391 Bugs:Item4356 - Class names not being added
14382 Bugs:Item4346 - Added Javascript parameters (onblur, onfocus, etc)
14381 Bugs:Item4345 - Was adding 'null' after input if delimchar not set
14379 Bugs:Item4342 - Only sets correct size for one texfield in topic
14290 Bugs:Item4304 - Various bug fixes and enhancements
14277 Bugs:Item4301 - Initial release
Dependencies: %$DEPENDENCIES%
Benchmarks: GoodStyle nn%, FormattedSearch nn%, AutoCompletePlugin nn%
Plugin Home: http://twiki.org/cgi-bin/view/Plugins/AutoCompletePlugin
Feedback: http://twiki.org/cgi-bin/view/Plugins/AutoCompletePluginDev
Appraisal: http://twiki.org/cgi-bin/view/Plugins/AutoCompletePluginAppraisal

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences

Topic revision: r1 - 02 Apr 2008 - 01:14:12 - TWikiGuest
 
This site is powered by the TWiki collaboration platformCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.AutoCompletePlugin