kraenkvisuell / nova-settings
一个 Laravel Nova 工具,用于使用原生 Nova 字段编辑自定义设置。
支持包维护!
optimistdigital
Requires
- php: ^8.0.2|^8.1
- laravel/nova: ^4.0
- manogi/nova-translatable: ^2.0
- spatie/laravel-translatable: ^6.0
Requires (Dev)
- orchestra/testbench: ^7.0
- phpunit/phpunit: ^8.0|^9.0
- dev-master
- v5.0.2
- v5.0.1
- v5.0.0
- v4.0.1
- v4.0.0
- 3.5.1
- 3.5.0
- 3.4.0
- 3.3.1
- 3.3.0
- 3.2.3
- 3.2.2
- 3.2.1
- 3.2.0
- 3.1.3
- 3.1.2
- 3.1.1
- 3.1.0
- 3.0.0
- 2.6.2
- 2.6.1
- 2.6.0
- 2.5.8
- 2.5.7
- 2.5.6
- 2.5.5
- 2.5.4
- 2.5.3
- 2.5.2
- 2.5.1
- 2.5.0
- 2.4.3
- 2.4.2
- 2.4.1
- 2.4.0
- 2.3.0
- 2.2.0
- 2.1.1
- 2.1.0
- 2.0.2
- 2.0.1
- 2.0.0
- 1.4.0
- 1.3.0
- 1.2.1
- 1.2.0
- 1.1.0
- 1.0.0
This package is auto-updated.
Last update: 2024-09-06 20:27:02 UTC
README
此 Laravel Nova 包允许您在代码中创建自定义设置(使用 Nova 的原生字段),并为用户创建一个可以编辑设置的 UI。
要求
php: >=7.2
laravel/nova: ^3.0
功能
- 代码中的设置字段管理
- 编辑设置的 UI
- 访问设置的辅助函数
- 规则验证支持
- 支持 eminiarts/nova-tabs
- 支持 nova-translatable 并带有规则验证
截图
安装
通过 Composer 在 Laravel Nova 项目中安装此包,并运行迁移
# Install nova-settings composer require optimistdigital/nova-settings # Run migrations php artisan migrate
在 NovaServiceProvider
的 tools()
方法中注册工具
// in app/Providers/NovaServiceProvider.php public function tools() { return [ // ... new \KraenkVisuell\NovaSettings\NovaSettings ]; }
用法
注册字段
在您的 NovaServiceProvider
的 boot()
函数中通过调用 NovaSettings::addSettingsFields()
定义字段。
// Using an array \KraenkVisuell\NovaSettings\NovaSettings::addSettingsFields([ Text::make('Some setting', 'some_setting'), Number::make('A number', 'a_number'), ]); // OR // Using a callable \KraenkVisuell\NovaSettings\NovaSettings::addSettingsFields(function() { return [ Text::make('Some setting', 'some_setting'), Number::make('A number', 'a_number'), ]; });
注册字段面板
// Using an array \KraenkVisuell\NovaSettings\NovaSettings::addSettingsFields([ Panel::make('Panel Title', [ Text::make('Some setting', 'some_setting'), Number::make('A number', 'a_number'), ]), ]);
类型转换
如果您想对设置的值进行格式化后再返回,请传递一个类似于 Eloquent
的 $casts
属性的数组作为第二个参数。
\KraenkVisuell\NovaSettings\NovaSettings::addSettingsFields([ // ... fields ], [ 'some_boolean_value' => 'boolean', 'some_float' => 'float', 'some_collection' => 'collection', // ... ]);
子页面
将设置页面名称作为第三个参数添加,以在自定义子页面中列出这些设置。
\KraenkVisuell\NovaSettings\NovaSettings::addSettingsFields([ Text::make('Some setting', 'some_setting'), Number::make('A number', 'a_number'), ], [], 'Subpage');
如果您留空自定义名称,字段将列在“常规”下。
要翻译页面名称,发布翻译并将新的键 novaSettings.$subpage
添加到相应的翻译文件中,其中 $subpage
是页面名称(全小写,URL 化)。
授权
显示/隐藏所有设置
如果您想从侧边栏中隐藏整个 Settings
区域,您可以像这样授权 NovaSettings
工具
public function tools(): array { return [ NovaSettings::make()->canSee(fn () => user()->isAdmin()), ]; }
显示/隐藏特定设置字段
如果您只想隐藏一些设置,您可以使用 ->canSee(fn () => ...)
每个字段。如下所示
Text::make('A text field') ->canSee(fn () => user()->isAdmin()),
辅助函数
nova_get_settings($keys = null, $defaults = [])
调用 nova_get_settings()
获取所有设置,格式化为常规数组。此外,您还可以传递一个 key => value
数组作为第二个参数:nova_get_settings(['some_key], ['some_key' => 'default_value'])
。
nova_get_setting($key, $default = null)
要获取单个设置的值,请调用 nova_get_setting('some_setting_key')
。它将返回一个值或 null,如果没有找到具有此类键的设置。
您还可以传递默认值作为第二个参数 nova_get_setting('some_setting_key', 'default_value')
,如果没有找到具有给定键的设置,它将返回。
nova_set_setting_value($key, $value = null)
为给定键设置设置值。
配置
可以使用以下命令发布配置文件
php artisan vendor:publish --provider="KraenkVisuell\NovaSettings\NovaSettingsServiceProvider" --tag="config"
迁移也可以使用以下命令发布和覆盖
php artisan vendor:publish --provider="KraenkVisuell\NovaSettings\NovaSettingsServiceProvider" --tag="migrations"
本地化
可以使用以下命令发布翻译文件
php artisan vendor:publish --provider="KraenkVisuell\NovaSettings\NovaSettingsServiceProvider" --tag="translations"
您可以将您的翻译添加到 resources/lang/vendor/nova-settings/
中,通过创建一个带有区域名称的新翻译文件(例如 et.json
),并从现有的 en.json
复制 JSON。
致谢
许可证
Nova Settings 是开源软件,许可协议为 MIT 许可。