csoellinger/silverstripe-admin-icons

用于轻松获取 SilverStripe 管理图标名称的小助手类。

安装: 68

依赖: 0

建议者: 0

安全性: 0

星星: 1

关注者: 1

分支: 0

开放问题: 0

类型:silverstripe-vendormodule

v1.12.3 2023-03-09 15:08 UTC

README

用于轻松获取 SilverStripe 管理图标名称的小助手类。

  1. 需求
  2. 安装
  3. 许可证
  4. 文档
    1. Csoellinger\Silverstripe\AdminIcons\AdminIcon
    2. Csoellinger\Silverstripe\AdminIcons\AdminIconCss
    3. Csoellinger\Silverstripe\AdminIcons\AdminIconUnicode
  5. 维护者
  6. 错误追踪
  7. 开发和贡献
    1. (重新)生成类
    2. 图标预览

需求

  • PHP 7.* 或 PHP 8.0
  • SilverStripe ^4
  • SilverStripe Admin ^1

安装

只需使用 composer 安装即可。主版本和次要版本应与 SilverStripe Admin 相等。

composer require csoellinger/silverstripe-admin-icons

许可证

许可证

文档

该软件包为所有图标生成三个类。

Csoellinger\Silverstripe\AdminIcons\AdminIcon

将图标名称作为类常量保存。 源代码

<?php

use Csoellinger\Silverstripe\AdminIcons\AdminIcon;

echo AdminIcon::SEARCH; // Output: search

Csoellinger\Silverstripe\AdminIcons\AdminIconCss

将带有 "font-icon-" 前缀的图标名称作为类常量保存。 源代码

<?php

use Csoellinger\Silverstripe\AdminIcons\AdminIconCss;

echo AdminIconCss::SEARCH; // Output: font-icon-search

Csoellinger\Silverstripe\AdminIcons\AdminIconUnicode

将图标 Unicode 字符作为类常量保存。 源代码

<?php

use Csoellinger\Silverstripe\AdminIcons\AdminIconUnicode;

echo AdminIconUnicode::SEARCH; // Output: s

维护者

错误追踪

错误在存储库的问题部分跟踪。在提交问题之前,请阅读现有问题以确保您的独特性。

如果问题看起来像是一个新的错误

  • 创建一个新的问题
  • 描述重现您的问题所需的步骤,以及预期的结果。单元测试、截图和屏幕录像在这里可能会有所帮助。
  • 尽可能详细地描述您的环境:SilverStripe 版本、浏览器、PHP 版本、操作系统、安装的任何 SilverStripe 模块。

请直接向模块维护者报告安全问题。请勿在错误跟踪器中提交安全问题。

开发和贡献

如果您想为此模块做出贡献,请确保您发起了一个拉取请求,并与模块维护者进行讨论。

(重新)生成类

该软件包提供了一个 composer 脚本,用于处理类生成。它使用 SilverStripe 字体 svg 直接从供应商目录获取所需的图标。要(重新)生成类,请运行以下命令

composer run generate-constant-class

图标预览

包含了一个小脚本,允许您查看所有包含的图标。启动此脚本的最简单方法是运行一个 composer 脚本

composer run serve