README

This is a Filament character counter TextField, Textarea and RichEditor form field for Filament v4 and v5.

If you want to use this package with Filament v3.2 see version 1.x.

Installation

Plugin Version	Filament Version	PHP Version
1.x	3.2	> 8.1
4.x	4.x	> 8.2
5.x	4.x - 5.x	> 8.2

You can install the package via composer:

composer require schmeits/filament-character-counter:"^5.0"

Note

For Filament v4 or v5, use version ^5.0

For Filament v3.2, use version ^1.0

You can publish the translations file with:

php artisan vendor:publish --tag="filament-character-counter-translations"

This is the contents of the published translation file:

return [
    'character_seperator' => ' / ',
    'character_label' => 'characters',
];

Usage

use Schmeits\FilamentCharacterCounter\Forms\Components\TextInput;
use Schmeits\FilamentCharacterCounter\Forms\Components\Textarea;

TextInput::make('title')
    ->characterLimit(50),

Textarea::make('description')
    ->characterLimit(155),

RichEditor::make('content')
    ->characterLimit(155),

maxLength can also be used to limit the maximum number of characters, there is no need to specify the characterLimit as well.

TextInput::make('title')
    ->maxLength(50),

As an additional option, you can place the counter within your component using:

TextInput::make('title')
    ->showInsideControl(true)
    ->characterLimit(50),

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

Tally Schmeits
Inspired on the package by Wiebe Nieuwenhuis
All Contributors

License

The MIT License (MIT). Please see License File for more information.

schmeits / filament-character-counter

Maintainers

Details