ZCS 6.0:Zimlet Developers Guide:Examples:Menu Items JS

The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

ZCS 6.0: Zimlet Developer Guide:Examples:Menu Items JS

   KB 3218        Last updated on 2020-11-3  

(0 votes)
Zdg-6-menu-icon-zimbra.jpg Introduction Zdg-6-menu-icon-green-flag.png Getting Started Zdg-6-menu-icon-terminal.png Dev Environment Setup Zdg-6-menu-icon-gear.png Developing Zimlets Zdg-6-menu-icon-advanced.jpg Advanced Concepts Zdg-6-menu-icon-library.jpg API Specifications Zdg-6-menu-icon-checkbox.jpg Example Zimlets


This zimlet will match the words lab, user or remodel and display a tool tip. On mouse right-click, a menu is presented. Each menu item will launch a website.

The Zimlet ZIP Package contains the Zimlet Definition File and a JavaScript file. The two menu items are defined using <menuItem>. The a zimlet menuitems.js JavaScript file is included with <include>menuitems.js</include>. The zimlet Handler Object is defined with <handlerObject>com_zimbra_menuitemsjsHandlerObject</handlerObject>.

When a menu item is selected, the zimlet Handler Object menuItemSelected(itemId) method is called and passes the menu item id, as specified in the definition file (either "SOME_MENU_ITEM_ID1" or "SOME_MENU_ITEM_ID2").

Screen Shot


Definition File

<zimlet name="com_zimbra_example_menuitemsjs" version="1.0" description="Demos menu item with actions in JS">
	<regex attrs="ig">lab|user|remodel</regex> <!-- matches lab or user or remodel -->
	<toolTip>Menu Items Example</toolTip> <!-- the tool tip to display when content matches -->
	  <menuItem label="First Context Menu Item - Go to Yahoo!" icon="Search" id="SOME_MENU_ITEM_ID1" />
	  <menuItem label="Second Context Menu Item - Go to Yahoo! Sports" icon="NewContact" id="SOME_MENU_ITEM_ID2" />

JS File

 * This method gets called by the Zimlet framework when a context menu item is selected.
 * @param	itemId		the Id of selected menu item
com_zimbra_example_menuitemsjs_HandlerObject.prototype.menuItemSelected =
function(itemId) {
	switch (itemId) {
		window.open ("http://www.yahoo.com",
		window.open ("http://sports.yahoo.com",
		// do nothing



Zimlet Package com_zimbra_example_menuitemsjs.zip

Verified Against: Zimbra Collaboration Server 7.0 Date Created: 12/22/2009
Article ID: https://wiki.zimbra.com/index.php?title=ZCS_6.0:Zimlet_Developers_Guide:Examples:Menu_Items_JS Date Modified: 2020-11-03

Try Zimbra

Try Zimbra Collaboration with a 60-day free trial.
Get it now »

Want to get involved?

You can contribute in the Community, Wiki, Code, or development of Zimlets.
Find out more. »

Looking for a Video?

Visit our YouTube channel to get the latest webinars, technology news, product overviews, and so much more.
Go to the YouTube channel »

Jump to: navigation, search