README

此包允许您将现有的 Laravel Nova 过滤器广播到指标或自定义卡片。

安装

您可以使用 composer 将此包安装到使用 Nova 的 Laravel 应用中。

composer require DrunkenElf/nova-global-filter

用法

在本例中，我们注册了几个 指标卡片 和带有 日期 过滤器的 全局过滤器：

...
use DrunkenElf\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
      ]),
    ];
  }
  ...
}

现在，任何优化为监听 全局过滤器 的 metric 卡片 或其他卡片都可以使用 GlobalFilterable 特性和调用 $this->globalFiltered($model,$filters) 方法进行过滤。

globalFiltered($model, $filters = []) 方法期望 $model 和 $filters 参数

use DrunkenElf\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($request, 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(),
...

要设置全局过滤器的 标题

...
(new NovaGlobalFilter([
    // Filters
]))->title('Example Title'),
...

要在任何自定义卡片上监听 全局过滤器

...
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" 事件。请确保没有与其他包发生冲突。
此包目前不支持同步索引视图过滤器。因此，全局过滤器中的过滤器不会触发索引视图的 Filter 菜单 中的过滤器更新。
重置 按钮只是简单地重新加载当前页面。背后没有进行任何复杂操作。
如果您愿意支持此包，那么在 Github 上提供您的问题、PR 和想法将非常棒。别忘了为该包 Star。

干杯

用 ❤️ 为开源制作

许可证

MIT 许可证（MIT）。有关更多信息，请参阅许可证文件。

drunken-elf / nova-global-filter

维护者

详细信息

README

安装

用法

注意事项

许可证