v2

tomatophp · Oct 26, 2024 · dc7833e · dc7833e
1 parent 0e56502
commit dc7833e
Showing 1 changed file with 133 additions and 58 deletions.
diff --git a/README.md b/README.md
@@ -34,6 +34,11 @@ Finally register the plugin on `/app/Providers/Filament/AdminPanelProvider.php`
 $panel->plugin(\TomatoPHP\FilamentTranslations\FilamentTranslationsPlugin::make())
 ```
 
+## Extensions
+
+- [Filament ChatGPT Auto Translation](https://www.github.com/tomatophp/filament-translations-gpt)
+- [Filament Google Translations Auto Translation](https://www.github.com/tomatophp/filament-translations-google)
+
 ### Allow Create Button to Create New Language
 
 If you want to allow the user to create a new language, you need to add the following to your panel provider:
@@ -50,67 +55,20 @@ If you want to allow the user to clear all translations, you need to add the fol
 $panel->plugin(\TomatoPHP\FilamentTranslations\FilamentTranslationsPlugin::make()->allowClearTranslations())
 ```
 
-### Publish Resource
-
-You can publish the resource to your project using:
-
-```bash
-php artisan vendor:publish --tag="filament-translations-migrations"
-```
-
-If you need to publish config run:
-
-```bash
-php artisan vendor:publish --tag="filament-translations-config"
-```
-
-Run migration:
-
-```bash
-php artisan migrate
-```
-
-and now clear cache running:
-
-```bash
-php artisan optimize:clear
-```
-
-### Publish Assets
-
-You can publish views file by use this command:
-
-```bash
-php artisan vendor:publish --tag="filament-translations-views"
-```
-
-You can publish languages file by use this command:
-
-```bash
-php artisan vendor:publish --tag="filament-translations-lang"
-```
-
-You can publish migrations file by use this command:
-
-```bash
-php artisan vendor:publish --tag="filament-translations-migrations"
-```
-
 ## Use Language Switcher
 
 we move language switcher to another package you can check it [Filament Language Switcher](https://github.com/tomatophp/filament-language-switcher)
 
-## Usage
 
-### Scan Using Command Line
+## Scan Using Command Line
 
 You can scan your project to get all the languages tags and save them to the database
 
 ```bash
 php artisan filament-translations:import
 ```
 
-### Change Scan to work on Queue
+## Change Scan to work on Queue
 
 In your config file just change the `use_queue_on_scan` to `true`
 
@@ -120,7 +78,7 @@ In your config file just change the `use_queue_on_scan` to `true`
 
 ```
 
-### Custom Import Command
+## Custom Import Command
 
 You can create your own command to import the translations, add your custom import class to the config file like this:
 
@@ -130,7 +88,7 @@ You can create your own command to import the translations, add your custom impo
 
 This command will automatically run when you click on the "Scan For New Languages" button in the UI.
 
-### Custom Excel Import
+## Custom Excel Import
 
 You can create your own Excel import to import the translations, add your custom import class to the config file like this:
 
@@ -142,7 +100,7 @@ The import class is based on the Laravel Excel package.
 You can check the documentation [here](https://docs.laravel-excel.com/3.1/imports/).
 This import will automatically run when you click on the "Import" button in the UI.
 
-### Custom Excel Export
+## Custom Excel Export
 
 You can create your own Excel export to export the translations in your own format, add your custom export class to the config file like this:
 
@@ -154,26 +112,143 @@ The export class is based on the Laravel Excel package.
 You can check the documentation [here](https://docs.laravel-excel.com/3.1/imports/).
 This import will automatically run when you click on the "Export" button in the UI.
 
-### Show or hide buttons in the UI
+## Show or hide buttons in the UI
 
 You can show or hide the buttons in the UI by changing the config file. By default, all buttons are shown.
 
 ```php
-    'show_import_button' => true,
-    'show_export_button' => false,
-    'show_scan_button' => false ,
+'show_import_button' => true,
+'show_export_button' => false,
+'show_scan_button' => false ,
 ```
 
-### Custom Resource
+## Custom Resource
 
 You can create your own resource to show the translations in the UI, add your custom resource class to the config file like this:
 
 ```php
-    'translation_resource' => CustomResource::class,
+'translation_resource' => CustomResource::class,
 ```
 
 This is especially useful when you want to have complete control over the UI but still want to use the translations package. Think about implementing a check on user roles when using `shouldRegisterNavigation` in your custom resource.
 
+## Translation Translations Resource Hooks
+
+we have add a lot of hooks to make it easy to attach actions, columns, filters, etc
+
+### Table Columns
+
+```php
+use TomatoPHP\FilamentTranslations\Filament\Resources\TranslationResource\Table\TranslationTable;
+
+public function boot()
+{
+    TranslationTable::register([
+        \Filament\Tables\Columns\TextColumn::make('something')
+    ]);
+}
+```
+
+### Table Actions
+
+```php
+use TomatoPHP\FilamentTranslations\Filament\Resources\TranslationResource\Table\TranslationActions;
+
+public function boot()
+{
+    TranslationActions::register([
+        \Filament\Tables\Actions\ReplicateAction::make()
+    ]);
+}
+```
+
+### Table Filters
+
+```php
+use TomatoPHP\FilamentTranslations\Filament\Resources\TranslationResource\Table\TranslationFilters;
+
+public function boot()
+{
+    TranslationFilters::register([
+        \Filament\Tables\Filters\SelectFilter::make('something')
+    ]);
+}
+```
+
+### Table Bulk Actions
+
+```php
+use TomatoPHP\FilamentTranslations\Filament\Resources\TranslationResource\Table\TranslationBulkActions;
+
+public function boot()
+{
+    TranslationBulkActions::register([
+        \Filament\Tables\BulkActions\DeleteAction::make()
+    ]);
+}
+```
+
+### From Components
+
+```php
+use TomatoPHP\FilamentTranslations\Filament\Resources\TranslationResource\Form\TranslationForm;
+
+public function boot()
+{
+    TranslationForm::register([
+        \Filament\Forms\Components\TextInput::make('something')
+    ]);
+}
+```
+
+### Page Actions
+
+```php
+use TomatoPHP\FilamentTranslations\Filament\Resources\TranslationResource\Actions\ManagePageActions;
+use TomatoPHP\FilamentTranslations\Filament\Resources\TranslationResource\Actions\EditPageActions;
+use TomatoPHP\FilamentTranslations\Filament\Resources\TranslationResource\Actions\ViewPageActions;
+use TomatoPHP\FilamentTranslations\Filament\Resources\TranslationResource\Actions\CreatePageActions;
+
+public function boot()
+{
+    ManagePageActions::register([
+        Filament\Actions\Action::make('action')
+    ]);
+
+    EditPageActions::register([
+        Filament\Actions\Action::make('action')
+    ]);
+
+    ViewPageActions::register([
+        Filament\Actions\Action::make('action')
+    ]);
+
+    CreatePageActions::register([
+        Filament\Actions\Action::make('action')
+    ]);
+}
+```
+
+## Publish Assets
+
+You can publish views file by use this command:
+
+```bash
+php artisan vendor:publish --tag="filament-translations-views"
+```
+
+You can publish languages file by use this command:
+
+```bash
+php artisan vendor:publish --tag="filament-translations-lang"
+```
+
+You can publish migrations file by use this command:
+
+```bash
+php artisan vendor:publish --tag="filament-translations-migrations"
+```
+
 ## Other Filament Packages
 
 Checkout our [Awesome TomatoPHP](https://github.com/tomatophp/awesome)