PanelCollapser

Instances of this class are used to implement the collapsible config.

For example, the following creates an instance of this class:

     {
         type        : 'panel',
         collapsible : true
     }

In this mode, a panel will collapse inline, within its container.

Configs

5
animation: Object

An animation config object.

ParameterTypeDescription
animation.durationNumber

The duration of the animation (in milliseconds).

collapseTooltip: String

The tooltip to use for the collapse tool when the panel is expanded.

direction: up | down | left | right

Specifies the direction of panel collapse. The default value for this config is determined dynamically based on the header's dock property and the containing layout's flex direction and, therefore, often does not need to be explicitly specified.

This config can be any of the following:

  • 'up'
  • 'down'
  • 'left'
  • 'right'

The default direction property is inferred from the position of the Panel in a flexbox layout.

If the Panel is the last child of a flexbox container, the direction is 'right' for a horizontal flexbox layout and 'down' for a vertical layout.

All other Panels in a flexbox container have the direction set to 'left' for a horizontal layout and 'up' for a vertical layout.

expandTooltip: String

The tooltip to use for the expand tool when the panel is collapsed.

tool: ToolConfig | Tool | null

The collapse/expand tool. The type of this instance should not be changed but the tool instance can be configured in other ways via this config property.