Module Tool Panels

Summary

Module ToolPanels are System ToolPanels provided by AdapTable
Each Module ToolPanel contains UI elements specific to that Module
For instance Layout has a Layout Selector and an Edit button
Both developers and end users can set the visiblity and order of the Module ToolPanels

AdapTable provides a Tool Panel for those Modules where items can be selected, switched, configured etc.

The full list of Module ToolPanels is:

Configuring Module ToolPanels

Developers can specify in Tool Panel Initial State which Module ToolPanels should be visible at start-up and whether they should display as open or closed.

Developer Guide

Configuring Module ToolPanels

// Show only the Alert, Layout and SmartEdit ToolPanels
const initialState: InitialState = {
  ToolPanel: {
    ToolPanels: [
      {
        Name: 'Alert',
      },
      {
        Name: 'Layout',
      },
      {
        Name: 'SmartEdit',
      },
    ],
  },
};

1

Set Module ToolPanel Visibility

By default all Module ToolPanels (to which the user is entitled) are visible at start-up and will display in alphabetical order.

This can be overridden by providing in the ToolPanels property a separate list of ToolPanels which should be displayed instead.

Hint

Module ToolPanels not listed here but to which the user is entitled can later be made visible at run-time

const initialState: InitialState = {
  ToolPanel: {
    ToolPanels: [
      {
        // Will be collapsed (as is the default)
        Name: 'Alert',
      },
      {
        Name: 'Layout',
        // Set it to be expanded at startup
        VisibilityMode: 'expanded',
      },
      {
        Name: 'SmartEdit',
        // Ensure it is collapsed
        VisibilityMode: 'collapsed',
      },
    ],
  },
};

2

Set ToolPanels to be Expanded

All Module ToolPanels show as collapsed at application startup.

This means you can see the ToolPanel header but you need to click on the little arrow to view the full contents.

This can be changed by setting the VisibilityMode to be expanded for those ToolPanels which should display as open.

Caution

This is stored in Adaptable State so any run-time changes will be automatically persisted.

Module ToolPanels

Fork Fork

This example limits the number of Module Tools Panels to 5:
- Alert, Theme - which are set as closed
- CellSummary, Export and Layout - which are set as expanded

PreviousTool Panel NextCustom Tool Panels