/plugins/default/sortable [ login | register | lost password ]

Main Menu

Hello from web2py

Attention: some of the plugins listed here are old (in particular jqgrid, comments, tagging, modal, dropdow, attachments, latex, flash video and deprecated). Newer versions have been incorporated into plugin_wiki. Here is a video about plugin_wiki. Make sure you watch it before you proceed. The OpenID, Facebook and RPX plugins are also obsolete since RPX, OpenID, Oauth 1.0 and 2.0 support is built into web2py. Check in the online manual.

web2py plugins are self contained pieces of an application that can be added to any existing application. They usually define components, i.e. objects that can be embedded in a page and talk to the server via ajax. Often they include corresponding jQuery plugins and the serverside funcitonality to make them work. Here you can find some examples. The web2py admin interface provides a web interface to upload and manage the plugins. The plugin themsselves are .w2p files (as for web2py apps). There are just tar gzipped files containing the source code. You do not need to unzip them. The admin interface will unzip them on upload in web2py. Once a plugin becomes part of your app, you can customize it without affecting other apps. Look and feel can be customized via CSS.

Demo Plugin Sortable List

Apple
Melon
Banana
Strawberry
Raspberry

Rearrange the items using the mouse: grab one and move it. Reload page and they stay sorted.

Example Source code (user code)

Model: db_custom.py

1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.

db.define_table('fruit',
    Field('sortable','integer',default=0,writable=False,readable=False),
    Field('client',default=request.client,writable=False,readable=False),
    Field('name',requires=IS_NOT_EMPTY()))

my_fruits = db.fruit.client==request.client

if not db(my_fruits).count():
    db.fruit.client.default=request.client
    db.fruit.insert(name='Apple')
    db.fruit.insert(name='Melon')
    db.fruit.insert(name='Banana')
    db.fruit.insert(name='Strawberry')
    db.fruit.insert(name='Raspberry')

db.define_table('preference',
                Field('name'),
                Field('fruit',db.fruit))
db.preference.fruit.requires=IS_IN_DB(db(db.fruit.client==request.client),'fruit.id','%(name)s')

Notes: the 'sortable' field is used to stored a sorting index; the client field is used to store the IP address of the client so that every user sorts his/her own fruits.

Controller: default.py

1.
2.
3.
4.
5.
6.

def index():
    fruits = db(my_fruits).select(orderby=db.fruit.sortable)
    return dict(fruits = fruits)

def sort():
    plugin_sortable_sort(db.fruit,query=my_fruits))

Notes: the 'sort' action is called by the plugin via ajax when sorting the items on the screen, query is used to filter the relevant rows.

View: default/index.html

1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.

{{extend 'layout.html'}}
<style>
.sortable LI {
   width: 200px; background: orange; color: white;
   border: 2px solid white; padding: 5px 5px 5px 5px;
    -moz-border-radius: 5px; -webkit-border-radius: 5px;
    z-index: 2;
}
</style>

<h1>Plugin sortable demo</h1>
{{=plugin_sortable([(f.id,f.name) for f in fruits],callback=URL(r=request,f='sort'))}}

Notes: all the work is doing by the last line. The function 'plugin_sortable' is defined by the plugin below. The first argument is a list of type [(id,value),...] containing the id of the items to be displayed and the text (or helper) showing the item. The 'callback' points to the action defined above.

Required plugin (including plugin source code)

You need this. Just upload it through the web2py plugin interface for your app. download

web2py Plugins