Text column
- Displaying a description
- Date formatting
- Currency formatting
- Limiting text length
- Limiting word count
- Wrapping content
- Rendering HTML
- Enum formatting
- Displaying the row index
- Custom formatting
- Customizing the color
- Adding an icon
- Customizing the text size
- Customizing the font weight
- Customizing the font family
- Allowing the text to be copied to the clipboard
Text columns display simple text from your database:
use Filament\Tables\Columns\TextColumn; TextColumn::make('title')
Displaying a description
Descriptions may be used to easily render additional text above or below the column contents.
You can display a description below the contents of a text column using the description()
method:
use Filament\Tables\Columns\TextColumn; TextColumn::make('title') ->description(fn (Post $record): string => $record->description)
By default, the description is displayed below the main text, but you can move it above using the second parameter:
use Filament\Tables\Columns\TextColumn; TextColumn::make('title') ->description(fn (Post $record): string => $record->description, position: 'above')
Date formatting
You may use the date()
and dateTime()
methods to format the column's state using PHP date formatting tokens:
use Filament\Tables\Columns\TextColumn; TextColumn::make('created_at')->dateTime()
You may use the since()
method to format the column's state using Carbon's diffForHumans()
:
use Filament\Tables\Columns\TextColumn; TextColumn::make('created_at')->since()
Currency formatting
The money()
method allows you to easily format monetary values, in any currency. This functionality uses akaunting/laravel-money
internally:
use Filament\Tables\Columns\TextColumn; TextColumn::make('price')->money('eur')
Limiting text length
You may limit()
the length of the cell's value:
use Filament\Tables\Columns\TextColumn; TextColumn::make('description')->limit(50)
You may also reuse the value that is being passed to limit()
:
use Filament\Tables\Columns\TextColumn; TextColumn::make('description') ->limit(50) ->tooltip(function (TextColumn $column): ?string { $state = $column->getState(); if (strlen($state) <= $column->getLimit()) { return null; } // Only render the tooltip if the column contents exceeds the length limit. return $state; })
Limiting word count
You may limit the number of words()
displayed in the cell:
use Filament\Tables\Columns\TextColumn; TextColumn::make('description')->words(10)
Wrapping content
If you'd like your column's content to wrap if it's too long, you may use the wrap()
method:
use Filament\Tables\Columns\TextColumn; TextColumn::make('description')->wrap()
Rendering HTML
If your column value is HTML, you may render it using html()
:
use Filament\Tables\Columns\TextColumn; TextColumn::make('description')->html()
Enum formatting
You may also transform a set of known cell values using the enum()
method:
use Filament\Tables\Columns\TextColumn; TextColumn::make('status')->enum([ 'draft' => 'Draft', 'reviewing' => 'Reviewing', 'published' => 'Published',])
Displaying the row index
You may want a column to contain the number of the current row in the table:
use Filament\Tables\Columns\TextColumn; TextColumn::make('index')->getStateUsing(static function (stdClass $rowLoop): string { return (string) $rowLoop->iteration;});
As $rowLoop
is Laravel's Blade $loop
object, you can reference all other $loop
properties.
As a shortcut, you may use the rowIndex()
method:
use Filament\Tables\Columns\TextColumn; TextColumn::make('index')->rowIndex()
To start counting from 0 instead of 1, use isFromZero: true
:
use Filament\Tables\Columns\TextColumn; TextColumn::make('index')->rowIndex(isFromZero: true)
Custom formatting
You may instead pass a custom formatting callback to formatStateUsing()
, which accepts the $state
of the cell, and optionally its $record
:
use Filament\Tables\Columns\TextColumn; TextColumn::make('status') ->formatStateUsing(fn (string $state): string => __("statuses.{$state}"))
Customizing the color
You may set a color for the text, either primary
, secondary
, success
, warning
or danger
:
use Filament\Tables\Columns\TextColumn; TextColumn::make('status') ->color('primary')
Adding an icon
Text columns may also have an icon:
use Filament\Tables\Columns\TextColumn; TextColumn::make('email') ->icon('heroicon-s-mail')
You may set the position of an icon using iconPosition()
:
use Filament\Tables\Columns\TextColumn; TextColumn::make('email') ->icon('heroicon-s-mail') ->iconPosition('after') // `before` or `after`
Customizing the text size
You may make the text smaller using size('sm')
:
use Filament\Tables\Columns\TextColumn; TextColumn::make('email') ->size('sm')
Or you can make it larger using size('lg')
:
use Filament\Tables\Columns\TextColumn; TextColumn::make('title') ->size('lg')
Customizing the font weight
Text columns have regular font weight by default but you may change this to any of the the following options: thin
, extralight
, light
, medium
, semibold
, bold
, extrabold
or black
.
For instance, you may make the font bold using weight('bold')
:
use Filament\Tables\Columns\TextColumn; TextColumn::make('email') ->weight('bold')
Customizing the font family
You can change the text font family to any of the following options: sans
, serif
or mono
.
For instance, you may make the font mono using fontFamily('mono')
:
use Filament\Tables\Columns\TextColumn; TextColumn::make('text') ->fontFamily('mono')
Allowing the text to be copied to the clipboard
You may make the text copyable, such that clicking on the cell copies the text to the clipboard, and optionally specify a custom confirmation message and duration in milliseconds. This feature only works when SSL is enabled for the app.
use Filament\Tables\Columns\TextColumn; TextColumn::make('email') ->copyable() ->copyMessage('Email address copied') ->copyMessageDuration(1500)
Filament uses tooltips to display the copy message in the admin panel. If you want to use the copyable feature outside of the admin panel, make sure you have
@ryangjchandler/alpine-tooltip
installed in your app.
Still need help? Join our Discord community or open a GitHub discussion