toastnz / theme-colours
Silverstripe 主题颜色模块
1.1.4
2023-10-30 05:19 UTC
Requires
README
安装
最简单的方法是使用 composer
composer require toastnz/theme-colours
然后运行 dev/build
。
配置
将以下内容添加到您的 config.yml
中(可选)以在 dev/build 中生成默认颜色:
Toast\ThemeColours\Models: default_colours: - primary: null - secondary: null - black: '000000' - white: 'ffffff'
用法
颜色函数
getColourCustomID()
返回配置文件中设置的 ID,或对于额外的颜色,返回 ID
getColourPaletteID()
返回 getColourCustomID() 和标题的组合,以便可以通过所选颜色调色板的字段值找到数据对象。
getColourClassName()
返回 c-
+ getColourCustomID()
,因此 CSS 类是唯一的。c-
用于表示 colour
并确保类不以数字开头。
getColourBrightness()
返回 dark
或 light
,这取决于颜色的亮度值。
getColourHexCode()
返回颜色的十六进制值
getColourClasses()
将返回 getColourClassName()
和 getColourBrightness()
的组合
辅助函数
Helper::getThemeColourPalette()
用于遍历 $themeColours 并将标题和值添加到 $array 中,以便 ColorPaletteField 使用。
Helper::getThemeColourFromColourPaletteID
用于遍历 $themeColours 并返回与 $colourPaletteID 匹配的对象