handmadeweb/buildamic

Buildamic 是 Statamic 3 的页面构建器插件

dev-main 2023-08-03 03:15 UTC

This package is auto-updated.

Last update: 2024-09-10 03:57:29 UTC


README

Latest Version on Packagist Total Downloads MIT Licensed Run Tests

Buildamic 是 Statamic 3 的 WIP "页面构建器",目前处于开发阶段,可能频繁出现重大更改,因此不建议在生产环境中使用。

这是一个测试版

请注意,目前不建议在生产环境中使用此插件。

需求

  • PHP 8.0 或更高版本
  • Statamic 3.2 或更高版本
  • Laravel 8.0 或更高版本

安装

您可以通过 composer 安装此软件包

composer require handmadeweb/buildamic

用法

后端

添加到蓝图

将字段添加到您的蓝图,然后您可以选择 Buildamic 可以使用的字段或集合。

字段/字段集/集合显示名称

Buildamic 将显示第一个可用的字段的 "标签"。

  • 管理员标签(在 "字段" 的选项区域中找到)
  • 显示(在蓝图上配置)
  • 处理(在蓝图上配置)

前端

网格

Buildamic 包含一个网格起始点(假设您正在使用 TailWind),如果您不会编写自己的网格,则应通过提供的 Antlers 辅助器将 Buildamic 的网格样式包含在您的标题中: {{ buildamicStyles }},Blade: @buildamicStyles 或 PHP: echo BuildamicHelper()->styles();

输出

在前端输出非常简单,您只需使用在蓝图配置时分配给字段的处理程序。并参考以下两个示例,了解如何在 Antlers 或 Blade 中渲染输出。

Statamic 会自动将处理程序转换为 \Statamic\Fields\Value 的实例,并会自动通过 __toString 方法进行渲染。

默认情况下,处理程序将是 "buildamic"。

Antlers 输出

// The easy way
{{ buildamic }}

Blade 输出

如果您使用 Blade,我们建议使用以下 "我们推荐的方式",这稍微快一些,并且如果您选择运行代码分析器(例如: blackfire.io)将显示更完整的结果。

// The easy way
{!! $buildamic !!}

// Our perferred way.
{!! $buildamic->value()->render() !!}

视图引擎和视图覆盖

目前 Buildamic 只包含用 Blade 编写的视图文件。如果您的前端使用 Antlers,Buildamic 仍然可以工作,只是当 Buildamic 循环和渲染字段时,将使用 Blade。

如果您需要覆盖给定的视图(或创建新的视图),可以在 resources/views/vendor/buildamic 创建视图。

字段视图顺序

当 Buildamic 尝试渲染字段时,它将使用以下顺序中可用的第一个文件。

  • 字段类型:markdown
  • 字段处理程序:hero-blurb
  • 加载的文件:fields/markdown-hero-blurb.blade.php

然后

  • 字段类型:markdown
  • 加载的文件:fields/markdown.blade.php

然后

  • 全部捕获
  • 加载的文件:default-field.blade.php

如果在找不到合适的视图时发生错误或记录异常,则将显示类似以下内容的 HTML 注释。

<!-- Field could not be rendered, View not found -->
<!-- Type: bard -->
<!-- Handle: heading -->

字段集视图顺序

当 Buildamic 尝试渲染字段集时,它将首先尝试找到与字段集处理程序匹配的视图。

  • 处理程序:blurb
  • 加载的文件:fieldsets/blurb.blade.php

如果没有找到合适的视图,Buildamic 将会遍历字段集中的每个字段,并将它们作为单独的字段处理,此时将应用字段的视图顺序。

设置视图顺序

当 Buildamic 尝试渲染一组内容时,它将首先尝试找到与组句柄匹配的视图。

  • 处理程序:blurb
  • 加载的文件:sets/blurb.blade.php

如果没有找到合适的视图,Buildamic 将会遍历组内的每个字段,并将它们作为单独的字段处理,此时将应用字段的视图顺序。

更新日志

请参阅 更新日志 了解最近发生了哪些变化。

贡献

请参阅 贡献指南 获取详细信息。

致谢

许可证

MIT 许可证 (MIT)。请参阅 许可证文件 了解更多信息。