ComponentGrid Class Reference

Animated grid container with drag-and-drop reordering support. More...

#include <gin_componentgrid.h>

Inherits juce::Component, and juce::Timer.

Classes
struct	DragInfo

Public Types
enum	Orientation { vertical , horizontal }

Public Member Functions
	ComponentGrid (const juce::String &name={}, Orientation o=horizontal)
	~ComponentGrid () override
void	timerCallback () override
void	mouseDown (const juce::MouseEvent &e) override
void	mouseDrag (const juce::MouseEvent &e) override
void	mouseUp (const juce::MouseEvent &e) override
void	resized () override
bool	isDragInProgress ()
void	setGap (int)
void	setOrientation (Orientation)

Static Public Member Functions
static bool	isGridDrag (juce::var)
static int	getDragIndex (juce::var)

Public Attributes
std::function< bool(const juce::MouseEvent &)>	onDragStart
std::function< void(int, int)>	onOrderChanged
std::function< void(int, int)>	onDragFinished

Protected Member Functions
void	layoutAnimated ()
int	componentIndex (juce::Component &c)
juce::Array< juce::Rectangle< int > >	getComponentRects ()

Protected Attributes
bool	dragStarted = false
bool	dragging = false
bool	dragOut = false
Orientation	orientation = horizontal
int	gap = 1
juce::Array< juce::Component * >	originalOrder
juce::ComponentAnimator	animator

Detailed Description

Animated grid container with drag-and-drop reordering support.

ComponentGrid arranges child components in a row or column with smooth animated transitions. Components can be reordered via drag-and-drop, making it ideal for customizable toolbars, tab bars, or any UI where users can rearrange elements.

Key Features:

• Automatic grid layout (horizontal or vertical)
• Smooth animations when reordering
• Drag-and-drop reordering with visual feedback
• Configurable spacing between items
• Callbacks for drag events and order changes
• Component dragging across grid boundaries

The grid handles layout and animation automatically. When children are reordered via drag-and-drop, the grid smoothly animates them to their new positions.

Usage:

ComponentGrid grid("ToolbarGrid", ComponentGrid::horizontal);
grid.setGap(5); // 5 pixel spacing
 
// Add components
grid.addAndMakeVisible(new Button("Tool 1"));
grid.addAndMakeVisible(new Button("Tool 2"));
grid.addAndMakeVisible(new Button("Tool 3"));
 
// Listen for order changes
grid.onOrderChanged = [](int oldIndex, int newIndex) {
    // Save new order to preferences
};
 
// Optional: Control when dragging can start
grid.onDragStart = [](const MouseEvent& e) {
    return e.mods.isLeftButtonDown(); // Only left-click dragging
};

See also

ComponentAnimator

Member Enumeration Documentation

Orientation

enum ComponentGrid::Orientation

Enumerator
vertical
horizontal

Constructor & Destructor Documentation

ComponentGrid()

ComponentGrid::ComponentGrid	(	const juce::String &	name = {},
		Orientation	o = horizontal
	)

~ComponentGrid()

ComponentGrid::~ComponentGrid ( )

override

Member Function Documentation

timerCallback()

void ComponentGrid::timerCallback ( )

override

mouseDown()

void ComponentGrid::mouseDown ( const juce::MouseEvent &  e )

override

mouseDrag()

void ComponentGrid::mouseDrag ( const juce::MouseEvent &  e )

override

mouseUp()

void ComponentGrid::mouseUp ( const juce::MouseEvent &  e )

override

resized()

void ComponentGrid::resized ( )

override

isDragInProgress()

bool ComponentGrid::isDragInProgress

(

)

setGap()

void ComponentGrid::setGap

(

int

)

setOrientation()

void ComponentGrid::setOrientation

(

Orientation

)

isGridDrag()

static bool ComponentGrid::isGridDrag ( juce::var  )

static

getDragIndex()

static int ComponentGrid::getDragIndex ( juce::var  )

static

layoutAnimated()

void ComponentGrid::layoutAnimated ( )

protected

componentIndex()

int ComponentGrid::componentIndex ( juce::Component &  c )

protected

getComponentRects()

juce::Array< juce::Rectangle< int > > ComponentGrid::getComponentRects ( )

protected

Member Data Documentation

onDragStart

std::function<bool(const juce::MouseEvent&)> ComponentGrid::onDragStart

onOrderChanged

std::function<void (int, int)> ComponentGrid::onOrderChanged

onDragFinished

std::function<void (int, int)> ComponentGrid::onDragFinished

dragStarted

bool ComponentGrid::dragStarted = false

protected

dragging

bool ComponentGrid::dragging = false

protected

dragOut

bool ComponentGrid::dragOut = false

protected

orientation

Orientation ComponentGrid::orientation = horizontal

protected

gap

int ComponentGrid::gap = 1

protected

originalOrder

juce::Array<juce::Component*> ComponentGrid::originalOrder

protected

animator

juce::ComponentAnimator ComponentGrid::animator

protected

---

The documentation for this class was generated from the following file:

• gin_componentgrid.h