Download the PHP package xima/xima-typo3-recordlist without Composer

This extension provides a powerful abstract controller for creating advanced record listing backend modules in TYPO3. Save development time by extending AbstractBackendController instead of building record lists from scratch.

Table of Contents

• Why Use This Extension?
• Features
• Requirements
• Install
• Quick Start
• Customization
  • Templates
  • Custom Template Configurations
  • Modifying Records
  • Custom Filters
    • Default Filters
    • Filter Visibility Independent of Columns
    • Modify Query Builder Filters
  • Column Configuration
  • Custom Actions
• Documentation
• Contributing

Why Use This Extension?

Building custom backend modules for listing and managing records typically requires significant boilerplate code. This extension eliminates that overhead by providing:

• Rapid Development: Get a fully-functional backend module with just a few lines of code
• Rich Features Out-of-the-Box: Filtering, sorting, pagination, inline editing, and more
• Multiple Table Support: Manage related tables in a single module with automatic table switching
• Workspace Integration: Built-in support for TYPO3 workspaces with simplified approval workflows
• Highly Customizable: Override templates, modify queries, add custom columns, and extend behavior

Features

• List records from any TYPO3 table
• Filter records by any field with customizable filters
• Sort records by any column
• Configurable columns with user-customizable visibility and order
• Inline editing for quick record updates
• Multiple tables in a single module with dropdown selection
• Multiple templates with per-template action control
• Workspace integration for content approval workflows
• Pagination for handling large datasets
• View record button linking to frontend preview
• Row selection with checkbox, row click, and keyboard shortcuts (Shift+Click, Ctrl/Alt+Click)
• Batch field editing from column headers for selected or all records

Requirements

• TYPO3 13.4+ or 14.0+
• PHP 8.2+

Install

Quick Start

Get a working backend module in 3 simple steps:

1. Extend new controller from AbstractBackendController

The controller must implement getTableNames() (which tables to manage) and getRecordSources() (which pages/folders to collect records from):

See Record Sources for advanced page collection options, including multiple folders and cross-site support.

Note: For multiple tables in one module, return multiple table names:

2. Register Backend Module

Register your module using the Backend module API. The key setting is controllerActions, which must reference your controller:

3. Configure Template Path

Add the template path to your sitepackage using TSconfig:

That's it! Your backend module is now ready to use. Open the TYPO3 backend and navigate to your new module to see it in action.

💡 Tip: Check out the Example directory for working implementations including single-table and multi-table modules.

Customization

The extension is highly customizable through method overrides in your controller. Here are the most common customization options:

Templates

Override templates, partials, or sections by configuring an additional template path in your TSconfig:

Inside your TemplateOverrides folder, create a Templates directory, copy the Default.html file, and customize it.

Custom Template Configurations

By default, there is only one template (Default) available. If you define multiple templates, the template selection appears automatically in the View dropdown and the selection is persisted. To define which templates are available, override getTemplateConfigurations():

Create corresponding template files (e.g., Default.html, Cards.html) in your Templates directory.

Configuration Options:

Available Actions:

Setting actions limits which actions are shown in the module header for the selected template.

Table-Specific Templates:

For controllers managing multiple tables, return different templates per table:

Record Sources (Multiple Directories & Sites)

By default the module collects records from the configured getRecordPid() page and its direct child pages. To aggregate records from several, completely unrelated folders — optionally including their subpages, and even across multiple sites (mandants) — override getRecordSources() and return a list of RecordSource objects:

Behaviour:

• Pages are filtered by the backend user's permissions — inaccessible pages are silently skipped.
• When more than one page is accessible, a directory dropdown appears in the doc header to filter the list per page, and the new record button opens a modal to choose the target page (including the root/first page).
• When the resolved pages span more than one site, labels in the dropdown and the new-record modal are prefixed with the site title (e.g. Site A › News), because folders can share the same name across sites.

Modifying Records

Add computed fields or transform data by overriding the modifyRecord() method:

Custom Filters

Default Filters

Configure filters that are applied automatically when the module first opens — before any user interaction. Override getDefaultFilters() in your controller:

User-submitted filter values always override defaults. Each entry maps a field name to value (required) and expr (optional, defaults to equals). All standard filter expressions are supported: eq, neq, like, notLike, lt, gt, in, notIn.

Filter Visibility Independent of Columns

Show a filter for a field without displaying its column in the table. Set filterVisible on any column in modifyTableConfiguration():

With filterVisible = true, the filter remains in the filter panel regardless of whether the user has toggled the column off via column management. This is useful when you want filtering capability for a field without cluttering the table view.

Modify Query Builder Filters

Add custom filter options by modifying the query builder:

Column Configuration

Configure Default Columns

Set which columns appear by default and in what order:

Fixed Columns

The extension provides two fixed columns that appear before configurable columns:

• Checkbox Column: Enables row selection for batch operations
• Icon Column: Displays the record type icon with automatic language indentation

Both columns can be disabled per table:

Special Columns

The extension automatically adds special columns that users can enable via the column selector:

• UID Column: Displays the unique record ID
• PID Column: Displays the page ID where the record is stored
• Workspace Status Column: Shows workspace state (when workspace mode is active)

These columns are disabled by default but can be activated:

Enable Inline Editing

Make specific columns editable inline by assigning a partial:

Custom Actions

Adding View/Preview Actions

The view button is automatically displayed if TCEMAIN.preview is configured for your table.

To manually add view URLs:

Grouping Actions into Dropdowns

Translation and workspace row actions are collapsed into dropdowns to keep the action column narrow. The grouping is markup-driven — recordlist-action-groups.js discovers the groups from the DOM and needs no change to support a new one.

To add a group (e.g. publishing):

1. Add a dropdown shell in your ActionGroupDropdowns.html partial, marked with data-action-group-menu="publishing" and containing an empty <ul class="dropdown-menu recordlist-action-group-menu"></ul>.
2. Tag the actions that belong in it with data-action-group="publishing".
3. Add a presence-hide rule to your CSS so the empty shell stays hidden — and the column width stays stable on first paint — when a row has no such action:

On load the module moves every [data-action-group="X"] action from the bar into the shell whose data-action-group-menu is X, adds a text label (from the action's title), and strips the now-redundant tooltip.

Documentation

• 📋 Changelog - See what's new in each version
• 🔄 Migration Guide - Upgrading from 13.x to 14.x
• 📁 Example Controllers - Working implementation examples

Contributing

Contributions are welcome! See CONTRIBUTING.md for development setup and guidelines.

License

This extension is licensed under GPL-2.0-or-later.

Credits

Developed and maintained by XIMA Media GmbH.

Found this extension helpful? Please star ⭐ the repository!