Grok-like configuration for zope viewlets
Project description
This package provides support to write and register Zope Viewlets directly in Python (without ZCML). It’s designed to be used with grokcore.view which let you write and register Zope Views.
Setting up grokcore.viewlet
This package is set up like the grokcore.component package. Please refer to its documentation for more details. The additional ZCML lines you will need are:
<include package="grokcore.viewlet" file="meta.zcml" /> <include package="grokcore.viewlet" />
Put the first line somewhere near the top of your root ZCML file.
Examples
First we need a view to call our viewlet manager:
from grokcore import viewlet
class Index(viewlet.View):
pass
index = viewlet.Page Template("""
<body>
<head>Test</head>
<body>
<div tail:content="structure provider:content">
</div>
</body>
""")
After that we could define only a manager which display something:
class Content(viewlet.ViewletManager):
viewlet.View(Index)
def render(self):
return u'<h1>Hello World</h1>'
Or a completely different example:
class AdvancedContent(viewlet.ViewletManager):
viewlet.name('content')
viewlet.view(Index)
And some viewlets for that one:
class StaticData(viewlet.Viewlet):
viewlet.view(Index)
viewlet.viewletmanager(AdvancedContent)
def render(self):
return u'<p> Data from %s</p>' self.context.id
Or:
class SecretData(viewlet.Viewlet):
viewlet.view(Index)
viewlet.viewletmanager(AdvancedContent)
viewlet.require('agent.secret')
secretdata = viewlet.PageTemplate("""
<p>Nothing to see here.</p>
""")
The way templates are binded to components works exactly the way than in grokcore.view, for more information refer to its documentation.
API Overview
Base classes
- ViewletManager
Define a new viewlet manager. You can either provide a render method, a template, which can or not use registered viewlets.
If you define a template, view is added as a reference to the current view for which the manager is rendering in the template’s namespace. It is available as well as an attribute on the manager object.
- Viewlet
Define a new viewlet. You can either provide a template or a render method on it. Like in views, you can define an update method to process needed data.
Like for manager, view is added to the template namespace if used. viewletmanager is defined as well as a reference to the manager in the template’s namespace and as an attribute on the viewlet object.
Directives
You can use directives from grokcore.view to register your viewlet or viewlet manager: name, context, layer and require (for security on a viewlet).
To that is added:
- view
Select for which view is registered a viewlet or a viewlet manager.
- viewletmanager
Select for which viewlet manager is registered a viewlet.
- order
Define a rendering order for viewlets in a viewlet manager. This should be a number, the smaller order render first, bigger last.
Additionally, the grokcore.viewlet package exposes the grokcore.component, grokcore.security and grokcore.view APIs.
Changes
1.1 (2009-07-20)
Adapted tests to new grokcore.view release: switched from View to CodeView.
Add grok.View permissions to functional tests (requires grokcore.security 1.1)
1.0 (2008-11-15)
Created grokcore.viewlet in November 2008 by factoring zope.viewlet-based components, grokkers and directives out of Grok.
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
File details
Details for the file grokcore.viewlet-1.1.tar.gz.
File metadata
- Download URL: grokcore.viewlet-1.1.tar.gz
- Upload date:
- Size: 22.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 042e6e77c0ed3c31eafe756cb1775da2226fbcd487a126c5625ed21f9fc5ed5f |
|
| MD5 | e6bbe2f839b7c8fae876002db824815b |
|
| BLAKE2b-256 | 172da92b8be7fc43394b5353dda7cc64a444e239b7cda17bdd80a3248e013abf |
