-
Notifications
You must be signed in to change notification settings - Fork 5
Zimlet Context
David Bingham edited this page Jul 19, 2018
·
4 revisions
The Zimlet context is an object passed into every Zimlet when they are created. Context allows the Zimlet to interact with the main application by registering plugins and adding actions to the redux store. It allows the main application to pass data into a Zimlet, such as useful components.
export default function ExampleZimlet(context) {
const {
components, // re-usable components from the main application
plugins, // interact with hooks in the main application, such as Zimlet Slots
zimbraOrigin, // the origin of the Zimbra server the client is targetting
zimlets, // the Zimlet Manager instance
zimbra, // the Zimbra API Client (old/deprecated)
zimletRedux, // Hooks for interacting with the Redux store. see [zimlet-redux.md]
getAccount, // retrieve account data
config, // the config passed into the Zimbra application
resourceUrl,
cache,
h, // preact dependencies are injected for convenience
createElement,
Component,
cloneElement,
route, // route from preact-router will let the Zimlet route the main app
Link,
components, // re-usable components from the main app
styles,
keyBindings, // key bindings in the main app
shortcutCommandHandler // key binding handlers in the main app
} = context;
}
Use the preact-context-provider
to pass these values down through your Zimlet.
- components: Re-Using Components
- Home
- Client Tool
- Getting Started
- Creating Your Zimlet
- Zimlet Design Patterns
- Advanced