marshmallow / nova-global-filter
此包允许您将现有的Laravel Nova过滤器广播到指标或自定义卡片。
v2.0.0
2022-05-18 10:15 UTC
Requires
- php: ^8.0
- laravel/nova: ^4.0
README
此包允许您将现有的Laravel Nova过滤器发射到指标或自定义卡片。
安装
您可以使用composer将此包安装到使用Nova的Laravel应用程序中
composer require nemrutco/nova-global-filter
使用方法
在本例中,我们注册了一些带有日期过滤器的指标卡片
和全局过滤器
:
... use Nemrutco\NovaGlobalFilter\NovaGlobalFilter; use App\Nova\Filters\Date; class Store extends Resource { ... public function cards(Request $request) { return [ new TotalSales // Value Metric new Orders, // Trend Metric new MostSoldProduct, // Partition Metric // NovaGlobalFilter new NovaGlobalFilter([ new Date, // Date Filter ]), ]; } ... }
现在,任何优化以监听GlobalFilter
的metric cards
或其他卡片都可以使用GlobalFilterable
特质并调用$this->globalFiltered($model,$filters)
方法进行过滤。
globalFiltered($model, $filters = [])
方法期望$model
和$filters
参数
use Nemrutco\NovaGlobalFilter\GlobalFilterable; use App\Nova\Filters\Date; ... class UsersPerDay extends Trend { use GlobalFilterable; public function calculate(NovaRequest $request) { // Filter your model with existing filters $model = $this->globalFiltered(Store::class,[ Date::class // DateFilter ]); // Do your thing with the filtered $model return $this->countByDays($request, $model); } ... }
就是这样。卡片将根据传入的过滤值进行过滤。
如果您希望在初始请求上应用默认值,请确保在您的过滤器中设置默认值
... // set default date public function default() { return Carbon::now(); } ...
要将布局从grid
更改为inline
默认设置为grid
... new NovaGlobalFilter([ // Filters ])->inline(), ...
要启用重置
按钮
... new NovaGlobalFilter([ // Filters ])->resettable(), ...
要添加多个全局过滤器
... new NovaGlobalFilter([ // Filters ])->inline()->resettable(), new NovaGlobalFilter([ // Filters ])->onlyOnDetail(), ...
要在任何自定义卡片
上监听全局过滤器
... created() { Nova.$on("global-filter-changed", filter => { // Do your thing with the changed filter console.log(filter); }); }, ...
要在任何自定义卡片
上请求所有过滤状态
... Nova.$emit("global-filter-request"); ...
要在任何自定义卡片
上请求特定过滤状态
... created() { Nova.$emit("global-filter-request", [ "App\\Nova\\Filters\\DateFilter", "App\\Nova\\Filters\\CountryFilter" ]); }, ...
要在任何自定义卡片
上接收过滤状态
... created() { Nova.$on("global-filter-response", filters => { // Do your thing with the filters console.log(filters); }); }, ...
注意事项
- 此包的基本功能是监听所有分配的过滤器。一旦某个过滤器的值发生变化,它就会以
Nova.$on('global-filter-changed', [changed filter and value])
的形式发出。因此,任何监听此事件的卡片都将接收到过滤器和其值。 - 此包覆盖了Nova的默认
指标卡片
以允许它们监听"global-filter-changed"
事件。请确保没有与其他包发生冲突。 - 此包目前不支持同步索引视图过滤器。因此,全局过滤器中的过滤器不会在索引视图的
过滤器菜单
中的过滤器上触发更新。 重置
按钮仅重新加载当前页面。幕后没有发生任何复杂的事情。- 如果您愿意支持此包,请通过Github提供您的issue、PR和想法将非常棒。别忘了
Star
这个包。
干杯
用❤️为开源制作
许可协议
MIT许可(MIT)。有关更多信息,请参阅许可文件。