README

一个简单的PHP库，用于以svg格式显示Github Octicons字体图标。

安装

使用composer进行安装

composer require edwinhoksberg/octicons-php

用法

<?php

use Octicons\Octicon;
use Octicons\Options;

// The shortcut method:
echo Octicon::gear();

// or with options:
echo Octicon::gear([
    'classes' => ['bla', 'test-con'],
    'ratio' => 8
]);


// The extended method:
$octicon = new Octicon();
$icon = $octicon->icon('gear');

echo 'Icon name: '.$icon->getName();     // gear
echo 'Icon width: '.$icon->getWidth();   // 14
echo 'Icon height: '.$icon->getHeight(); // 16
echo 'Icon ratio: '.$icon->getRatio();   // 1

echo $icon->toSvg();

// and with custom options:
$octicon = new Octicon();
$options = new Options();

// add extra css classes:
$options->addClass('background-color');
$options->addClass(['color-blue', 'extra-class']);

// change the icon size:
$options->setRatio(2);

$icon = $octicon->icon('gear', $options);

echo 'Icon width: '.$icon->getWidth();   // 28
echo 'Icon height: '.$icon->getHeight(); // 32

echo $icon->toSvg();

Twig扩展

对于使用Twig模板库的用户，提供了一个简单的twig函数。

Display an icon: {{ octicon("gear") }}

Display an icon with extra css classes: {{ octicon("gear", 'background-red') }}

Display an extra large icon: {{ octicon("gear", '', 2) }}

测试

使用PHPUnit运行单元测试

vendor/bin/phpunit -c phpunit.dist.xml

许可证

MIT

edwinhoksberg / octicons-php

维护者

详细信息

README

安装

用法

Twig扩展

测试

许可证