codedor/filament-translatable-strings

This package manages translatable strings in Filament.

v1.1.0 2024-08-02 09:36 UTC

Requires

• php: ^8.2
• awcodes/filament-tiptap-editor: ^3.0
• codedor/filament-translatable-tabs: ^1.0
• codedor/laravel-locale-collection: ^1.0
• filament/filament: ^3.0
• illuminate/contracts: ^10.0|^11.0
• maatwebsite/excel: ^3.1
• spatie/laravel-package-tools: ^1.12
• spatie/laravel-translatable: ^6.4

Requires (Dev)

• larastan/larastan: ^2.4
• laravel/pint: ^1.0
• nunomaduro/collision: ^7.0|^8.0
• orchestra/testbench: ^8.0|^9.0
• pestphp/pest: ^2.0
• pestphp/pest-plugin-laravel: ^2.0
• pestphp/pest-plugin-livewire: ^2.0
• phpstan/extension-installer: ^1.1
• phpstan/phpstan-deprecation-rules: ^1.0
• phpstan/phpstan-phpunit: ^1.0

MIT

• laravel
• codedor
• filament-translatable-strings

README

Package to manage the lang files in Filament with import and export actions and a command to find them in your code.

Installation

You can install the package via composer:

composer require codedor/filament-translatable-strings

You can publish and run the migrations with:

php artisan vendor:publish --tag="filament-translatable-strings-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="filament-translatable-strings-config"

This is the contents of the published config file:

return [
    'trans_functions' => [
        '__',
        'trans',
        'trans_choice',
        'Lang::get',
        'Lang::choice',
        '@lang',
        '@choice',
    ],
    'html_trans_functions' => [
        '__html',
    ],
    'exclude_folders' => [
        'storage',
        'node_modules',
        'database',
        'lang',
        'vendor/symfony',
        'tests',
    ],
];

Register the plugin and/or Widget in your Panel provider:

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            \Codedor\TranslatableStrings\TranslatableStringsPlugin::make(),
        ]);
    }

In an effort to align with Filament's theming methodology you will need to use a custom theme to use this plugin.

Note If you have not set up a custom theme and are using a Panel follow the instructions in the Filament Docs first. The following applies to both the Panels Package and the standalone Forms package.

1. Import the plugin's stylesheet (if not already included) into your theme's css file.

@import '../../../../vendor/codedor/filament-translatable-strings/resources/css/plugin.css';

1. Add the plugin's views to your tailwind.config.js file.

content: [
    ...
    './vendor/codedor/filament-translatable-strings/resources/**/*.blade.php',
]

Usage

php artisan translatable-strings:extract-and-parse

Documentation

For the full documentation, check here.

Testing

vendor/bin/pest

Changelog

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

Upgrading

Please see UPGRADING for more information on how to upgrade to a new version.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

If you discover any security-related issues, please email [e-mail] instead of using the issue tracker.

License

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