Dashboard Buttons

View as Markdown

Summary

  • Dashboard Buttons provide shortcuts to regularly used functionality in AdapTable
  • There are 2 sets available:
    • Module Buttons - System buttons shipped by AdapTable which open the Module's Settings Panel section
    • Custom Buttons - provided by Developers which can perform any action when clicked

The AdapTable Dashboard can include buttons - shortcuts to particular actions.

Caution

  • These are not the same Buttons which are rendered inside Custom Toolbars
  • Instead, these are Buttons which are displayed in the top part of the Dashboard itself

Dashboard Buttons can be of 2 types:

  • (System) Module Buttons - provided by AdapTable
  • Custom Buttons - supplied by developers

Module Buttons

These are System Buttons supplied by AdapTable.

There is one Button (of type Adaptable Button) for each AdapTable Module.

Note

  • The Dashboard always shows a Home control that opens the Settings Panel — it is not a Module Button
  • By default no Module Buttons are displayed; add them in Dashboard State if you want shortcuts to specific Modules

When a Module Button is clicked, AdapTable opens that Module’s page in the Settings Panel.

Dashboard: Module Buttons
Fork
  • This example illustrates how to provide Module Buttons in the Dashboard
  • It sets 4 Module Buttons - FormatColumn, DataChangeHistory, CalculatedColumn and Shortcut

Expand to see how the Module Buttons are provided

Loading demo…

Custom Buttons

Custom Dashboard Buttons are standard Adaptable Buttons provided by Developers at design-time.

They are supplied in the customDashboardButtons property in Dashboard Options.

Custom Buttons to show in the Dashboard Header

Caution

  • Any Custom Button provided in Dashboard Options will be automatically displayed in the Dashboard
  • There is no requirement (or ability) to reference it in Dashboard Initial State - it appears anyway
  • Equally there is no ability for run-time users to hide a Custom Button (like they can with Module Buttons)
Deep Dive

Custom Dashboard Buttons

Custom Dashboard Buttons will perform bespoke actions when clicked.

Hint

  • Remember to provide an implementation for the Button's onClick property
  • Otherwise nothing will happen when the Button is clicked
Dashboard: Custom Buttons
Fork
  • This example illustrates how to provide Custom Buttons in the Dashboard. There are 2 Custom Buttons:
    • to show the time
    • to change the theme (this button changes based on whether the Dark or Light Theme is currently applied)

Expand to see how the Custom Buttons are provided

Loading demo…

Setting Buttons Location

By default the Dashboard will display all Module and Custom buttons on the right hand side.

The buttonsLocation property of Dashboard Options can be used to display them on the left.

buttonsLocation

Default: right
right | left
Where in Dashboard to display Module and Custom Buttons

FAQ

Is there a limit to the amount of Module buttons that I can show? No, you can choose to show as many as you want.

Why can't I remove the Settings Panel control from the Dashboard? The Dashboard Home control always opens the Settings Panel (unless that Module is Hidden). It is not a Module Button and is not listed in ModuleButtons.

Can I hide Custom Dashboard Buttons at run-time? No, you can only set the visibility (and order) of Module Buttons. Custom Buttons have a hidden property which can be provided by developers to manage button visibility