Tabs and Toolbars
Summary
- Most of the content in the AdapTable Dashboard is provided via Toolbars
- AdapTable ships with many Module Toolbars - which provide easy access to the functionality in that Module
- Additionally developers can supply their own Custom Toolbars
- Toolbars can either be grouped into Tabs or pinned above the Grid
The most commonly used element in the Dashboard is a series of Toolbars.
Toolbars contain small UI controls and can be of 2 types:
- Adaptable-provided Module Toolbars
- User-provided Custom Toolbars
Toolbars can be rendered in 2 ways:
- Grouped together inside Tabs
- Pinned above the Grid
Note
- These 2 forms are showing Toolbars are not mutually exclusive
- Tabs and Pinned Toolbars can be displayed simultaneously allowing for a fully flexible arrangement
Tabs
Toolbars are most typically grouped into named Tabs for ease of use.
This allows users to place multiple similar toolbars into one common place.
Hint
Users can click the Header name in each Tab to open or close it as required
- This demo illustrates 3 Dashboard Tabs:
Search- containingGrid Filter,Data SetandQuick SearchToolbarsEdit- containingSmart Edit,Bulk UpdateandData ChangesToolbarsNotifications- containingAlert, andSystem StatusToolbars
Click on a Tab to switch to a new set of Toolbars
Caution
Since Version 11, AdapTable no longer creates a default Tab if none is provided in Initial Adaptable State
Pinned Toolbars
Another option is to place Toolbars directly above the Grid - this is known as Pinned Toolbars.
Hint
- This is most typically used for the Grid Filter Toolbar which is often placed directly above the Grid
- In this way, it acts as a full Row filter to complement Column Filters
- This example contains 2 Pinned Toolbars -
Grid FilterandExport
Caution
- Pinned Toolbars do not contain the name of the Module
- They cannot be removed directly via a close button (but this can be done in the Dashboard Settings Panel)
Module Toolbars
Module Toolbars are essentially collections of controls which provide quick, easy access to a single Module (e.g. the Export Toolbar contains a dropdown showing all Reports together with add / edit / delete buttons).
Each Module Toolbar has these elements:
- UI Controls relevant to that Module
- Name of the Module
- A configure button which opens the Module's Page in the Settings Panel
- A close button which removes the Toolbar from the Tab (disabled if Dashboard Entitlement is
ReadOnly)
AdapTable currently provides these Module Toolbars:
- Alerts
- Bulk Update
- Cell Summary
- Change History
- Charts
- Data Set
- Export
- Column Filters
- Grid Filter
- Layout
- Quick Search
- Smart Edit
- State Management
- System Status
- Theme
Additionally these Module Toolbars are available if the appropriate plugin is loaded:
Custom Toolbars
Developers can supplement the Module Toolbars with their own Custom Toolbars.
These can contain either a set of AdapTable Buttons or full custom content.
Find Out More
See Custom Toolbars for full information on providing bespoke content in the Dashboard
Configuring Tabs and Toolbars
Developers can define which Tabs and Toolbars should be displayed in Initial Adaptable State.
This can include Custom Toolbars which are referenced in Initial State but defined in Dashboard Options.