Autocomplete Widget for YAFOWIL
Project description
This is a autocomplete widget for for YAFOWIL - Yet Another Form WIdget Library.
It utilizes/integrates jquery.ui.autocomplete for/in YAFOWIL providing an autocomplete function on a text input.
Usage
The autocomplete widget takes the properties:
- minLength
Minimum length of string before complete starts, default=1.
- delay
Delay after last key-down before complete starts in milliseconds, default=300.
- source
Data to be uses for autocomplete. Either a list of strings, a url (string) to be used to get a JSON response from or a JavaScript callback function. JSON response is expected to be either a list of strings or a list of dicts with keys id and label. id is used for the complete and as value while label is shown in the dropdown. If JavaScript callback desired, prefix source property with javascript:, it will be resolved to callback function.
Examples:
form['mycomplete'] = factory('autocomplete', props={ 'value': '', 'source': ['foo', 'bar', 'baz'], 'minLength': 3, 'delay': 500}) form['mycomplete'] = factory('autocomplete', props={ 'value': '', 'source': 'http://example.com/source_url', 'minLength': 3, 'delay': 500}) form['mycomplete'] = factory('autocomplete', props={ 'value': '', 'source': 'javascript:myfancyjs.callback', 'minLength': 3, 'delay': 500})
Example Application
To run the example application and tests coming with this package run bootstrap (Python 2.6 or 2.7) with a buildout like so:
[buildout] parts = gunicorn [tests] recipe = zc.recipe.testrunner eggs = yafowil.widget.autocomplete[test] [gunicorn] recipe = zc.recipe.egg:scripts eggs = ${test:eggs} gunicorn
Start the application with:
./bin/gunicorn yafowil.widget.autocomplete.example:app
and connect with your webbrowser to http://localhost:8000/
Run the tests with:
./bin/tests
Source Code
The sources are in a GIT DVCS with its main branches at github.
We’d be happy to see many forks and pull-requests to make YAFOWIL even better.
Contributors
Jens Klein <jens@bluedynamics.com>
History
1.3
Support JavaScript callback functions in source attribute [rnix, 2011-10-03]
register autocomplete binder in yafowil.widget.array hooks if installed [rnix, 2011-10-03]
register plan and depend on yafowil 1.3 [jensens, 2011-09-30]
1.2
adopt to yafowil 1.2 [jensens, 2011-09-20]
resource available in plain Zope2 [jensens, 2011-09-20]
1.1
adopt to yafowil 1.1 [rnix, 2011-07-08]
1.0.1
test coverage [rnix, 2011-05-07]
1.0
made it work [jensens, 2010-11-24]
License
Copyright (c) 2010-2011, BlueDynamics Alliance, Austria, Germany, Switzerland All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of the BlueDynamics Alliance nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY BlueDynamics Alliance AS IS AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BlueDynamics Alliance BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for yafowil.widget.autocomplete-1.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 34a25454f081f5407dbf2c94b92ac0895a1b89d4261e28902e04f8e787fb5b3b |
|
MD5 | eeac65ef470afaaeff3a5f91c9a8b807 |
|
BLAKE2b-256 | 48253ff598af0ddf6abe37fb07a45ad9f67c14694d78cb00cd4912939b5e4ada |