README

色彩给我留下了深刻的印象，伙伴！

要求

此插件需要Craft CMS 5.0.0或更高版本。

安装

要安装此插件，可以从插件商店安装，或者按照以下说明操作

1. 使用composer从项目目录通过composer require vaersaagod/colormate安装。
2. 在Craft控制面板的设置→插件下安装插件，或者从命令行通过./craft install/plugin colormate安装。

配置

ToolMate通过在Craft配置文件夹中创建一个名为colormate.php的文件来配置，并根据需要配置。示例配置

<?php

return [
    '*' => [
        'presets' => [
            'ctaColors' => [
                'name' => 'CTA Colors',
                'showCustom' => true,
                'showOpacity' => true,
                'showClear' => false,
                'showTooltip' => true,
                'colors' => [
                    'blush' => [
                        'name' => 'Blush',
                        'color' => '#eea8bf'
                    ],
                    'mustard' => [
                        'name' => 'Mustard',
                        'color' => '#ead30a'
                    ],
                    'baby' => [
                        'name' => 'Baby',
                        'color' => '#67cdfc'
                    ],
                    'transred' => [
                        'name' => 'Lorem',
                        'color' => 'rgba(255, 0, 0, 0.4)'
                    ],
                ],
                'default' => 'blush'
            ],

            'overlayColors' => [
                'name' => 'Overlay Colors',
                'showCustom' => false,
                'showOpacity' => false,
                'showClear' => true,
                'colors' => [
                    'black-10p' => [
                        'name' => '10% black',
                        'color' => 'rgba(0, 0, 0, 0.1)',
                    ],
                    'black-20p' => [
                        'name' => '20% black',
                        'color' => 'rgba(0, 0, 0, 0.2)',
                    ],
                    'black-30p' => [
                        'name' => '30% black',
                        'color' => 'rgba(0, 0, 0, 0.3)',
                    ]
                ]
            ]
        ]
    ]
];

字段类型

该字段类型返回一个具有以下属性和方法的Color模型

handle

如果选择的颜色来自预设，则返回预设颜色的句柄。

custom

自定义颜色值。

opacity

不透明度值。

name

如果选择的颜色来自预设，则返回预设颜色的名称。

baseColor

计算出的基础颜色，无论是自定义颜色还是从所选预设颜色中获取的颜色值。

preset

用于字段的预设。

getColor([format = 'rgb'])

返回最终颜色，无论是自定义颜色值还是来自预设，并考虑不透明度。

isCustom()

颜色是否为自定义颜色？

hasTransparency()

最终颜色是否具有透明度？

模板变量/服务方法

以下所有方法都可以作为模板变量使用craft.colormate.<method>(<args>)，也可以作为服务方法使用ColorMate::$plugin->color-><method>(<args>)。

大多数方法都是对[ssnepenthe/color-utils](https://github.com/ssnepenthe/color-utils)的包装，请参阅它以获取更多文档。

getColor(color)

adjustColor(color, adjustment)

getBrightness(color)

getHue(color)

getLightness(color)

isBright(color[, threshold = 127.5])

isLight(color[, threshold = 50])

looksBright(color[, threshold = 127.5])

getPercievedBrightness(color)

getRelativeLuminance(color)

getSaturation(color)

getBrightnessDifference(color1, color2)

getColorDifference(color1, color2)

getContrastRatio(color1, color2)

rgb2hex(color)

hex2rgb(hexValue)

价格、许可证和支持

此插件根据MIT许可证发布。它是为Værsågod和他的朋友们制作的，不提供支持。提交的问题如果能够解决问题，就会得到解决。

变更日志

见CHANGELOG.MD。

鸣谢

由Værsågod提供

图标由Freepik from Flaticon设计。