Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/outl1ne/nova-translatable
A Laravel Nova package that allows you to make any input field translatable.
https://github.com/outl1ne/nova-translatable
Last synced: about 1 hour ago
JSON representation
A Laravel Nova package that allows you to make any input field translatable.
- Host: GitHub
- URL: https://github.com/outl1ne/nova-translatable
- Owner: outl1ne
- License: mit
- Created: 2019-12-20T13:16:37.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-12-18T16:22:38.000Z (2 months ago)
- Last Synced: 2025-02-14T10:56:10.125Z (7 days ago)
- Language: PHP
- Homepage:
- Size: 2.18 MB
- Stars: 201
- Watchers: 7
- Forks: 60
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Nova Translatable
[](https://packagist.org/packages/outl1ne/nova-translatable)
[](https://packagist.org/packages/outl1ne/nova-translatable)
This [Laravel Nova](https://nova.laravel.com) allows you to make any input field `spatie/laravel-translatable` compatible and localisable.
## Requirements
- `PHP: ^8.0`
- `laravel/nova: ^4.12`
- `spatie/laravel-translatable: ^4.0 || ^5.0 || ^6.0`
## Features
- **Supports almost all fields** (including third party ones)
- **Supports default validation automatically**
- **Simple to implement** with minimal code changes (after `spatie/laravel-translatable` support)
- Locale tabs to switch between different locale values of the same field
- **Double click** on a tab to switch all fields to that locale
- Supports [nova-settings](https://github.com/outl1ne/nova-settings) package
## Known non-working fields
- `Image` and `File`
- Workarounds:
- [outl1ne/nova-media-hub](https://github.com/outl1ne/nova-media-hub)
- or any library that uploads images/files using XHR
## Limitations
- The following methods can not be used, as this package uses them internally:
- `resolveUsing`
- `fillUsing`
## Screenshots
## Installation
Firstly, set up [spatie/laravel-translatable](https://github.com/spatie/laravel-translatable).
Install the package in a Laravel Nova project via Composer:
```bash
# Install nova-translatable
composer require outl1ne/nova-translatable
# Publish configuration (optional, but useful for setting default locales)
php artisan vendor:publish --tag="nova-translatable-config"
```
## Usage
Call `->translatable()` on any field, like so:
```php
// Any Nova field
Text::make('Name')
->rules('required', 'min:2')
->translatable(),
// Any third-party input field
Multiselect::make('Football teams')
->rules('required')
->translatable(),
// Optionally pass custom locales on a per-field basis
Number::make('Population')
->translatable([
'en' => 'English',
'et' => 'Estonian',
]),
```
## Validation
It's possible to define locale specific validation rules.
To do so, add the `->rulesFor()` on your field and the `HandlesTranslatable` trait to your Nova resource.
`->rulesFor` accepts `array|string|callable` locales and `array|callable` rules.
```php
use Outl1ne\NovaTranslatable\HandlesTranslatable;
class Product extends Resource
{
use HandlesTranslatable;
public function fields(Request $request)
{
return [
Text::make(__('Name'), 'name')
->sortable()
->translatable()
->rules(['max:255'])
->rulesFor('en', [
'required',
])
->rulesFor(['en', 'et'], function ($locale) {
return ["unique:products,name->$locale{{resourceId}}"];
}),
];
}
}
```
#### In this example, rules will be added to the following values
```dotenv
max: name.*
required: name.en
unique: name.en & name.et
```
## Configuration
You can define default locales for all the `translatable` fields in the config file. The config file can be published using:
```bash
php artisan vendor:publish --tag="nova-translatable-config"
```
### Fill other locales from config option
The configuration option `fill_other_locales_from` allows you to pre-fill other locales from just one locale. This requires the resources to also have the `HandlesTranslatable` trait.
### One select for all fields on a page
If you don't want to display the locale select next to each field, you can set the `display_type` to `none` and add a `Outl1ne\NovaTranslatable\Fields\LocaleSelect` field to your Nova resource. This will render a single select for all fields.
### Custom locale display
To customize the locale display you can use `Nova::provideToScript` to pass `customLocaleDisplay` as in the example below.
```php
// in app/Providers/NovaServiceProvider.php
public function boot()
{
Nova::serving(function () {
Nova::provideToScript([
// ...
'customLocaleDisplay' => [
'en' => 
,
'et' => 
,
]
]);
});
}
```
## Edge cases
#### BelongsToMany allowDuplicateRelations corner-case
When using this field inside a BelongsToMany as a pivot field with `->allowDuplicateRelations()` and you want to filter out exact matches using the `NotExactlyAttached` rule, use the `BelongsToManyTranslatable` field instead of the regular `BelongsToMany`.
## Credits
- [Tarvo Reinpalu](https://github.com/Tarpsvo)
## License
This project is open-sourced software licensed under the [MIT license](LICENSE.md).