fontech/nova-flexible-content

Laravel Nova 的灵活内容与重复字段。

v0.3.0 2020-05-08 04:20 UTC

README

一个简单且完整的 Laravel Nova 灵活字段,非常适合重复和灵活的字段组。

Laravel Nova Flexible Content in action

快速入门

以下是一个非常简短的指南,帮助您尽快开始。请参阅完整的文档https://whitecube.github.io/nova-flexible-content

安装

composer require whitecube/nova-flexible-content

用法

灵活字段允许轻松管理可重复和可排序的字段组。与 Laravel Nova 现有的少数解决方案相比,这个解决方案在这些组内没有对可以使用哪些字段进行限制。这意味着您可以使用所有 Laravel Nova 字段类型,也可以使用任何社区制作的字段。

添加布局

布局代表一组可以在灵活字段内部重复的字段。您可以添加任意多的布局。如果只定义了一个布局,则字段将像简单的重复器一样行为,通过添加更多布局,您将获得灵活内容。这两个概念与Wordpress ACF 插件的同类相似。

您可以使用以下方法在您的灵活字段中添加布局

 addLayout(string $title, string $name, array $fields)

$name参数用于将所选布局存储在字段的值中。请谨慎选择,您可能会用它来识别您应用程序中的布局。

use Whitecube\NovaFlexibleContent\Flexible;

/**
 * Get the fields displayed by the resource.
 *
 * @param  \Illuminate\Http\Request  $request
 * @return array
 */
public function fields(Request $request)
{
    return [
        // ...

        Flexible::make('Content')
            ->addLayout('Simple content section', 'wysiwyg', [
                Text::make('Title'),
                Markdown::make('Content')
            ])
            ->addLayout('Video section', 'video', [
                Text::make('Title'),
                Image::make('Video Thumbnail', 'thumbnail'),
                Text::make('Video ID (YouTube)', 'video'),
                Text::make('Video Caption', 'caption')
            ])
    ];
}

Example of Flexible layouts

自定义按钮标签

您可以通过以下方式更改默认的“添加布局”按钮的文本

Flexible::make('Content')
    ->button('Add something amazing!');

Add something amazing

在视图中使用灵活值

如果您正在使用 Laravel 6 或以下版本,或者不想使用类型转换,请使用具有 HasFlexible 特性的模型上的访问器使用访问器

Laravel 7 带来了自定义类型转换,灵活内容字段是它们完美的用例。字段将它的值存储为一个单独的 JSON 字符串,这意味着这个字符串需要在您的应用程序中使用之前进行解析。这可以通过使用此包中的 FlexibleCast 类来实现

namespace App;

use Illuminate\Database\Eloquent\Model;
use Whitecube\NovaFlexibleContent\Value\FlexibleCast;

class MyModel extends Model
{
    protected $casts = [
        'flexible-content' => FlexibleCast::class
    ];
}

默认情况下,FlexibleCast 类将收集基本的 Layout 实例。如果您想将布局映射到自定义布局实例,这也是可能的。首先,通过运行 php artisan flexible:cast MyFlexibleCast 创建一个自定义灵活类型转换。这将创建位于 App\Casts 目录中的文件。

然后轻松地将您的自定义布局类映射到适当的键

namespace App\Casts;

class MyFlexibleCast extends FlexibleCast
{
    protected $layouts = [
        'wysiwyg' => \App\Nova\Flexible\Layouts\WysiwygLayout::class,
        'video' => \App\Nova\Flexible\Layouts\VideoLayout::class,
    ]
}

如果您需要更多控制,您可以通过覆盖 getLayoutMappings 方法 来代替。

布局集合

FlexibleCast 类型转换和 HasFlexible 特性返回的集合扩展了原始的 Illuminate\Support\Collection。这些自定义布局集合公开了一个 find(string $name) 方法,它返回具有给定布局 $name 的第一个布局。

布局实例

布局是一种某种“虚拟模型”。它们使用 Laravel 的 HasAttributes 特性,这意味着您可以为布局的属性定义访问器和修改器。此外,还可以使用以下方法访问布局的属性

name()

返回布局的名称。

title()

返回布局的标题(如Nova中所示)。

key()

返回布局的唯一键(布局的唯一标识符)。

更进一步

当使用灵活内容字段时,你很快会发现上面描述的基本内容还不够。这就是我们以可扩展的方式开发了该包,使其能够轻松地为字段及其输出添加自定义行为和能力。

自定义布局类

有时,addLayout 定义可能相当长,或者你可能希望它们与其他 Flexible 字段共享。解决这个问题的方法是将你的布局提取到自己的类中。有关更多信息,请参阅文档

预定义预设类

除了可重用的布局类之外,你还可以进一步为你的灵活字段创建 Preset 类。这允许你随时随地重用整个灵活字段。它们还使你的灵活字段更容易动态化,例如,如果你想有条件地添加布局。最重要的是,它们还有清理你的 Nova 资源类的附加好处,如果你的灵活字段有很多 addLayout 定义。有关更多信息,请参阅文档

自定义解析器类

默认情况下,该字段利用模型表上的 JSON 列。在某些情况下,你真的想使用该字段,但出于某种原因,JSON 属性根本不是最佳选择。例如,你可能会想将值存储在另一个表中(这意味着你将使用灵活内容字段而不是传统的 BelongsToMany 或 HasMany 字段)。不用担心,我们为你解决了这个问题!

通过创建自己的解析器类来告诉字段如何存储和检索其内容,该类基本上只包含两个简单的方法:getset。有关更多信息,请参阅文档

与 nova-page 一起使用

也许你听说过我们其他的包之一,nova-page,这是一个 Nova 工具,允许编辑静态页面,如 "关于" 页面(或类似页面)而无需为它单独声明模型。通常,灵活内容字段很有用。不用担心,这两个包可以很好地一起工作!首先创建一个 nova 页面模板,并将一个 灵活内容 添加到模板的字段中。

如文档中所述,你可以在 blade 视图中使用 {{ Page::get('attribute') }} 来访问 nova-page 的静态内容。当你以这种方式请求灵活内容时,它返回一个描述灵活内容的原始 JSON 字符串,这当然不是很实用。相反,你可以在你的页面模板上简单地实现 Whitecube\NovaFlexibleContent\Concerns\HasFlexible 特性,这将暴露 Page::flexible('attribute') 门面方法,并负责灵活内容的转换。

namespace App\Nova\Templates;

// ...
use App\Nova\Templates\Concerns\HasFlexible;

class Home extends Template
{
    use HasFlexible;

    // ...
}

💖 赞助

如果你的生产应用程序依赖于这个包,请考虑赞助我们!这是帮助我们继续做我们热爱的事情:制作优秀的开源软件的最佳方式。

贡献

请随时提出更改建议,要求新功能或自己修复错误。我们确信还有很多可以改进的地方,我们非常愿意合并有用的拉取请求。

谢谢!

用 ❤️ 为开源制作

在Whitecube,我们日常工作中大量使用开源软件。所以,当我们有机会回馈时,我们非常兴奋!

希望您会喜欢我们的小小贡献,如果您在项目中觉得它有用,我们非常乐意听到您的反馈。关注我们的Twitter以获取更多更新!