schmeits/filament-character-counter

This is a Filament character counter TextField and Textarea form field for Filament v3.2

Fund package maintenance!
schmeits

Installs: 16 306

Dependents: 2

Suggesters: 0

Security: 0

Stars: 20

Watchers: 1

Forks: 5

Open Issues: 0

Language:Blade

1.3.1 2024-07-15 09:55 UTC

This package is auto-updated.

Last update: 2024-10-30 07:16:20 UTC


README

Latest Version on Packagist GitHub Tests Action Status Total Downloads

This is a Filament character counter TextField, Textarea and RichEditor form field for Filament v3.2

example-screenshot.png

Installation

You can install the package via composer:

composer require schmeits/filament-character-counter

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

License

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