Widgets

Home / Support / Documentation
From WHMCS Documentation
Jump to: navigation, search

Widgets are a feature of WHMCS Version 5.0 & later that are the building blocks of the admin homepage. They are open-source, movable blocks, which can be granted access to on a per admin role basis, and moved into any display order/combination as desired, allowing administrators to customise exactly what each staff group get to see, and staff to tailor their dashboard to their exact needs.

Looking for a way to get product/domain info & pricing on your site? The functionality for doing that previously referred to as widgets has now been renamed to Data Feeds

Default Widgets

WHMCS currently includes the following widgets as standard. But widgets can easily be created by hook and addon module developers and so it's more than likely you will have many more available to you in your installation than this:

  • Activity Log - Recent activity overview to keep you up to date with what's happening
  • Getting Started with WHMCS - Quick getting started tips for new users
  • Income Forecast - A quick income forecast of estimated income should all active products renew in a 12 month period
  • Income Overview - A graphical summary of daily income compared for the past 2 weeks
  • My Notes - Access to your personal admin notes at a glance
  • Network Status - Listing your servers and allowing you to check the status (if status url monitoring has been implemented)
  • Open Invoices - A quick view of unpaid invoices, showing your latest 5
  • Orders Overview - A graphical summary of active orders per month for the current year
  • Recent Admin Activity - A brief overview of the last 5 logins by staff, date/time & IP address
  • Recent Client Activity - A brief overview of the last 5 client logins, including dates/times & IP addresses
  • System Overview - A quick statistical overview including orders, services, and tickets
  • To-Do List - Instant access to your WHMCS To-Do list to review and manage
  • WHMCS News Feed - All the latest news & updates from WHMCS straight to your WHMCS dashboard

Managing Widgets

Each member of staff can have their own personalised admin homepage layout. The widgets are arranged in 2 columns, of unlimited depth.

To move a widget, simply click and drag the title bar where the widget name is displayed to the desired location and then release it. Before you let go of the mouse, a dotted outline will appear where the widget will be moved to allowing you to confirm it's as you want.

Widgets can also be minimised or maximised, so that even if a widget is enabled for a particular role group, if an admin doesn't want or need to see it, then they can simply minimise it and move it to the bottom of the screen out of the way.

To do this simply click the "-" icon located to the far right of the title bar for a widget. When minimised where the "-" icon was before, it will now display a "+" icon allowing for thw widget to be opened again if needed.

Granting/Restricting Access to Widgets

Access to Widgets is defined on a per admin role group basis. So for example all your Sales staff might have access to the System & Orders Overview widgets, while your Support staff might not require those things.

To get started, begin by navigating to Setup > Administrator Roles and then click the edit icon next to the admin role group you want to change.

Once on the permissions page, simply scroll down to the section labelled Widgets and from there you'll be able to enable/disable the Widgets accessible to that group by checking or unchecking the boxes.

Accessing Newly Installed Widgets

When a new widget is first installed into the system, the first thing you will always need to do before you can see & use it is navigate to your admin role group setup area as described above and enable it. Once enabled, you can then navigate back to your homepage and the new widget will appear as the top widget on your dashboard which you can move around and adjust as desired.

Creating/Editing Widgets

All the widgets included in WHMCS by default are open source and fully customisable. You can find & edit the files that control them in the /modules/widgets/ folder.

Or if you are a developer and want to create a widget to extend your existing Server/Provisioning/Registrars/Addon Module, or if you are a user who simply wants to create a custom widget for your own purposes, visit the Creating a Widget page to find out how.