Locations

This key defines the different locations in Zoho Books where widgets can be positioned or rendered. You can have up to 10 widgets per location.

The locations where you can place your widgets in Zoho Books are:

• Pane
• Custom Button
• Line Item of a Transaction
• Dashboard
• Web Tab
• Settings Widget

Pane

These are the panes where you can place widgets in Zoho Books:

• Pane on the right side of any screen
• Pane on the right side of a transaction’s create or edit pages
• Pane on the right side of a module’s list page
• Pane on the right side of a module’s details page

Pane on the right side of any screen

Pane on the right side of a transaction’s create or edit pages

The modules that support the widget location are:

Pane on the right side of a module’s list page

The modules that support the widget location are:

Pane on the right side of a module’s details page

The modules that support the widget location are:

Custom Button

These are the locations where you can add widgets as custom buttons in Zoho Books:

• Custom button on a module’s list page
• Custom button on a module’s list page while performing bulk action
• Custom button on a module’s details page

Custom button on a module’s list page

The modules that support the widget location are:

Custom button on a module’s list page when performing bulk action

The modules that support the widget location are:

Custom button on a module’s details page

The modules that support the widget location are:

Line item of a Transaction

The modules that support the widget location are:

Dashboard

Web Tabs

The widget will be in the web tabs that you create.

Settings Widgets

Settings Widgets are widgets used for configurations when installing extensions, specifically regarding how extensions work and what data they use during the installation process. They act as UI wrappers for global fields, providing a user-friendly interface for configuring the global fields during the installation of extensions. In Zoho Books, settings widgets are used to capture input from users installing extensions, and these inputs are stored in global fields.

Create a Settings Widget

You can create a settings widget using Vue, React, Vanilla JS, or any framework of your choice. Read our help documents on the Salesperson extension using Vue, React, and Vanilla JS to learn how to create an extension.

Next, you need to pack and upload it into a global field.

Added below is the code snippet for settings widget:

 "modules": {
    "widgets": [
        {
            "location": "locations.globalfields",
            "name": "Finance Extension",
            "url": "/app/index.html",
            "logo": "/app/img/logo.png"
        }
    ]
}

Locations

Once you add the settings widget to your extension, you can find it when installing the extension and from the extension’s Details page after installation.

During Extension Installation

When you install your extension, you can view the settings widget on the Extension Installation page after you select the organization (or the connections authorization step if your extension uses connections).

Extension’s Details Page

After a Zoho Books user installs your extension, they can view the settings widget from the extension’s Details page. Here’s how:

• Go to Settings in the top right corner of the page.
• Click Marketplace under Integrations & Marketplace.
• Go to the Installed Extensions tab.
• Click View details on the extension’s cards.
• Click Configure in the top right corner of the page. The settings widget will be available on this page.

Was this document helpful?

Yes

No

Let us know where we can improve

Enter your comments or feedback on this page

Enter your email address

Refresh

Type the characters you see in the image above

By clicking Submit, you agree to our Privacy Policy .

Submit Cancel

Submit

Submit

Thank you for your feedback!

Want a feature?

Suggest