Tiles Module

Generic tile processing framework for grid selectors - provides path routing, grouping, clustering, and special group handling.

Overview

tilesModule is a configurable tile processing factory used by grid selector backends. It provides a framework for path-based navigation, context creation with utility functions, and hooks for extensibility.

Module path: lua/ge/extensions/ui/gridSelectorUtils/tilesModule.lua (loaded via require)

Exports (M)

Config Options

Instance Methods

Internals

Context Object

The context bundles configuration and utility functions for path handlers:

local context = {
  itemToTileConverter = ...,
  filterFunction = ...,
  sortingModule = ...,
  groupingModule = ...,

  -- Utility functions
  finalizeGroups = function(groups, favGroup, recentGroup) ... end,
  setDefaultSelection = function(group, model) ... end,
  matchesGroup = function(config, groupMode, groupName) ... end,
  processClusteredItems = function(clustered, group, clusterMode) ... end,
  handleSpecialGroups = function(tile, favGroup, recentGroup) ... end,

  profiler = p,
  data = data,
}

Finalize Groups

Limits recent group to 15 tiles, filters empty groups, and sorts groups by order then name.

Default Selection

Finds the default-selected tile in a group. Priority:

1. Content-specific default (e.g., model.default_pc)
2. Override tile (e.g., from navigation context)
3. Fallback to last tile in the group

Special Group Handling

Duplicates tiles into Favourites/Recent groups based on display mode:

if data.displayData.showFavouritesMode == 'completeClusters' and tile.favouriteIdx > 0 then
  local favouriteTile = deepcopy(tile)
  favouriteTile.key = favouriteTile.key .. "_" .. tile.favouriteIdx
  table.insert(favouriteGroup.tiles, favouriteTile)
end

Path Dispatch

local handler = pathHandlers[pathType]
if handler then
  local result = handler(path, data, context)
  if pathChanged then
    extensions.hook("onGridSelectorGetTiles", backendName, pathType)
  end
  return result
end

How It Works

1. Backend creates instance with tilesModule.create({pathHandlers = {...}, ...})
2. UI calls instance.getTiles(path) with a navigation path
3. A context is created with all utilities and current data
4. Path type dispatches to the registered handler
5. Handler uses context utilities for filtering, grouping, sorting
6. Result is a list of groups with tiles for the grid UI

Additional Exports

The following exports are available but not yet documented in detail:

• M.create

See Also

• Button Module - Related reference
• Display Data Module - Related reference
• Filter Module - Related reference
• UI System Guide - Guide