GridViewController

Grid View Controller - Simplified Architecture

This controller follows a clean MVC pattern where:

  • Server generates complete state
  • Templates display state
  • Controller captures user actions and navigates

NO state management in JavaScript - server is source of truth.

Supports optional bulk selection when enableBulkSelection is configured.

Constructor

new GridViewController()

Source

Methods

applyColumnChanges()

Apply column changes (from modal)

Source

applyDateRangeFilter()

Apply date range filter

Source

applySort()

Apply sort to a column

Source

buildUrl()

Build URL with updated parameters

Source

buildUrlWithFilters()

Build URL with filter parameters

Source

clearAllFilters()

Clear all filters and search (preserves locked filters)

Source

clearBulkSelection()

Clear all bulk selections

Source

(async) clearDefault()

Clear user default view

Source

clearSearch()

Clear search

Source

connect()

Initialize controller

Source

createFilterPill(column, value, isLocked)

Create a filter pill element

Parameters:
NameTypeDefaultDescription
columnstring

The filter column key

valuestring

The filter value

isLockedbooleanfalse

Whether this filter is locked (cannot be removed)

Source

createSearchBadge()

Create a search badge element

Source

createViewTab(name, viewId, isActive, isPreferred, canManage, count)

Create a view tab element

Parameters:
NameTypeDefaultDescription
namestring

Tab name

viewIdstring | null

View ID (null for 'All' tab)

isActiveboolean

Is this the active tab

isPreferredboolean

Is this the preferred (default) view

canManageboolean

Can this view be managed

countnumber | nullnull

Optional count for badge display

Source

(async) deleteView()

Delete current view

Source

disconnect()

Cleanup when controller disconnects

Source

escapeHtml()

Escape HTML for safe insertion

Source

exportCsv()

Export current grid data to CSV

Triggers a CSV export with current filters, search, sort, and column selection. Uses the table frame's src URL as base (handles embedded grids with custom endpoints).

Source

formatColumnName()

Format column name for display

Source

getCsrfToken()

Get CSRF token from meta tag

Source

getCurrentConfig()

Get current configuration for saving

Source

getFilterColumnLabel()

Get filter column label from metadata

Source

getFilterValueLabel()

Get filter value label from metadata

Source

handleColumnReorder()

Handle column reorder from sortable list

Source

handleFrameLoad()

Handle Turbo Frame load - update state from table frame

Source

handleSearchKeyup()

Handle search input keyup with debouncing

Source

isFilterLocked(column, lockedFilters) → {boolean}

Check if a filter column is locked

Parameters:
NameTypeDescription
columnstring

The filter column key

lockedFiltersArray.<string>

Array of locked filter keys

Source
Returns:

True if the filter is locked

Type: 
boolean

loadInlineState()

Load state from inline rendered content (when table frame doesn't have src) This handles the case where grid content is pre-rendered on initial page load.

Source

Navigate to URL via Turbo (frame or full page)

Source

performSearch()

Perform search

Source

removeFilter()

Remove a specific filter value

Source

(async) saveView()

Save current state as new view

Source

selectFilter()

Show specific filter panel in dropdown

Source

(async) setDefault()

Set current view as user default

Source

setSearchBusy()

Toggle search busy indicator in the filter search input.

Source

showAll()

Show all records (clear view selection)

Source

switchView()

Switch to a specific view

Source

toggleAllSelection()

Toggle all row checkboxes on current page

Source

toggleColumn()

Toggle column visibility (checkbox in modal)

Source

toggleFilter()

Toggle a filter value

Source

toggleRowSelection()

Toggle individual row selection checkbox

Source

toggleSubRow(event)

Toggle sub-row expansion for additional details

Parameters:
NameTypeDescription
eventEvent

Click event from cell with toggleSubRow action

Source

triggerBulkAction()

Trigger bulk action - dispatches event with selected IDs for modal listeners

Source

updateBulkSelectionUI()

Update bulk action button state and selection count display

Source

updateClearFiltersFooter()

Update clear filters footer visibility

Source

updateColumnPicker()

Update column picker modal

Source

updateDateRangeFilter()

Update date range filter value

Source

updateFilterCount()

Update filter count badge

Source

updateFilterDropdownCheckboxes()

Update filter dropdown checkboxes to match current state (This is now mostly redundant since we rebuild the panels, but keeping it for any dynamic checkbox updates)

Source

updateFilterNavigation()

Update filter navigation (left side filter tabs)

Source

updateFilterPanels()

Update filter panels (right side filter options)

Source

updateFilterPills()

Update filter pill display

Source

updateSearchDisplay()

Update search display

Source

updateToolbar()

Update toolbar UI based on current state

Source

(async) updateView()

Update existing view with current state

Source

updateViewTabs()

Update view tabs from state

Source