Skip to main content

Toolbar for Plone

Project description installs a new toolbar for Plone.

For the moment, it is an experiment only, but hopefully it will be soon ready for prime time.


To install toolbar drop following lines to your buildout.cfg:

eggs =

[versions] = 1.7.2 = 1.4
plone.tiles = 1.0b2
Products.ResourceRegistries = 2.1.1 = 1.0

In case this document gets outdated use latest versions of eggs in versions section.

Make sure you install the “Plone Toolbar” profile when creating your Plone site or include profile in your metadata.xml..

To start developing you can find buildout at buildout.deco repository.:

How it works

Registers toolbar tile which creates toolbar html on every page in twitter bootstrap structure and is hidden by default. Toolbar tile also lists resources from toolbar skin in data-iframe-resources attribute of top element.

<div style="display: none;"
  <div class="navbar">

Elements with data-iframe attribute are picked by iframed.js and inserts resources found in data-iframe-resources attribute. iframed.js script also takes care that dropdown in toolbar which goes outside iframe area stretches it in transparent way so that user doesn’t even notice it.

Same transparent stretching of iframe is used when overlay is opened. This is done by plone.overlay.js script. Example of how to open overlay when user click on Edit action in toolbar would be:

$('#plone-toolbar ul.nav > li#plone-action-edit > a').ploneOverlay({
  after_load: function(overlay) {
    $.plone.cmsui.bootstrapOverlayTransform(overlay.el, overlay.loaded_data);

More examples of this can be found in plone.cmsui.js script.

Since in current Plone we’re not using to render tiles we provide plone toolbar viewlet which renders toolbar tile. This is done by bbb code that also makes sure that is nicely integrated into current Plone, eg: hidding old green edit bar, …

Diazo rules

First we need to copy toolbar’s html code, which will be picked by iframed.js:

<append theme="/html/body"
    content="//div[@data-iframe='toolbar']" />

Then in case we are not copying all resources from Plone to theme we have to include iframed.js:

<append theme="/html/head">
    <script type="text/javascript"

Above 2 rules should be enought so that your theme will support

More on plone.overlay.js

TODO: once jquery.form.js is integrated into $.plone.Overlay write documentation for it.

More on plone.cmsui.js

TODO: once it gets fairly working some documentation would be nice.

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, version 1.0
Filename, size File type Python version Upload date Hashes
Filename, size (1.1 MB) 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