cachethq / badger

Laravel 的徽章生成器。

v3.0.0 2023-08-21 16:12 UTC

This package is auto-updated.

Last update: 2024-09-13 09:51:33 UTC


README

用于 Laravel 的 SVG 徽章生成器。

安装

此版本需要 PHP 8.2 和 Laravel 11.0 及以上版本。对于旧版本的 PHP 或 Laravel,请查看 3.x 分支。

要获取最新版本,只需使用 Composer 引入项目。

composer require cachethq/badger

安装后,如果您不使用自动包发现,则需要将 Cachet\Badger\BadgerServiceProvider 服务提供者在您的 config/app.php 文件中注册。

示例

立即开始

// Using the Facade
Badger::generate('license', 'MIT', 'blue', 'plastic')

// Dependency injection example
$badger->generate('license', 'MIT', '#ff69b4', 'plastic')

用法

generate 方法接受四个参数

Badger::generate('license', 'MIT', 'blue', 'flat-square')

第一个参数是主题,或者徽章显示的内容。在上面的例子中这是许可证。第二个参数是值(徽章的右侧)。接下来是徽章的颜色。这可以是以下预设颜色之一,或者是一个有效的十六进制字符串。

  • brightgreen
  • green
  • yellow
  • yellowgreen
  • orange
  • red
  • blue
  • grey
  • lightgray

最后第四个参数是徽章类型。这决定了徽章的风格,可以是以下四个值之一。

  • flat-square(默认)
  • plastic-flatflat
  • plastic
  • social(无链接)

安全性

如果您在此包中发现安全漏洞,请通过电子邮件发送至 [email protected]。所有安全漏洞都将得到及时处理。

许可证

Cachet Badger 依据 MIT 许可证(MIT) 许可。

基于在 badges/poser 的工作。