Image column

#Overview

Images can be easily displayed within your table:

use Filament\Tables\Columns\ImageColumn;
 
ImageColumn::make('avatar')
use Filament\Tables\Columns\ImageColumn;

ImageColumn::make('avatar')

The column in the database must contain the path to the image, relative to the root directory of its storage disk.

#Managing the image disk

By default, the public disk will be used to retrieve images. You may pass a custom disk name to the disk() method:

use Filament\Tables\Columns\ImageColumn;
 
ImageColumn::make('header_image')
    ->disk('s3')
use Filament\Tables\Columns\ImageColumn;

ImageColumn::make('header_image')
    ->disk('s3')

#Private images

Filament can generate temporary URLs to render private images, you may set the visibility() to private:

use Filament\Tables\Columns\ImageColumn;
 
ImageColumn::make('header_image')
    ->visibility('private')
use Filament\Tables\Columns\ImageColumn;

ImageColumn::make('header_image')
    ->visibility('private')

#Customizing the size

You may customize the image size by passing a width() and height(), or both with size():

use Filament\Tables\Columns\ImageColumn;
 
ImageColumn::make('header_image')
    ->width(200)
 
ImageColumn::make('header_image')
    ->height(50)
 
ImageColumn::make('author.avatar')
    ->size(40)
use Filament\Tables\Columns\ImageColumn;

ImageColumn::make('header_image')
    ->width(200)

ImageColumn::make('header_image')
    ->height(50)

ImageColumn::make('author.avatar')
    ->size(40)

#Square image

You may display the image using a 1:1 aspect ratio:

use Filament\Tables\Columns\ImageColumn;
 
ImageColumn::make('avatar')
    ->square()
use Filament\Tables\Columns\ImageColumn;

ImageColumn::make('avatar')
    ->square()

#Circular image

You may make the image fully rounded, which is useful for rendering avatars:

use Filament\Tables\Columns\ImageColumn;
 
ImageColumn::make('avatar')
    ->circular()
use Filament\Tables\Columns\ImageColumn;

ImageColumn::make('avatar')
    ->circular()

#Adding a default image URL

You can display a placeholder image if one doesn't exist yet, by passing a URL to the defaultImageUrl() method:

use Filament\Tables\Columns\ImageColumn;
 
ImageColumn::make('avatar')
    ->defaultImageUrl(url('/images/placeholder.png'))
use Filament\Tables\Columns\ImageColumn;

ImageColumn::make('avatar')
    ->defaultImageUrl(url('/images/placeholder.png'))

#Stacking images

You may display multiple images as a stack of overlapping images by using stacked():

use Filament\Tables\Columns\ImageColumn;
 
ImageColumn::make('colleagues.avatar')
    ->circular()
    ->stacked()
use Filament\Tables\Columns\ImageColumn;

ImageColumn::make('colleagues.avatar')
    ->circular()
    ->stacked()

#Customizing the stacked ring width

The default ring width is 3, but you may customize it to be from 0 to 8:

ImageColumn::make('colleagues.avatar')
    ->circular()
    ->stacked()
    ->ring(5)
ImageColumn::make('colleagues.avatar')
    ->circular()
    ->stacked()
    ->ring(5)

#Customizing the stacked overlap

The default overlap is 4, but you may customize it to be from 0 to 8:

ImageColumn::make('colleagues.avatar')
    ->circular()
    ->stacked()
    ->overlap(2)
ImageColumn::make('colleagues.avatar')
    ->circular()
    ->stacked()
    ->overlap(2)

#Wrapping multiple images

Images can be set to wrap if they can't fit on one line, by setting wrap():

use Filament\Tables\Columns\ImageColumn;
 
ImageColumn::make('colleagues.avatar')
    ->circular()
    ->stacked()
    ->wrap()
use Filament\Tables\Columns\ImageColumn;

ImageColumn::make('colleagues.avatar')
    ->circular()
    ->stacked()
    ->wrap()

Note: the "width" for wrapping is affected by the column label, so you may need to use a shorter or hidden label to wrap more tightly.

#Setting a limit

You may limit the maximum number of images you want to display by passing limit():

use Filament\Tables\Columns\ImageColumn;
 
ImageColumn::make('colleagues.avatar')
    ->circular()
    ->stacked()
    ->limit(3)
use Filament\Tables\Columns\ImageColumn;

ImageColumn::make('colleagues.avatar')
    ->circular()
    ->stacked()
    ->limit(3)

#Showing the remaining images count

When you set a limit you may also display the count of remaining images by passing limitedRemainingText().

use Filament\Tables\Columns\ImageColumn;
 
ImageColumn::make('colleagues.avatar')
    ->circular()
    ->stacked()
    ->limit(3)
    ->limitedRemainingText()
use Filament\Tables\Columns\ImageColumn;

ImageColumn::make('colleagues.avatar')
    ->circular()
    ->stacked()
    ->limit(3)
    ->limitedRemainingText()

#Showing the limited remaining text separately

By default, limitedRemainingText() will display the count of remaining images as a number stacked on the other images. If you prefer to show the count as a number after the images, you may use the isSeparate: true parameter:

use Filament\Tables\Columns\ImageColumn;
 
ImageColumn::make('colleagues.avatar')
    ->circular()
    ->stacked()
    ->limit(3)
    ->limitedRemainingText(isSeparate: true)
use Filament\Tables\Columns\ImageColumn;

ImageColumn::make('colleagues.avatar')
    ->circular()
    ->stacked()
    ->limit(3)
    ->limitedRemainingText(isSeparate: true)

#Customizing the limited remaining text size

By default, the size of the remaining text is sm. You can customize this to be xs, md or lg using the size parameter:

use Filament\Tables\Columns\ImageColumn;
 
ImageColumn::make('colleagues.avatar')
    ->circular()
    ->stacked()
    ->limit(3)
    ->limitedRemainingText(size: 'lg')
use Filament\Tables\Columns\ImageColumn;

ImageColumn::make('colleagues.avatar')
    ->circular()
    ->stacked()
    ->limit(3)
    ->limitedRemainingText(size: 'lg')

#Custom attributes

You may customize the extra HTML attributes of the image using extraImgAttributes():

use Filament\Tables\Columns\ImageColumn;
 
ImageColumn::make('logo')
    ->extraImgAttributes(['loading' => 'lazy']),
use Filament\Tables\Columns\ImageColumn;

ImageColumn::make('logo')
    ->extraImgAttributes(['loading' => 'lazy']),

You can access the current record using a $record parameter:

use Filament\Tables\Columns\ImageColumn;
 
ImageColumn::make('logo')
    ->extraImgAttributes(fn (Company $record): array => [
        'alt' => "{$record->name} logo",
    ]),
use Filament\Tables\Columns\ImageColumn;

ImageColumn::make('logo')
    ->extraImgAttributes(fn (Company $record): array => [
        'alt' => "{$record->name} logo",
    ]),

#Prevent file existence checks

When the table is loaded, it will automatically detect whether the images exist. This is all done on the backend. When using remote storage with many images, this can be time-consuming. You can use the checkFileExistence(false) method to disable this feature:

use Filament\Tables\Columns\ImageColumn;
 
ImageColumn::make('attachment')
    ->checkFileExistence(false)
use Filament\Tables\Columns\ImageColumn;

ImageColumn::make('attachment')
    ->checkFileExistence(false)

Edit on GitHub

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