> ## Documentation Index
> Fetch the complete documentation index at: https://filamentphp.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Text column
export const EditOnGitHub = ({version, path}) => {
const url = `https://github.com/filamentphp/filament/edit/${version}/${path}`;
return ;
};
export const Footer = () => {
const sponsorsByTier = JSON.parse(`{
"agency_partner": [
{
"name": "Kirschbaum",
"url": "https://kirschbaumdevelopment.com/solutions/filament-development",
"filename": "kirschbaum.svg"
}
],
"gold": [
{
"name": "Agiledrop",
"url": "https://www.agiledrop.com/laravel?utm_source=filament",
"filename": "agiledrop.svg"
},
{
"name": "Baiz.ai",
"url": "https://baiz.ai",
"filename": "baiz-ai.svg"
},
{
"name": "CMS Max",
"url": "https://cmsmax.com?ref=filamentphp.com",
"filename": "cms-max.svg"
},
{
"name": "Mailtrap",
"url": "https://mailtrap.io/email-sending?utm_source=community&utm_medium=referral&utm_campaign=filament",
"filename": "mailtrap.svg"
},
{
"name": "SerpApi",
"url": "https://serpapi.com/?utm_source=filamentphp",
"filename": "serpapi.svg"
}
]
}`);
function shuffleArray(items) {
const result = [...items];
for (let index = result.length - 1; index > 0; index--) {
const randomIndex = Math.floor(Math.random() * (index + 1));
[result[index], result[randomIndex]] = [result[randomIndex], result[index]];
}
return result;
}
const sponsors = Object.entries(sponsorsByTier).flatMap(([, sponsors]) => shuffleArray(sponsors));
return ;
};
You are currently viewing the documentation for Filament 2.x, which is a previous version of Filament.
Looking for the current stable version? Visit the [5.x documentation](/docs/5.x/tables/columns/text).
Text columns display simple text from your database:
```php theme={"theme":"gruvbox-dark-hard"}
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:
```php theme={"theme":"gruvbox-dark-hard"}
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:
```php theme={"theme":"gruvbox-dark-hard"}
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](https://www.php.net/manual/en/datetime.format.php):
```php theme={"theme":"gruvbox-dark-hard"}
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()`](https://carbon.nesbot.com/docs/#api-humandiff):
```php theme={"theme":"gruvbox-dark-hard"}
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`](https://github.com/akaunting/laravel-money) internally:
```php theme={"theme":"gruvbox-dark-hard"}
use Filament\Tables\Columns\TextColumn;
TextColumn::make('price')->money('eur')
```
Alternatively, you can set the default currency through the environment variable `DEFAULT_CURRENCY`.
## Limiting text length
You may `limit()` the length of the cell's value:
```php theme={"theme":"gruvbox-dark-hard"}
use Filament\Tables\Columns\TextColumn;
TextColumn::make('description')->limit(50)
```
You may also reuse the value that is being passed to `limit()`:
```php theme={"theme":"gruvbox-dark-hard"}
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:
```php theme={"theme":"gruvbox-dark-hard"}
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:
```php theme={"theme":"gruvbox-dark-hard"}
use Filament\Tables\Columns\TextColumn;
TextColumn::make('description')->wrap()
```
## Rendering HTML
If your column value is HTML, you may render it using `html()`:
```php theme={"theme":"gruvbox-dark-hard"}
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:
```php theme={"theme":"gruvbox-dark-hard"}
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:
```php theme={"theme":"gruvbox-dark-hard"}
use Filament\Tables\Columns\TextColumn;
use Filament\Tables\Contracts\HasTable;
TextColumn::make('index')->getStateUsing(
static function (stdClass $rowLoop, HasTable $livewire): string {
return (string) (
$rowLoop->iteration +
($livewire->tableRecordsPerPage * (
$livewire->getPage() - 1
))
);
}
),
```
As `$rowLoop` is Laravel Blade's `$loop` object, you can reference all other `$loop` properties.
## Custom formatting
You may instead pass a custom formatting callback to `formatStateUsing()`, which accepts the `$state` of the cell, and optionally its `$record`:
```php theme={"theme":"gruvbox-dark-hard"}
use Filament\Tables\Columns\TextColumn;
TextColumn::make('status')
->formatStateUsing(fn (string $state): string => __("statuses.{$state}"))
```
## Adding a placeholder if the cell is empty
Sometimes you may want to display a placeholder if the cell's value is empty:
```php theme={"theme":"gruvbox-dark-hard"}
use Filament\Tables\Columns\TextColumn;
TextColumn::make('updated_at')
->placeholder('Never')
```
## Customizing the color
You may set a color for the text, either `primary`, `secondary`, `success`, `warning` or `danger`:
```php theme={"theme":"gruvbox-dark-hard"}
use Filament\Tables\Columns\TextColumn;
TextColumn::make('status')
->color('primary')
```
## Adding an icon
Text columns may also have an icon:
```php theme={"theme":"gruvbox-dark-hard"}
use Filament\Tables\Columns\TextColumn;
TextColumn::make('email')
->icon('heroicon-s-mail')
```
You may set the position of an icon using `iconPosition()`:
```php theme={"theme":"gruvbox-dark-hard"}
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')`:
```php theme={"theme":"gruvbox-dark-hard"}
use Filament\Tables\Columns\TextColumn;
TextColumn::make('email')
->size('sm')
```
Or you can make it larger using `size('lg')`:
```php theme={"theme":"gruvbox-dark-hard"}
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')`:
```php theme={"theme":"gruvbox-dark-hard"}
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')`:
```php theme={"theme":"gruvbox-dark-hard"}
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.
```php theme={"theme":"gruvbox-dark-hard"}
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](https://github.com/ryangjchandler/alpine-tooltip#installation) in your app.
### Customizing the text that is copied to the clipboard
You can customize the text that gets copied to the clipboard using the \`copyableState() method:
```php theme={"theme":"gruvbox-dark-hard"}
use Filament\Tables\Columns\TextColumn;
TextColumn::make('url')
->copyable()
->copyableState(fn (string $state): string => "URL: {$state}")
```
In this function, you can access the whole table row with `$record`:
```php theme={"theme":"gruvbox-dark-hard"}
use App\Models\Post;
use Filament\Tables\Columns\TextColumn;
TextColumn::make('url')
->copyable()
->copyableState(fn (Post $record): string => "URL: {$record->url}")
```
)}
Your logo here