README

Build sortable, filterable AG Grid data tables on wiki pages, straight from Lua. Put clickable links and thumbnails inside cells, page through large datasets, and query rows from Semantic MediaWiki or Bucket.

✨ Highlights

• Interactive tables on wiki pages — readers sort, filter, search, and page through the data in place, instead of scrolling a static wikitable.
• Scales to large datasets — page through thousands of rows, or query them on the server so the page stays light.
• Shows your structured data — turn Semantic MediaWiki or Bucket data into a live table, sorted, filtered, and paged on the server.
• Rich cells — clickable page links and thumbnails inside cells, resolved server-side.
• Authored in Lua — define grids in a Scribunto module; no hand-built HTML or JavaScript.
• Fits your wiki — matches the active skin's light/dark colours automatically, and extends from JavaScript when you need a custom renderer or filter.

📋 Requirements

• MediaWiki 1.43 or later
• Scribunto

📦 Installation

1. Drop the extension in extensions/AGGrid and load it from LocalSettings.php:

   wfLoadExtension( 'AGGrid' );

2. Run the database updater to create the extension's tables (aggrid_data, aggrid_source):

   php maintenance/run.php update

   Grids will not render until these tables exist.

⚙️ Configuration

All settings are optional.

🚀 Quick start

Pass a gridOptions table to render:

mw.ext.aggrid.render{
    columnDefs = {
        { field = 'name', headerName = 'Name' },
        { field = 'price', headerName = 'Price', filter = 'agNumberColumnFilter' },
    },
    rowData = {
        { name = 'Aurora', price = 25 },
        { name = 'Mustang', price = 30 },
    },
    pagination = true,
}

gridOptions mirrors AG Grid's gridOptions object one to one, so anything JSON-serialisable from their docs works here. See Authoring grids for the full picture.

🔀 Two ways to supply data

• Inline — supply columnDefs and rowData directly, as above. Best for small, hand-written or Lua-generated tables. → Authoring grids
• Backend source — supply a source descriptor and the rows come from Semantic MediaWiki or Bucket, queried and paged on the server. Best for large or already-stored datasets. → Backend source grids

📚 Documentation

🔎 See also

• Extension page on mediawiki.org
• AG Grid documentation

⚖️ License

GPL-3.0-or-later. Bundles AG Grid Community (MIT); see modules/lib/ag-grid-community/LICENSE.txt.