Skip to main content

TurboGears extension providing enhanced flash message display functions.

Project description

This package provides an enhanced version of the turbogears.flash() function, giving your users much nicer-looking message boxes that can change their appearance based on the status of the message. With JavaScript enabled, messages can fade out after a timeout or be dismissed by the user with a mouse-click.

This is accomplished by encoding the message with JSON and decoding it again in the template of the target page. This is handled completely automatic and the programmer can just use the functional interface, e.g. fancyflash.error("Duh!").

Additionally, you can display messages with a simple JavaScript function call, for example when processing the results of an AJAX call in your callback function for loadJSONDoc.

For more information see the source of the fancyflash package, the epydoc-generated API documentation and the FancyFlashExample application.

Installation

To install TurboFancyFlash from the Cheeseshop use easy_install:

[sudo] easy_install TurboFancyFlash

This requires the setuptools package to be installed. If you have not done so already, download the ez_setup.py script and run it to install setuptools.

Usage

Controller (controllers.py):

# Import TurboGears
from turbogears import controllers, expose, redirect, validate, validators

# Import fancyflash package
import fancyflash as ff

# Set the default timeout for message box display
ff.set_default_flash_timeout(5)

# Let FancyFlashWidget be included on every page
ff.register_flash_widget()

class FlashTestController(controllers.Controller):

    @expose('templates.welcome')
    def index(self, timeout=0):
        return {}

    @expose()
    def info(self):
        ff.info("Hello TurboGears!")
        redirect('/')

    @expose()
    @validate(validators=dict(timeout=validators.Int))
    def success(self, timeout=0, tg_errors=None):
        ff.success("Hello TurboGears!", timeout)
        redirect('/')

    @expose()
    @validate(validators=dict(status=validators.String))
    def message(self, status="info", tg_errors=None):
        ff.statusmessage("Hello TurboGears!", status)
        redirect('/')

Master template (master.kid):

<div id="main_content">
  <div py:replace="tg_fancyflashwidget(tg_flash)">Status message
    appears here</div>

  <div py:replace="[item.text]+item[:]"/>

  ...
</div>

Acknowledgments

The idea for this widget is based on a blog post by Lee McFadden:

Todo

  • Test in IE
  • Test opacity in Safari

If I have time:

  • Add argument for dialog position (implement by writing CSS dynamically).
  • Round boxes for non-Gecko browsers
  • Add AJAX widget, which displays result of loadJSONDoc as fancy status message.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for TurboFancyFlash, version 0.1a
Filename, size File type Python version Upload date Hashes
Filename, size TurboFancyFlash-0.1a-py2.5.egg (94.0 kB) File type Egg Python version 2.5 Upload date Hashes View
Filename, size TurboFancyFlash-0.1a.tar.bz2 (107.9 kB) File type Source Python version None Upload date Hashes View
Filename, size TurboFancyFlash-0.1a.zip (164.2 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page