jacksleight / statamic-miniset
Requires
- statamic/cms: ^4.0|^5.0
README
Miniset
Miniset 允许您创建紧凑的字段集,这些字段集可以组合成一个类的字符串,或者返回一个简单的值数组。
Miniset 包含以下组件
- Miniset
一个通用字段类型,用于创建返回简单值数组的紧凑字段集。 - Miniset 类
一个特定于类的字段类型,用于创建紧凑的字段集,这些字段集可以组合成一个类的字符串,包括变体选项。与 Tailwind CSS 兼容性良好。
安装
您可以在 Statamic 控制面板的“工具 > 扩展”部分搜索此插件,然后单击“安装”,或者从项目根目录运行以下命令
composer require jacksleight/statamic-miniset
创建 Miniset 字段
创建 Miniset 字段并添加嵌套字段。Miniset 旨在用于简单数据(单个或多个标量值)并且仅正式支持以下嵌套字段类型
- 选择(包括多个)
- 按钮组
- 复选框
- 单选按钮
- 文本
- 文本区域
- 切换
- 范围
可以添加其他字段类型,但将不会具有紧凑样式。
Miniset 返回一个简单的值数组,可以完整输出,也可以通过引用其键来输出单个值
{{ my_options | json }} {{ my_options.theme }}
创建 Miniset 类字段
创建 Miniset 类字段并添加嵌套字段和变体。Miniset 类仅支持以下嵌套字段类型
- 选择(包括多个)
- 按钮组
- 复选框
- 单选按钮
- 文本(不兼容
jit_safe
) - 文本区域(不兼容
jit_safe
)
不应添加其他字段类型,可能会引起错误或意外结果。
在添加字段组时将提供变体作为选项。默认情况下,变体键将附加到类值之前,并用冒号分隔
lg / w-32 --> lg:w-32
如果您不使用此约定,可以通过在变体键中包含一个和号来自定义行为。和号将在增强时被类值替换
&@large / width-half --> width-half@large
Miniset 类将返回一个类的单个字符串,可以在 class
属性中输出
<div class="{{ my_classes }}">
与 Tailwind 使用 jit_safe
模式
当使用 Tailwind 时,JIT 编译器会扫描您的内容以查找类,这需要包括用户可能在控制面板中选择的任何类。为了简化此过程,Miniset 具有一个 jit_safe
模式。要启用此模式,请发布配置
php please vendor:publish --tag=statamic-miniset-config
然后打开 config/statamic/miniset.php
并将 jit_safe.enable
选项设置为 true
'jit_safe' => [ 'enable' => true, 'file' => resource_path('css/statamic/miniset_classes.yaml'), ],
启用后,每当您更新蓝图或字段集时,Miniset 将扫描您的字段并将可能的完整类列表保存到 resources/css/statamic/miniset_classes.yaml
然后您可以告诉 Tailwind 在您的 tailwind.config.js
中搜索此文件
content: [ './resources/css/statamic/miniset_classes.yaml', ],
您还可以通过命令行使用 php please miniset:jit-safe-scan
命令手动运行对所有字段集和蓝图的扫描。