Text column - 表格

简介

文本列用于展示普通文本：

use Filament\Tables\Columns\TextColumn;

TextColumn::make('title')

自定义颜色

你可以为文本设置颜色：

use Filament\Tables\Columns\TextColumn;

TextColumn::make('status')
    ->color('primary')

As well as allowing a static value, the color() method also accepts a function to dynamically calculate it. You can inject various utilities into the function as parameters.

Learn more about utility injection.

Utility	Type	Parameter	Description
Column	`Filament\Tables\Columns\Column`	`$column`	The current column instance.
Livewire	`Livewire\Component`	`$livewire`	The Livewire component instance.
Eloquent record	`?Illuminate\Database\Eloquent\Model`	`$record`	The Eloquent record for the current table row.
Row loop	`stdClass`	`$rowLoop`	The row loop object for the current table row.
State	`mixed`	`$state`	The current value of the column, based on the current table row.
Table	`Filament\Tables\Table`	`$table`	The current table instance.

添加图标

文本列也可以添加图标：

use Filament\Tables\Columns\TextColumn;
use Filament\Support\Icons\Heroicon;

TextColumn::make('email')
    ->icon(Heroicon::Envelope)

The icon() method also accepts a function to dynamically calculate the icon. You can inject various utilities into the function as parameters.

Learn more about utility injection.

Utility	Type	Parameter	Description
Column	`Filament\Tables\Columns\Column`	`$column`	The current column instance.
Livewire	`Livewire\Component`	`$livewire`	The Livewire component instance.
Eloquent record	`?Illuminate\Database\Eloquent\Model`	`$record`	The Eloquent record for the current table row.
Row loop	`stdClass`	`$rowLoop`	The row loop object for the current table row.
State	`mixed`	`$state`	The current value of the column, based on the current table row.
Table	`Filament\Tables\Table`	`$table`	The current table instance.

你可以使用 iconPosition() 方法设置图标的位置：

use Filament\Tables\Columns\TextColumn;
use Filament\Support\Enums\IconPosition;
use Filament\Support\Icons\Heroicon;

TextColumn::make('email')
    ->icon(Heroicon::Envelope)
    ->iconPosition(IconPosition::After) // `IconPosition::Before` or `IconPosition::After`

The iconPosition() method also accepts a function to dynamically calculate the icon position. You can inject various utilities into the function as parameters.

Learn more about utility injection.

Utility	Type	Parameter	Description
Column	`Filament\Tables\Columns\Column`	`$column`	The current column instance.
Livewire	`Livewire\Component`	`$livewire`	The Livewire component instance.
Eloquent record	`?Illuminate\Database\Eloquent\Model`	`$record`	The Eloquent record for the current table row.
Row loop	`stdClass`	`$rowLoop`	The row loop object for the current table row.
State	`mixed`	`$state`	The current value of the column, based on the current table row.
Table	`Filament\Tables\Table`	`$table`	The current table instance.

图标颜色默认为文本颜色，不过你可以使用 iconColor() 方法，单独自定义图标颜色：

use Filament\Tables\Columns\TextColumn;
use Filament\Support\Icons\Heroicon;

TextColumn::make('email')
    ->icon(Heroicon::Envelope)
    ->iconColor('primary')

The iconColor() method also accepts a function to dynamically calculate the icon color. You can inject various utilities into the function as parameters.

Learn more about utility injection.

Utility	Type	Parameter	Description
Column	`Filament\Tables\Columns\Column`	`$column`	The current column instance.
Livewire	`Livewire\Component`	`$livewire`	The Livewire component instance.
Eloquent record	`?Illuminate\Database\Eloquent\Model`	`$record`	The Eloquent record for the current table row.
Row loop	`stdClass`	`$rowLoop`	The row loop object for the current table row.
State	`mixed`	`$state`	The current value of the column, based on the current table row.
Table	`Filament\Tables\Table`	`$table`	The current table instance.

显示为”徽章”

默认情况下，文本非常简单，没有背景色。你可以使用 badge() 方法将其显示为”徽章”。这方面的一个很好的用例是状态展示，其中可能需要显示与状态相匹配的颜色徽章：

use Filament\Tables\Columns\TextColumn;

TextColumn::make('status')
    ->badge()
    ->color(fn (string $state): string => match ($state) {
        'draft' => 'gray',
        'reviewing' => 'warning',
        'published' => 'success',
        'rejected' => 'danger',
    })

你可以添加其他东西诸如图标到徽章中。

或者，你也可以传入布尔值以控制文本是否展示为徽章：

use Filament\Tables\Columns\TextColumn;

TextColumn::make('status')
    ->badge(FeatureFlag::active())

As well as allowing a static value, the badge() method also accepts a function to dynamically calculate it. You can inject various utilities into the function as parameters.

Learn more about utility injection.

Utility	Type	Parameter	Description
Column	`Filament\Tables\Columns\Column`	`$column`	The current column instance.
Livewire	`Livewire\Component`	`$livewire`	The Livewire component instance.
Eloquent record	`?Illuminate\Database\Eloquent\Model`	`$record`	The Eloquent record for the current table row.
Row loop	`stdClass`	`$rowLoop`	The row loop object for the current table row.
State	`mixed`	`$state`	The current value of the column, based on the current table row.
Table	`Filament\Tables\Table`	`$table`	The current table instance.

格式化

When using a text column, you may want the actual outputted text in the UI to differ from the raw state of the column, which is often automatically retrieved from an Eloquent model. Formatting the state allows you to preserve the integrity of the raw data while also allowing it to be presented in a more user-friendly way.

To format the state of a text column without changing the state itself, you can use the formatStateUsing() method. This method accepts a function that takes the state as an argument and returns the formatted state:

use Filament\Tables\Columns\TextColumn;

TextColumn::make('status')
    ->formatStateUsing(fn (string $state): string => __("statuses.{$state}"))

In this case, the status column in the database might contain values like draft, reviewing, published, or rejected, but the formatted state will be the translated version of these values.

The function passed to formatStateUsing() can inject various utilities as parameters.

Learn more about utility injection.

Utility	Type	Parameter	Description
Column	`Filament\Tables\Columns\Column`	`$column`	The current column instance.
Livewire	`Livewire\Component`	`$livewire`	The Livewire component instance.
Eloquent record	`?Illuminate\Database\Eloquent\Model`	`$record`	The Eloquent record for the current table row.
Row loop	`stdClass`	`$rowLoop`	The row loop object for the current table row.
State	`mixed`	`$state`	The current value of the column, based on the current table row.
Table	`Filament\Tables\Table`	`$table`	The current table instance.

日期格式化

Instead of passing a function to formatStateUsing(), you may use the date(), dateTime(), and time() methods to format the column’s state using PHP date formatting tokens:

use Filament\Tables\Columns\TextColumn;

TextColumn::make('created_at')
    ->date()

TextColumn::make('created_at')
    ->dateTime()

TextColumn::make('created_at')
    ->time()

You may customize the date format by passing a custom format string to the date(), dateTime(), or time() method. You may use any PHP date formatting tokens:

use Filament\Tables\Columns\TextColumn;

TextColumn::make('created_at')
    ->date('M j, Y')
    
TextColumn::make('created_at')
    ->dateTime('M j, Y H:i:s')
    
TextColumn::make('created_at')
    ->time('H:i:s')

As well as allowing static values, the date(), dateTime(), and time() methods also accept a function to dynamically calculate the format. You can inject various utilities into the function as parameters.

Learn more about utility injection.

Utility	Type	Parameter	Description
Column	`Filament\Tables\Columns\Column`	`$column`	The current column instance.
Livewire	`Livewire\Component`	`$livewire`	The Livewire component instance.
Eloquent record	`?Illuminate\Database\Eloquent\Model`	`$record`	The Eloquent record for the current table row.
Row loop	`stdClass`	`$rowLoop`	The row loop object for the current table row.
State	`mixed`	`$state`	The current value of the column, based on the current table row.
Table	`Filament\Tables\Table`	`$table`	The current table instance.

Date formatting using Carbon macro formats

You may use also the isoDate(), isoDateTime(), and isoTime() methods to format the column’s state using Carbon’s macro-formats:

use Filament\Tables\Columns\TextColumn;

TextColumn::make('created_at')
    ->isoDate()

TextColumn::make('created_at')
    ->isoDateTime()

TextColumn::make('created_at')
    ->isoTime()

You may customize the date format by passing a custom macro format string to the isoDate(), isoDateTime(), or isoTime() method. You may use any Carbon’s macro-formats:

use Filament\Tables\Columns\TextColumn;

TextColumn::make('created_at')
    ->isoDate('L')

TextColumn::make('created_at')
    ->isoDateTime('LLL')

TextColumn::make('created_at')
    ->isoTime('LT')

As well as allowing static values, the isoDate(), isoDateTime(), and isoTime() methods also accept a function to dynamically calculate the format. You can inject various utilities into the function as parameters.

Learn more about utility injection.

Utility	Type	Parameter	Description
Column	`Filament\Tables\Columns\Column`	`$column`	The current column instance.
Livewire	`Livewire\Component`	`$livewire`	The Livewire component instance.
Eloquent record	`?Illuminate\Database\Eloquent\Model`	`$record`	The Eloquent record for the current table row.
Row loop	`stdClass`	`$rowLoop`	The row loop object for the current table row.
State	`mixed`	`$state`	The current value of the column, based on the current table row.
Table	`Filament\Tables\Table`	`$table`	The current table instance.

相对日期格式化

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()

Additionally, you can use the dateTooltip(), dateTimeTooltip(), timeTooltip(), isoDateTooltip(), isoDateTimeTooltip(), isoTime(), isoTimeTooltip(), or sinceTooltip() method to display a formatted date in a tooltip, often to provide extra information:

use Filament\Tables\Columns\TextColumn;

TextColumn::make('created_at')
    ->since()
    ->dateTooltip() // Accepts a custom PHP date formatting string

TextColumn::make('created_at')
    ->since()
    ->dateTimeTooltip() // Accepts a custom PHP date formatting string

TextColumn::make('created_at')
    ->since()
    ->timeTooltip() // Accepts a custom PHP date formatting string

TextColumn::make('created_at')
    ->since()
    ->isoDateTooltip() // Accepts a custom Carbon macro format string

TextColumn::make('created_at')
    ->since()
    ->isoDateTimeTooltip() // Accepts a custom Carbon macro format string

TextColumn::make('created_at')
    ->since()
    ->isoTimeTooltip() // Accepts a custom Carbon macro format string

TextColumn::make('created_at')
    ->dateTime()
    ->sinceTooltip()

为日期格式化设置时区

上面列出的每个日期格式化方法都接受一个 timezone 参数，它允许你将状态中设置的时间转换为不同的时区：

use Filament\Tables\Columns\TextColumn;

TextColumn::make('created_at')
    ->dateTime(timezone: 'America/New_York')

你可以将时区传递给列的 timezone() 方法，以便一次想将时区应用于所有日期时间格式化方法：

use Filament\Tables\Columns\TextColumn;

TextColumn::make('created_at')
    ->timezone('America/New_York')
    ->dateTime()

As well as allowing static values, the timezone() method also accepts a function to dynamically calculate the timezone. You can inject various utilities into the function as parameters.

Learn more about utility injection.

Utility	Type	Parameter	Description
Column	`Filament\Tables\Columns\Column`	`$column`	The current column instance.
Livewire	`Livewire\Component`	`$livewire`	The Livewire component instance.
Eloquent record	`?Illuminate\Database\Eloquent\Model`	`$record`	The Eloquent record for the current table row.
Row loop	`stdClass`	`$rowLoop`	The row loop object for the current table row.
State	`mixed`	`$state`	The current value of the column, based on the current table row.
Table	`Filament\Tables\Table`	`$table`	The current table instance.

如果你没有将时区传入到列中，它将使用 Filament 默认的时区。你可以在服务提供者(如 AppServiceProvider)的 boot() 方法中使用 FilamentTimezone::set() 方法设置默认时区：

use Filament\Support\Facades\FilamentTimezone;

public function boot(): void
{
    FilamentTimezone::set('America/New_York');
}

如果你想为应用中的所有文本列设置默认时区，这很有用。它同时也在 Filament 中其他使用到时区的地方中生效。

NOTE

Filament’s default timezone will only apply when the column stores a time. If the column stores a date only (date() instead of dateTime()), the timezone will not be applied. This is to prevent timezone shifts when storing dates without times.

数字格式化

Instead of passing a function to formatStateUsing(), you can use the numeric() method to format a column as a number:

use Filament\Tables\Columns\TextColumn;

TextColumn::make('stock')
    ->numeric()

If you would like to customize the number of decimal places used to format the number with, you can use the decimalPlaces argument:

use Filament\Tables\Columns\TextColumn;

TextColumn::make('stock')
    ->numeric(decimalPlaces: 0)

As well as allowing static values, the decimalPlaces argument also accepts a function to dynamically calculate it. You can inject various utilities into the function as parameters.

Learn more about utility injection.

Utility	Type	Parameter	Description
Column	`Filament\Tables\Columns\Column`	`$column`	The current column instance.
Livewire	`Livewire\Component`	`$livewire`	The Livewire component instance.
Eloquent record	`?Illuminate\Database\Eloquent\Model`	`$record`	The Eloquent record for the current table row.
Row loop	`stdClass`	`$rowLoop`	The row loop object for the current table row.
State	`mixed`	`$state`	The current value of the column, based on the current table row.
Table	`Filament\Tables\Table`	`$table`	The current table instance.

By default, your app’s locale will be used to format the number suitably. If you would like to customize the locale used, you can pass it to the locale argument:

use Filament\Tables\Columns\TextColumn;

TextColumn::make('stock')
    ->numeric(locale: 'nl')

As well as allowing static values, the locale argument also accepts a function to dynamically calculate it. You can inject various utilities into the function as parameters.

Learn more about utility injection.

Utility	Type	Parameter	Description
Column	`Filament\Tables\Columns\Column`	`$column`	The current column instance.
Livewire	`Livewire\Component`	`$livewire`	The Livewire component instance.
Eloquent record	`?Illuminate\Database\Eloquent\Model`	`$record`	The Eloquent record for the current table row.
Row loop	`stdClass`	`$rowLoop`	The row loop object for the current table row.
State	`mixed`	`$state`	The current value of the column, based on the current table row.
Table	`Filament\Tables\Table`	`$table`	The current table instance.

金额格式化

你可以使用 money() 方法以任何货币快速格式化金额值，而不必通过传递函数到 formatStateUsing() 来实现：

use Filament\Tables\Columns\TextColumn;

TextColumn::make('price')
    ->money('EUR')

As well as allowing static values, the money() method also accepts a function to dynamically calculate it. You can inject various utilities into the function as parameters.

Learn more about utility injection.

Utility	Type	Parameter	Description
Column	`Filament\Tables\Columns\Column`	`$column`	The current column instance.
Livewire	`Livewire\Component`	`$livewire`	The Livewire component instance.
Eloquent record	`?Illuminate\Database\Eloquent\Model`	`$record`	The Eloquent record for the current table row.
Row loop	`stdClass`	`$rowLoop`	The row loop object for the current table row.
State	`mixed`	`$state`	The current value of the column, based on the current table row.
Table	`Filament\Tables\Table`	`$table`	The current table instance.

money() 有一个 divideBy 参数，它允许你在格式化之前将原始值除以某个数字。这对在数据库中将价格存储为分(cent)非常有用，比如：

use Filament\Tables\Columns\TextColumn;

TextColumn::make('price')
    ->money('EUR', divideBy: 100)

As well as allowing static values, the divideBy argument also accepts a function to dynamically calculate it. You can inject various utilities into the function as parameters.

Learn more about utility injection.

Utility	Type	Parameter	Description
Column	`Filament\Tables\Columns\Column`	`$column`	The current column instance.
Livewire	`Livewire\Component`	`$livewire`	The Livewire component instance.
Eloquent record	`?Illuminate\Database\Eloquent\Model`	`$record`	The Eloquent record for the current table row.
Row loop	`stdClass`	`$rowLoop`	The row loop object for the current table row.
State	`mixed`	`$state`	The current value of the column, based on the current table row.
Table	`Filament\Tables\Table`	`$table`	The current table instance.

默认情况下，应用会使用本地化语言格式化数字。如果你想自定义使用的本地语言，可以将其传递给 locale 参数：

use Filament\Tables\Columns\TextColumn;

TextColumn::make('price')
    ->money('EUR', locale: 'nl')

As well as allowing static values, the locale argument also accepts a function to dynamically calculate it. You can inject various utilities into the function as parameters.

Learn more about utility injection.

Utility	Type	Parameter	Description
Column	`Filament\Tables\Columns\Column`	`$column`	The current column instance.
Livewire	`Livewire\Component`	`$livewire`	The Livewire component instance.
Eloquent record	`?Illuminate\Database\Eloquent\Model`	`$record`	The Eloquent record for the current table row.
Row loop	`stdClass`	`$rowLoop`	The row loop object for the current table row.
State	`mixed`	`$state`	The current value of the column, based on the current table row.
Table	`Filament\Tables\Table`	`$table`	The current table instance.

如果你想要自定义用于格式化数字的小数点后位数，你可以使用 decimalPlaces 参数：

use Filament\Tables\Columns\TextColumn;

TextColumn::make('price')
    ->money('EUR', decimalPlaces: 3)

As well as allowing static values, the decimalPlaces argument also accepts a function to dynamically calculate it. You can inject various utilities into the function as parameters.

Learn more about utility injection.

Utility	Type	Parameter	Description
Column	`Filament\Tables\Columns\Column`	`$column`	The current column instance.
Livewire	`Livewire\Component`	`$livewire`	The Livewire component instance.
Eloquent record	`?Illuminate\Database\Eloquent\Model`	`$record`	The Eloquent record for the current table row.
Row loop	`stdClass`	`$rowLoop`	The row loop object for the current table row.
State	`mixed`	`$state`	The current value of the column, based on the current table row.
Table	`Filament\Tables\Table`	`$table`	The current table instance.

渲染 Markdown

如果列中的值是 Markdown 格式，你可以使用 markdown() 进行渲染：

use Filament\Tables\Columns\TextColumn;

TextColumn::make('description')
    ->markdown()

此外，你也可以传入一个布尔值控制该文本是否作为 Markdown 渲染：

use Filament\Tables\Columns\TextColumn;

TextColumn::make('description')
    ->markdown(FeatureFlag::active())

As well as allowing a static value, the markdown() method also accepts a function to dynamically calculate it. You can inject various utilities into the function as parameters.

Learn more about utility injection.

Utility	Type	Parameter	Description
Column	`Filament\Tables\Columns\Column`	`$column`	The current column instance.
Livewire	`Livewire\Component`	`$livewire`	The Livewire component instance.
Eloquent record	`?Illuminate\Database\Eloquent\Model`	`$record`	The Eloquent record for the current table row.
Row loop	`stdClass`	`$rowLoop`	The row loop object for the current table row.
State	`mixed`	`$state`	The current value of the column, based on the current table row.
Table	`Filament\Tables\Table`	`$table`	The current table instance.

渲染 HTML

如果列中的值是 HTML，你可以使用 html() 进行渲染：

use Filament\Tables\Columns\TextColumn;

TextColumn::make('description')
    ->html()

此外，你也可以传入一个布尔值控制该文本是否渲染为 HTML：

use Filament\Tables\Columns\TextColumn;

TextColumn::make('description')
    ->html(FeatureFlag::active())

As well as allowing a static value, the html() method also accepts a function to dynamically calculate it. You can inject various utilities into the function as parameters.

Learn more about utility injection.

Utility	Type	Parameter	Description
Column	`Filament\Tables\Columns\Column`	`$column`	The current column instance.
Livewire	`Livewire\Component`	`$livewire`	The Livewire component instance.
Eloquent record	`?Illuminate\Database\Eloquent\Model`	`$record`	The Eloquent record for the current table row.
Row loop	`stdClass`	`$rowLoop`	The row loop object for the current table row.
State	`mixed`	`$state`	The current value of the column, based on the current table row.
Table	`Filament\Tables\Table`	`$table`	The current table instance.

Rendering raw HTML without sanitization

If you use this method, then the HTML will be sanitized to remove any potentially unsafe content before it is rendered. If you’d like to opt out of this behavior, you can wrap the HTML in an HtmlString object by formatting it:

use Filament\Tables\Columns\TextColumn;
use Illuminate\Support\HtmlString;

TextColumn::make('description')
    ->formatStateUsing(fn (string $state): HtmlString => new HtmlString($state))

NOTE

Be cautious when rendering raw HTML, as it may contain malicious content, which can lead to security vulnerabilities in your app such as cross-site scripting (XSS) attacks. Always ensure that the HTML you are rendering is safe before using this method.

Alternatively, you can return a view() object from the formatStateUsing() method, which will also not be sanitized:

use Filament\Tables\Columns\TextColumn;
use Illuminate\Contracts\View\View;

TextColumn::make('description')
    ->formatStateUsing(fn (string $state): View => view(
        'filament.tables.columns.description-column-content',
        ['state' => $state],
    ))

显示描述

描述用于在列内容上方或下方渲染额外的文本。

使用 description() 方法，你可以在文本列的内容下方显示描述：

use Filament\Tables\Columns\TextColumn;

TextColumn::make('title')
    ->description(fn (Post $record): string => $record->description)

The function passed to description() can inject various utilities as parameters.

Learn more about utility injection.

Utility	Type	Parameter	Description
Column	`Filament\Tables\Columns\Column`	`$column`	The current column instance.
Livewire	`Livewire\Component`	`$livewire`	The Livewire component instance.
Eloquent record	`?Illuminate\Database\Eloquent\Model`	`$record`	The Eloquent record for the current table row.
Row loop	`stdClass`	`$rowLoop`	The row loop object for the current table row.
State	`mixed`	`$state`	The current value of the column, based on the current table row.
Table	`Filament\Tables\Table`	`$table`	The current table instance.

默认情况下，描述显示在主文本下方，不过你也可以使用 above 作为第二个参数将其移到文本上方：

use Filament\Tables\Columns\TextColumn;

TextColumn::make('title')
    ->description(fn (Post $record): string => $record->description, position: 'above')

Text column with description above the content

Listing multiple values

Multiple values can be rendered in a text column if its state is an array. This can happen if you are using an array cast on an Eloquent attribute, an Eloquent relationship with multiple results, or if you have passed an array to the state() method. If there are multiple values inside your text column, they will be comma-separated. You may use the listWithLineBreaks() method to display them on new lines instead:

use Filament\Tables\Columns\TextColumn;

TextColumn::make('authors.name')
    ->listWithLineBreaks()

Optionally, you may pass a boolean value to control if the text should have line breaks between each item or not:

use Filament\Tables\Columns\TextColumn;

TextColumn::make('authors.name')
    ->listWithLineBreaks(FeatureFlag::active())

As well as allowing a static value, the listWithLineBreaks() method also accepts a function to dynamically calculate it. You can inject various utilities into the function as parameters.

Learn more about utility injection.

Utility	Type	Parameter	Description
Column	`Filament\Tables\Columns\Column`	`$column`	The current column instance.
Livewire	`Livewire\Component`	`$livewire`	The Livewire component instance.
Eloquent record	`?Illuminate\Database\Eloquent\Model`	`$record`	The Eloquent record for the current table row.
Row loop	`stdClass`	`$rowLoop`	The row loop object for the current table row.
State	`mixed`	`$state`	The current value of the column, based on the current table row.
Table	`Filament\Tables\Table`	`$table`	The current table instance.

Adding bullet points to the list

You may add a bullet point to each list item using the bulleted() method:

use Filament\Tables\Columns\TextColumn;

TextColumn::make('authors.name')
    ->bulleted()

Optionally, you may pass a boolean value to control if the text should have bullet points or not:

use Filament\Tables\Columns\TextColumn;

TextColumn::make('authors.name')
    ->bulleted(FeatureFlag::active())

As well as allowing a static value, the bulleted() method also accepts a function to dynamically calculate it. You can inject various utilities into the function as parameters.

Learn more about utility injection.

Utility	Type	Parameter	Description
Column	`Filament\Tables\Columns\Column`	`$column`	The current column instance.
Livewire	`Livewire\Component`	`$livewire`	The Livewire component instance.
Eloquent record	`?Illuminate\Database\Eloquent\Model`	`$record`	The Eloquent record for the current table row.
Row loop	`stdClass`	`$rowLoop`	The row loop object for the current table row.
State	`mixed`	`$state`	The current value of the column, based on the current table row.
Table	`Filament\Tables\Table`	`$table`	The current table instance.

Limiting the number of values in the list

You can limit the number of values in the list using the limitList() method:

use Filament\Tables\Columns\TextColumn;

TextColumn::make('authors.name')
    ->listWithLineBreaks()
    ->limitList(3)

As well as allowing a static value, the limitList() method also accepts a function to dynamically calculate it. You can inject various utilities into the function as parameters.

Learn more about utility injection.

Utility	Type	Parameter	Description
Column	`Filament\Tables\Columns\Column`	`$column`	The current column instance.
Livewire	`Livewire\Component`	`$livewire`	The Livewire component instance.
Eloquent record	`?Illuminate\Database\Eloquent\Model`	`$record`	The Eloquent record for the current table row.
Row loop	`stdClass`	`$rowLoop`	The row loop object for the current table row.
State	`mixed`	`$state`	The current value of the column, based on the current table row.
Table	`Filament\Tables\Table`	`$table`	The current table instance.

Expanding the limited list

You can allow the limited items to be expanded and collapsed, using the expandableLimitedList() method:

use Filament\Tables\Columns\TextColumn;

TextColumn::make('authors.name')
    ->listWithLineBreaks()
    ->limitList(3)
    ->expandableLimitedList()

NOTE

This is only a feature for listWithLineBreaks() or bulleted(), where each item is on its own line.

Optionally, you may pass a boolean value to control if the text should be expandable or not:

use Filament\Tables\Columns\TextColumn;

TextColumn::make('authors.name')
    ->listWithLineBreaks()
    ->limitList(3)
    ->expandableLimitedList(FeatureFlag::active())

As well as allowing a static value, the expandableLimitedList() method also accepts a function to dynamically calculate it. You can inject various utilities into the function as parameters.

Learn more about utility injection.

Utility	Type	Parameter	Description
Column	`Filament\Tables\Columns\Column`	`$column`	The current column instance.
Livewire	`Livewire\Component`	`$livewire`	The Livewire component instance.
Eloquent record	`?Illuminate\Database\Eloquent\Model`	`$record`	The Eloquent record for the current table row.
Row loop	`stdClass`	`$rowLoop`	The row loop object for the current table row.
State	`mixed`	`$state`	The current value of the column, based on the current table row.
Table	`Filament\Tables\Table`	`$table`	The current table instance.

将单个值拆分成多个列表项目

If you want to “explode” a text string from your model into multiple list items, you can do so with the separator() method. This is useful for displaying comma-separated tags as badges, for example:

use Filament\Tables\Columns\TextColumn;

TextColumn::make('tags')
    ->badge()
    ->separator(',')

As well as allowing a static value, the separator() method also accepts a function to dynamically calculate it. You can inject various utilities into the function as parameters.

Learn more about utility injection.

Utility	Type	Parameter	Description
Column	`Filament\Tables\Columns\Column`	`$column`	The current column instance.
Livewire	`Livewire\Component`	`$livewire`	The Livewire component instance.
Eloquent record	`?Illuminate\Database\Eloquent\Model`	`$record`	The Eloquent record for the current table row.
Row loop	`stdClass`	`$rowLoop`	The row loop object for the current table row.
State	`mixed`	`$state`	The current value of the column, based on the current table row.
Table	`Filament\Tables\Table`	`$table`	The current table instance.

自定义文本大小

文本列默认使用 small 字体，你可以将其改为 TextColumnSize::ExtraSmall、TextColumnSize::Medium 或 TextColumnSize::Large。

比如，使用 size(TextColumnSize::Large) 你可以让文本变大：

use Filament\Tables\Columns\TextColumn;
use Filament\Support\Enums\TextSize;

TextColumn::make('title')
    ->size(TextSize::Large)

自定义字体粗细

文本列默认使用常规字体，不过你可以将其改为以下选项：FontWeight::Thin、FontWeight::ExtraLight、FontWeight::Light、FontWeight::Medium、FontWeight::SemiBold、FontWeight::Bold、FontWeight::ExtraBold 或 FontWeight::Black。

比如，使用 weight(FontWeight::Bold) 你可以将字体改为粗体：

use Filament\Tables\Columns\TextColumn;
use Filament\Support\Enums\FontWeight;

TextColumn::make('title')
    ->weight(FontWeight::Bold)

As well as allowing a static value, the weight() method also accepts a function to dynamically calculate it. You can inject various utilities into the function as parameters.

Learn more about utility injection.

Utility	Type	Parameter	Description
Column	`Filament\Tables\Columns\Column`	`$column`	The current column instance.
Livewire	`Livewire\Component`	`$livewire`	The Livewire component instance.
Eloquent record	`?Illuminate\Database\Eloquent\Model`	`$record`	The Eloquent record for the current table row.
Row loop	`stdClass`	`$rowLoop`	The row loop object for the current table row.
State	`mixed`	`$state`	The current value of the column, based on the current table row.
Table	`Filament\Tables\Table`	`$table`	The current table instance.

自定义字体系列

你可以将字体改为以下选项：FontFamily::Sans、FontFamily::Serif 或 FontFamily::Mono。

比如，使用 fontFamily(FontFamily::Mono) 你可以将字体改为 Mono：

use Filament\Support\Enums\FontFamily;
use Filament\Tables\Columns\TextColumn;

TextColumn::make('email')
    ->fontFamily(FontFamily::Mono)

As well as allowing a static value, the fontFamily() method also accepts a function to dynamically calculate it. You can inject various utilities into the function as parameters.

Learn more about utility injection.

Utility	Type	Parameter	Description
Column	`Filament\Tables\Columns\Column`	`$column`	The current column instance.
Livewire	`Livewire\Component`	`$livewire`	The Livewire component instance.
Eloquent record	`?Illuminate\Database\Eloquent\Model`	`$record`	The Eloquent record for the current table row.
Row loop	`stdClass`	`$rowLoop`	The row loop object for the current table row.
State	`mixed`	`$state`	The current value of the column, based on the current table row.
Table	`Filament\Tables\Table`	`$table`	The current table instance.

处理长文本

限制文本长度

使用 limit() 方法，你可以限制列值的长度：

use Filament\Tables\Columns\TextColumn;

TextColumn::make('description')
    ->limit(50)

As well as allowing a static value, the limit() method also accepts a function to dynamically calculate it. You can inject various utilities into the function as parameters.

Learn more about utility injection.

Utility	Type	Parameter	Description
Column	`Filament\Tables\Columns\Column`	`$column`	The current column instance.
Livewire	`Livewire\Component`	`$livewire`	The Livewire component instance.
Eloquent record	`?Illuminate\Database\Eloquent\Model`	`$record`	The Eloquent record for the current table row.
Row loop	`stdClass`	`$rowLoop`	The row loop object for the current table row.
State	`mixed`	`$state`	The current value of the column, based on the current table row.
Table	`Filament\Tables\Table`	`$table`	The current table instance.

默认情况下，当文本被截断时，省略号(...)会附加到文本末尾。你可以通过向 end 参数传递自定义字符串来对此进行自定义：

use Filament\Tables\Columns\TextColumn;

TextColumn::make('description')
    ->limit(50, end: ' (more)')

As well as allowing a static value, the end argument also accepts a function to dynamically calculate it. You can inject various utilities into the function as parameters.

Learn more about utility injection.

Utility	Type	Parameter	Description
Column	`Filament\Tables\Columns\Column`	`$column`	The current column instance.
Livewire	`Livewire\Component`	`$livewire`	The Livewire component instance.
Eloquent record	`?Illuminate\Database\Eloquent\Model`	`$record`	The Eloquent record for the current table row.
Row loop	`stdClass`	`$rowLoop`	The row loop object for the current table row.
State	`mixed`	`$state`	The current value of the column, based on the current table row.
Table	`Filament\Tables\Table`	`$table`	The current table instance.

通过使用 getCharacterLimit() 方法获取，你还可以在函数中重用传入到 limit() 中的值：

use Filament\Tables\Columns\TextColumn;

TextColumn::make('description')
    ->limit(50)
    ->tooltip(function (TextColumn $column): ?string {
        $state = $column->getState();

        if (strlen($state) <= $column->getCharacterLimit()) {
            return null;
        }

        // Only render the tooltip if the column contents exceeds the length limit.
        return $state;
    })

限制字符数

使用 words() 方法，你可以限制显示在列中的字数：:

use Filament\Tables\Columns\TextColumn;

TextColumn::make('description')
    ->words(10)

As well as allowing a static value, the words() method also accepts a function to dynamically calculate it. You can inject various utilities into the function as parameters.

Learn more about utility injection.

Utility	Type	Parameter	Description
Column	`Filament\Tables\Columns\Column`	`$column`	The current column instance.
Livewire	`Livewire\Component`	`$livewire`	The Livewire component instance.
Eloquent record	`?Illuminate\Database\Eloquent\Model`	`$record`	The Eloquent record for the current table row.
Row loop	`stdClass`	`$rowLoop`	The row loop object for the current table row.
State	`mixed`	`$state`	The current value of the column, based on the current table row.
Table	`Filament\Tables\Table`	`$table`	The current table instance.

默认情况下，当文本被截断时，省略号(...)会附加到文本末尾。你可以通过向 end 参数传递自定义字符串来对此进行自定义：

use Filament\Tables\Columns\TextColumn;

TextColumn::make('description')
    ->words(10, end: ' (more)')

As well as allowing a static value, the end argument also accepts a function to dynamically calculate it. You can inject various utilities into the function as parameters.

Learn more about utility injection.

Utility	Type	Parameter	Description
Column	`Filament\Tables\Columns\Column`	`$column`	The current column instance.
Livewire	`Livewire\Component`	`$livewire`	The Livewire component instance.
Eloquent record	`?Illuminate\Database\Eloquent\Model`	`$record`	The Eloquent record for the current table row.
Row loop	`stdClass`	`$rowLoop`	The row loop object for the current table row.
State	`mixed`	`$state`	The current value of the column, based on the current table row.
Table	`Filament\Tables\Table`	`$table`	The current table instance.

Allowing text wrapping

By default, text will not wrap to the next line if it exceeds the width of the container. You can enable this behavior using the wrap() method:

use Filament\Tables\Columns\TextColumn;

TextColumn::make('description')
    ->wrap()

Optionally, you may pass a boolean value to control if the text should wrap or not:

use Filament\Tables\Columns\TextColumn;

TextColumn::make('description')
    ->wrap(FeatureFlag::active())

As well as allowing a static value, the wrap() method also accepts a function to dynamically calculate it. You can inject various utilities into the function as parameters.

Learn more about utility injection.

Utility	Type	Parameter	Description
Column	`Filament\Tables\Columns\Column`	`$column`	The current column instance.
Livewire	`Livewire\Component`	`$livewire`	The Livewire component instance.
Eloquent record	`?Illuminate\Database\Eloquent\Model`	`$record`	The Eloquent record for the current table row.
Row loop	`stdClass`	`$rowLoop`	The row loop object for the current table row.
State	`mixed`	`$state`	The current value of the column, based on the current table row.
Table	`Filament\Tables\Table`	`$table`	The current table instance.

将文本限制为指定行数

你可以将文本限制到指定的行数，而不是限制成固定长度。将文本行数锁定到指定行数在响应式界面中很有用，这样可以确保在所有屏幕中都有一致性体验。使用 lineClamp() 方法可以实现此效果：

use Filament\Tables\Columns\TextColumn;

TextColumn::make('description')
    ->wrap()
    ->lineClamp(2)

As well as allowing a static value, the lineClamp() method also accepts a function to dynamically calculate it. You can inject various utilities into the function as parameters.

Learn more about utility injection.

Utility	Type	Parameter	Description
Column	`Filament\Tables\Columns\Column`	`$column`	The current column instance.
Livewire	`Livewire\Component`	`$livewire`	The Livewire component instance.
Eloquent record	`?Illuminate\Database\Eloquent\Model`	`$record`	The Eloquent record for the current table row.
Row loop	`stdClass`	`$rowLoop`	The row loop object for the current table row.
State	`mixed`	`$state`	The current value of the column, based on the current table row.
Table	`Filament\Tables\Table`	`$table`	The current table instance.

允许将文本复制到剪贴板

你可以让文本变为可复制，这样在点击列后，文本将会复制到剪切板，同时可以指定自定义确认消息以及消息的展示间隔(以毫秒计)：

use Filament\Tables\Columns\TextColumn;

TextColumn::make('email')
    ->copyable()
    ->copyMessage('Email address copied')
    ->copyMessageDuration(1500)

或者，你也可以传入布尔值以控制文本是否可复制：

use Filament\Tables\Columns\TextColumn;

TextColumn::make('email')
    ->copyable(FeatureFlag::active())

As well as allowing static values, the copyable(), copyMessage(), and copyMessageDuration() methods also accept functions to dynamically calculate them. You can inject various utilities into the function as parameters.

Learn more about utility injection.

Utility	Type	Parameter	Description
Column	`Filament\Tables\Columns\Column`	`$column`	The current column instance.
Livewire	`Livewire\Component`	`$livewire`	The Livewire component instance.
Eloquent record	`?Illuminate\Database\Eloquent\Model`	`$record`	The Eloquent record for the current table row.
Row loop	`stdClass`	`$rowLoop`	The row loop object for the current table row.
State	`mixed`	`$state`	The current value of the column, based on the current table row.
Table	`Filament\Tables\Table`	`$table`	The current table instance.

NOTE

此特性只有在应用启用时有效。

Edit on GitHub

Still need help? Join our Discord community or open a GitHub discussion

#简介

#自定义颜色

#添加图标

#显示为”徽章”

#格式化

#日期格式化

#Date formatting using Carbon macro formats

#相对日期格式化

#Displaying a formatting date in a tooltip

#为日期格式化设置时区

#数字格式化

#金额格式化

#渲染 Markdown

#渲染 HTML

#Rendering raw HTML without sanitization

#显示描述

#Listing multiple values

#Adding bullet points to the list

#Limiting the number of values in the list

#Expanding the limited list

#将单个值拆分成多个列表项目

#自定义文本大小

#自定义字体粗细

#自定义字体系列

#处理长文本

#限制文本长度

#限制字符数

#Allowing text wrapping

#将文本限制为指定行数

#允许将文本复制到剪贴板

简介

自定义颜色

添加图标

显示为”徽章”

格式化

日期格式化

Date formatting using Carbon macro formats

相对日期格式化

Displaying a formatting date in a tooltip

为日期格式化设置时区

数字格式化

金额格式化

渲染 Markdown

渲染 HTML

Rendering raw HTML without sanitization

显示描述

Listing multiple values

Adding bullet points to the list

Limiting the number of values in the list

Expanding the limited list

将单个值拆分成多个列表项目

自定义文本大小

自定义字体粗细

自定义字体系列

处理长文本

限制文本长度

限制字符数

Allowing text wrapping

将文本限制为指定行数

允许将文本复制到剪贴板