Widgets

A widget is how your extension is accessible in your Zoho Sprints application. Widgets are small independent components that serve the purpose of meeting specific requirements in the application.

Type=JSONArray

A widget holds multiple objects based on the locations count. Every object has four keys - 'location', 'name', 'icon', and 'URL'.

Zoho Sprints supports extensions in eight locations.

List of widget locations in Zoho Sprints

An extension's widget can be rendered in multiple locations inside the product. This key (location) defines where the widgets should be rendered. Zoho Sprints provides a list of widget locations. The key for the location should be specified in the plugin-manifest file. The following are the locations:

• Sprint right navigation bar
• Item details
• Meeting right navigation bar
• Release right navigation bar
• Extension setup configuration page
• Global view
• Projects left menu
• Global CICD menu

Sprint right navigation bar

The widget will be accessible in the Sprints details page right navigation bar.

The widgets will also show under Add-Ons category in sprint board page. An ellipsis icon [...] will be shown in the Add-Ons. Clicking the ellipsis to view all the extension. 

The quick filters will also include the custom fields added in the extension. You can choose them as criteria for filtering.

Snippet

{
	"modules": {
		"widgets": [{
			"icon": "/app/logo.svg",
			"name": "Sprints Extension",
			"location": "sprint.top_nav_bar",
			"url": "/app/sprints-app.html"
			}]
		}
}

Item right navigation bar

This location refers to the last tab in the right panel of a item details page. Click the required item and navigate to the item details page. The widget will be available on the right navigation bar.

The quick filters will also include the custom fields added in the extension. You can choose them as criteria for filtering.

Snippet

{
	"modules": {
		"widgets": [{
			"icon": "/app/logo.svg",
			"name": "Sprints Extension",
			"location": "item.right_nav_bar",,
			"url": "/app/sprints-app.html"
			}]
		}
}

Meeting Right Navigation Bar

This location refers to the last tab in the right panel of a meeting details page. Click the required meeting and navigate to its details page. The widget will be available on the right navigation bar.

Snippet

{
	"modules": {
		"widgets": [{
			"icon": "/app/logo.svg",
			"name": "Sprints Extension",
			"location": "meeting.right_nav_bar",
			"url": "/app/sprints-app.html"
			}]
		}
}

Release right navigation bar

Similar to the Item and meeting details pages discussed above, this location refers to the last tab in the right panel of a release details page. Click the release and navigate to its details page. The widget will be available on the right navigation bar.

The quick filters will also include the custom fields added in the extension. You can choose them as criteria for filtering.

Snippet

{
	"modules": {
		"widgets": [{
			"icon": "/app/logo.svg",
			"name": "Sprints Extension",
			"location": "release.right_nav_bar"
			"url": "/app/sprints-app.html"
			}]
		}
}

Extension setup configuration page

This location refers to the last tab in the extension's Settings page in the top navigation bar. Go to Settings -> Marketplace-> All-> Installed Extensions. Select the required extension and the widget will load in the last tab of the top navigation bar.

Snippet

{
	"modules": {
		"widgets": [{
			"icon": "/app/logo.svg",
			"name": "Sprints Extension",
			"location": "extension.setup",
			"url": "/app/sprints-app.html"
			}]
		}
}

Global view

This location refers to the tab in the right navigation panel of the product. Login to Zoho Sprints. You can find this widget from any page in the product except from popup.

Snippet

{
	"modules": {
		"widgets": [{
			"icon": "/app/logo.svg",
			"name": "Sprints Extension",
			"location": "global_view",
			"url": "/app/sprints-app.html"
			}]
		}
}

Projects left menu

This location refers to the widget tab in the navigate panel that has the various modules of a project. Login to Zoho Sprints project and access the widgets.

Snippet

{
	"modules": {
		"widgets": [{
			"icon": "/app/logo.svg",
			"name": "Sprints Extension",
			"location": "project.left_menu",
			"url": "/app/sprints-app.html"
			}]
		}
}

Global CICD Menu

This location refers to the Global CICD tab in the left Panel. Find widgets as an array of navigation bars under the CICD view.

Snippet

{
	"modules": {
		"widgets": [{
			"icon": "/app/logo.svg",
			"name": "Sprints Extension",
			"location": "global.cicd_menu",
			"url": "/app/sprints-app.html"
			}]
		}
}