Choice Column

The ChoiceColumn maps a field’s raw value to a human-readable label. It optionally renders the label as a Bootstrap badge with a per-value color variant. PHP 8.1 BackedEnum classes are supported natively.

Basic Usage

use Pentiminax\UX\DataTables\Column\ChoiceColumn;

ChoiceColumn::new('status', 'Status')
    ->setChoices([
        'active'   => 'Active',
        'inactive' => 'Inactive',
        'pending'  => 'Pending',
    ]);

Using a BackedEnum

Pass a BackedEnum class directly, or pass ::cases(). The mapping is auto-generated from case->value => case->name.

enum Status: string
{
    case Active   = 'active';
    case Inactive = 'inactive';
    case Pending  = 'pending';
}

ChoiceColumn::new('status', 'Status')
    ->setChoices(Status::cases());
// Generates: ['active' => 'Active', 'inactive' => 'Inactive', 'pending' => 'Pending']

Rendering as Bootstrap Badges

Use renderAsBadges() to wrap each label in a <span class="badge text-bg-{variant}"> element. Map individual values to Bootstrap color variants, and provide a fallback for unmapped values.

ChoiceColumn::new('status', 'Status')
    ->setChoices(Status::cases())
    ->renderAsBadges(
        badgeSelector: [
            'active'   => 'success',
            'inactive' => 'danger',
            'pending'  => 'warning',
        ],
        defaultVariant: 'secondary',
    );

Default Badge Variant

When renderAsBadges() is called without a badgeSelector map (or for values not present in the map), the defaultVariant is used. It defaults to 'secondary'.

ChoiceColumn::new('category', 'Category')
    ->setChoices(['foo' => 'Foo', 'bar' => 'Bar'])
    ->renderAsBadges(); // all values use 'secondary' variant

API Reference

Complete Example

use Pentiminax\UX\DataTables\Attribute\AsDataTable;
use Pentiminax\UX\DataTables\Column\ChoiceColumn;
use Pentiminax\UX\DataTables\Column\NumberColumn;
use Pentiminax\UX\DataTables\Column\TextColumn;
use Pentiminax\UX\DataTables\Model\AbstractDataTable;

enum OrderStatus: string
{
    case Draft     = 'draft';
    case Confirmed = 'confirmed';
    case Shipped   = 'shipped';
    case Cancelled = 'cancelled';
}

#[AsDataTable(Order::class)]
final class OrdersDataTable extends AbstractDataTable
{
    public function configureColumns(): iterable
    {
        yield NumberColumn::new('id', 'ID');
        yield TextColumn::new('reference', 'Reference');
        yield ChoiceColumn::new('status', 'Status')
            ->setChoices(OrderStatus::class)
            ->renderAsBadges([
                'draft'     => 'secondary',
                'confirmed' => 'primary',
                'shipped'   => 'success',
                'cancelled' => 'danger',
            ]);
    }

    protected function mapRow(mixed $item): array
    {
        return [
            'id'        => $item->getId(),
            'reference' => $item->getReference(),
            'status'    => $item->getStatus()->value,
        ];
    }
}