giantpeach / blocks
v1.0.14
2024-02-08 14:33 UTC
Requires
- giantpeach/twiglet: ^1.0
README
描述
该软件包旨在简化在Wordpress中创建和使用块。它是作为Peach Schnapps框架的一部分设计和包含的。
它可以独立使用,但设计用于与框架中的其他软件包一起工作。
该软件包的更新和更改由我们工作的项目及其需求决定,它们可能不一定是向下兼容的。
安装
composer require giantpeach/blocks
使用方法
该软件包包含几个可以扩展以创建自定义块的类。
Block
类提供了一些方法来简化块创建和使用,并隐藏了复杂性(块注册、模板加载等),这样您的扩展类就可以专注于块的功能。
Blocks
类处理所有块的实际注册以及它们使用的特性。通常,您会在此类中扩展并添加您的块。
快速入门
一旦扩展了 Blocks
类,它将注册一个 WP CLI 命令以创建新的块。您可以使用它来创建一个新的块
wp giantpeach create-block MyBlock [--prose] [--spacing]
此命令将在您的主题中创建一个新的块,包括块控制器类、块 json 和 twig 模板。
可选地,您可以指定块是否应使用 Prose 或 Spacing 特性。
特性
该软件包包含一些特性,可用于向您的块添加功能。这些是:
Prose
- 添加prose
并创建一些 ACF 字段以用于块以修改prose
样式Spacing
- 向块包装器添加spacing
类,并创建一些 ACF 字段以用于块以修改spacing
样式。这些spacing
类基于 Tailwind CSS 空间类,并且可以在Block
中通过设置$blockSpacing
数组来覆盖。
附加类
该软件包还包含一些可以帮助您使用块的附加类
Classes
- 一个用于创建用于您的块的类的类。此类用于创建用于prose
和spacing
特性的类,但也可以用于创建用于任何其他目的的类。Style
- 一个用于处理您的块的行内样式的类。样式标签将自动添加到文档的头部。
许可
该软件包是开源的,并使用 MIT 许可证。