Overview
The reference section covers all public interfaces for interacting with ActiveGrid across Grid, Columns and Rows.
Grid
The grid section explains key information for configuring and interacting with the grid, including how to configure properties, handle events, and interact with the grid via its API.
- Overview - Key information for working with the grid
- Grid Options - Properties and callbacks used to configure the grid
- Events Reference - Events that can be used to trigger application logic
- API Reference - Methods used to interact with a grid instance
- Custom Components - Creating custom components for the grid
Columns
The columns reference section starts with an overview of columns, followed by detailed configuration options and methods.
- Overview - Key information for working with columns
- Column Definitions - Properties and callbacks used to configure columns
- Column Meta - Extended metadata properties for columns
- Column Types - Reusable column presets for consistent configuration
- Column Defaults - Default settings applied to all columns
- Events Reference - Events fired by columns
Rows
The rows reference section covers ways to interact with instantiated rows displayed within the grid.
- Overview - Key information for working with rows
- Row Pinning - Pin rows to the top or bottom of the grid
- Row Menu - Configure row action menus
- Events Reference - Events fired by rows
Features
Core grid features that enhance functionality and user experience.
- Sorting - Single and multi-column sorting
- Filtering - Column filtering with operators
- Pagination - Configure pagination behavior
- Selection - Row selection with checkboxes
- Editing - Cell and row editing with validation
- Virtualization - High-performance rendering for large datasets
- Keyboard Navigation - Navigate and interact using keyboard
UI Components
User interface components for toolbars, menus, and visual settings.
- Toolbar - Configure search and action bar
- Header Menu - Column header context menu
- Context Menu - Right-click row menu
- Settings - Visual settings and theme
Data Management
Configure how the grid loads and manages data, including state persistence.
- Client Mode - Client-side data handling
- Server Mode - Server-side data loading
- State Persistence - Save and restore grid state
- URL Sync - Synchronize with URL query parameters
Cell Components
Pre-built and custom cell renderers and editors.
- Built-in Cells - Pre-built cell components
- Cell Editors - Built-in editors for editing mode
- Custom Cells - Create custom cell renderers
Utilities
Helper functions for common grid operations.
- Export Utils - Export data to CSV and JSON
- Auto Size Utils - Calculate optimal column widths
- Pinning Utils - Helper functions for pinning
Hooks
React hooks for advanced grid functionality.
- useKeyboardNavigation - Keyboard navigation hook
TypeScript
Type-safe grid configuration with TypeScript support.
- Overview - TypeScript integration guide
- Generics - Using generic type parameters
- Type Definitions - Complete type reference
Styling
Customize the appearance of the grid with CSS.
- CSS Classes - Available CSS classes for styling
- CSS Variables - CSS custom properties for theming
- Custom Styling - Advanced styling techniques