ariaieboy/filament-currency

Bring back laravel-money formatter for Filament Text Column

1.10.0 2024-11-03 15:24 UTC

Requires

• php: ~8.1|~8.2|~8.3|~8.4
• akaunting/laravel-money: ^1.2|^2.0|^3.0|^4.0|^5.2
• filament/tables: ^3.0
• illuminate/contracts: ^10.0|^11
• spatie/laravel-package-tools: ^1.15.0

Requires (Dev)

• larastan/larastan: ^2.7.0
• laravel/pint: ^1.0
• nunomaduro/collision: ^7.9
• orchestra/testbench: ^8.0
• pestphp/pest: ^2.0
• pestphp/pest-plugin-arch: ^2.0
• pestphp/pest-plugin-laravel: ^2.0
• phpstan/extension-installer: ^1.1
• phpstan/phpstan-deprecation-rules: ^1.0
• phpstan/phpstan-phpunit: ^1.0

MIT

• AriaieBOY

• laravel
• ariaieboy
• filament-currency

README

Filament V3 unlike V2 that uses laravel-money package for formatting money TextColumns uses PHP native NumberFormatter class.

Text Column (Table Builder)

A new currency(string | Closure $currency = null, bool $shouldConvert = false) method to the TextColumn that uses the Filament V2 money formatter.

Summary (Table Builder)

The summarizer classes Sum and Average contains the method currency(string | Closure $currency = null, bool $shouldConvert = false) to display the value in the configured currency format.

Text Entry (InfoLists)

A new currency(string | Closure $currency = null, bool $shouldConvert = false) method to the TextEntry

Text Input (Form Builder)

We also have a currencyMask() method for TextInput that lets you mask your numbers in front-end and return the plain number to back-end.

Text Input Column (Table Builder)

We also have a currencyMask() method for TextInputColumn that lets you mask your numbers in front-end and return the plain number to back-end.

By using this package you can configure the formatter using laravel-money config.

For example, you can customize the symbol, symbol_first, decimal_mark, and thousands_separator for each currency. Or if you want you can add your custom currency to the config and use it in the currency() method instead of standard money.

Installation

You can install the package via Composer:

composer require ariaieboy/filament-currency

You can publish the laravel-money config file with:

php artisan vendor:publish --tag=money

Usage

\Filament\Tables\Columns\TextColumn::make('money')
    ->currency('USD');

\Filament\Tables\Columns\TextColumn::make('money')
    ->currency('USD')
    ->summarize(\Filament\Tables\Columns\Summarizers\Sum::make()->currency());

\Filament\Tables\Columns\TextColumn::make('money')
    ->currency('USD')
    ->summarize(\Filament\Tables\Columns\Summarizers\Average::make()->currency());

\Filament\Infolists\Components\TextEntry::make('money')
    ->currency('USD');

\Filament\Forms\Components\TextInput::make('money')
    ->currencyMask(thousandSeparator: ',',decimalSeparator: '.',precision: 2)

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

• AriaieBOY
• All Contributors

License

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