Weave Code
Laravel Datatables Laravel Package
singlequote/laravel-datatables
A Laravel package for building server-side DataTables with a fluent, query-driven API, column configuration, and Blade-friendly rendering for fast, searchable, sortable admin listings.
This repo contains a Datatable that can render a filterable and sortable table. It aims to be very lightweight and easy to use. It has support for retrieving data asynchronously, pagination and recursive searching in relations
Frequently asked questions about Laravel Datatables
- How do I install singlequote/laravel-datatables in a Laravel app?
- Install it with Composer using composer require singlequote/laravel-datatables. Laravel's package auto-discovery registers the service provider, so no manual wiring is normally required. After installing, define your datatable class, point it at a query, and render it from a Blade view. Check the repository README for any optional config publishing step before you customize defaults.
- Which Laravel and PHP versions does laravel-datatables support?
- The 4.x line is at a patch release (4.0.28), which suggests a mature, stable API, but the exact PHP and Illuminate constraints are declared in the package's composer.json. Check that file and the Packagist metadata against your application's Laravel major version before adopting. Version mismatches are the most common reason a simple Composer install turns into unplanned upgrade work.
- How does asynchronous data loading work in this package?
- The datatable retrieves rows asynchronously from a server-side endpoint rather than rendering the full dataset inline. Your datatable definition supplies the underlying query and column configuration, and the package handles the request, filtering, sorting, and response. This keeps initial page loads fast because only the current page of rows is fetched.
- How do I make columns sortable and filterable?
- Columns are configured individually, so you declare which ones are sortable and which participate in searching. The package translates those flags into the appropriate query ordering and filtering clauses on the server. Because configuration is fluent, you can build the column list in one place alongside the query definition.
- Can laravel-datatables search inside Eloquent relationships?
- Yes, recursive searching in relations is one of the package's stated features, so filters can reach into related models rather than only the base table's columns. Under the hood this typically means the query builder applies joins or relationship constraints for you. On large tables, keep an eye on the generated SQL and add indexes on the columns being searched through relations.
- Does it handle pagination for large tables?
- Pagination is supported server-side, meaning the database returns only the rows for the current page instead of the entire result set. That makes it suitable for admin listings with thousands of records, provided your filters and sorts are backed by indexes. You can combine pagination with searching and sorting without loading everything into memory.
- Can I render the table directly in a Blade view?
- Yes, the package is designed to be Blade-friendly: you configure the datatable in PHP and output the table markup from your view. This keeps your controllers thin and lets you style the table with your existing layout. The JavaScript side handles the asynchronous requests and pagination controls.
- How does it compare to yajra/laravel-datatables?
- singlequote/laravel-datatables positions itself as very lightweight and easy to use, focusing on filtering, sorting, async retrieval, pagination, and relation search. yajra/laravel-datatables is a much larger package with a broader feature surface, including extensive export and editor integrations. If you only need a clean, query-driven listing, the lighter package may mean less configuration and fewer dependencies; if you need advanced features, evaluate yajra first.
- How should I test a datatable endpoint in my Laravel test suite?
- Treat the asynchronous endpoint like any other JSON route: write a feature test that authenticates as an admin, hits the endpoint, and asserts the response structure such as rows, totals, and pagination metadata. Use RefreshDatabase and seed a small, known dataset so you can assert exact filtering and sorting behavior. Also add a test for relation-based search if you rely on it, since that is where query bugs tend to surface.
- Is singlequote/laravel-datatables actively maintained and safe for production use?
- Recent patch-level releases in the 4.x line are a positive sign of ongoing maintenance, and the package's scope is small enough to audit. Before adopting, review the commit history, open issues, test coverage, and CI status for the tag you plan to pin. Because patch releases may include undisclosed bug fixes, read the release notes and run your own listing tests after upgrading.
Weaver
How can I help you explore Laravel packages today?