\Aksara\Laboratory\Core->sortable()

The documentation and cheat sheet of our framework

sortable() enables drag-and-drop row sorting.

Purpose

sortable() enables drag-and-drop row sorting. It lets a controller customize Aksara Core behavior while keeping the request inside the built-in CRUD, rendering, permission, validation, and response pipeline.

When to Use

Use it when the default generated interface needs extra controls, actions, filters, or layout behavior.

Reference

sortable(?string $primaryKey, ?string $orderKey)

Parameters

Parameter	Type	Required	Default	Description
`$primaryKey`	`?string`	Yes	-	Related table key or local primary key field.
`$orderKey`	`?string`	Yes	-	Column used to persist row order.

Return Value

static

Returns the current controller instance so it can be chained with other Core methods.

Behavior

sortable() stores UI configuration for the generated interface. The renderer reads that configuration later and places the control in the correct table, toolbar, filter, grid, or form location.

[!WARNING]
The order column must be writable and stable. Avoid enabling sorting on data that is ordered by business rules or external systems.

Basic Usage

$this->sortable('menu_id', 'sort_order');

return $this->render('orders');

Advanced Usage

$this->addToolbar('orders/report', phrase('Report'), 'btn btn-outline-primary', 'mdi mdi-chart-bar')
    ->addButton('orders/read', phrase('View'), 'btn btn-sm btn-outline-secondary', 'mdi mdi-eye', ['order_id' => 'order_id']);

Complete Example

namespace Modules\Orders\Controllers;

use Aksara\Laboratory\Core;

class Orders extends Core
{
    public function index()
    {
        $this->setTitle(phrase('Orders'))
            ->sortable('menu_id', 'sort_order');

        return $this->render('orders');
    }
}

Result

The generated interface includes or changes the configured control without requiring a custom view.

Notes

This method is chainable and returns the current controller instance.
Use phrase() for visible labels so the interface remains translatable.
Action parameters can reference row fields so generated buttons point to the current record.