yassinedoghri / codeigniter-icons Goto Github PK

View Code? Open in Web Editor NEW

A CodeIgniter4 library with convenient helper functions to render svg icons using https://github.com/yassinedoghri/php-icons.

License: MIT License

PHP 90.37% Dockerfile 9.63%

codeigniter-icons's Introduction

CodeIgniter Icons 🔥 🙂

A CodeIgniter4 library with convenient helper functions to render svg icons using php-icons.

🚀 Getting started

0. Prerequisites

Usage of CodeIgniter Icons requires the following:

A CodeIgniter 4.3.5+ based project
Composer for package management
PHP 8.1+

1. Install via composer

composer require yassinedoghri/codeigniter-icons

2. Setup

init and configure PHPIcons, ie. create the PHPIcons config file.
add icons helper to your app/Config/Autoload.php file:

public $helpers = [/*...other helpers...*/, 'icons'];

3. Usage

Use the icon(string $iconKey) or phpicons(string $iconKey) helpers in your View files to render svg icons:

<?= icon('material-symbols:bolt') ?>
// <svg xmlns="http://www.w3.org/2000/svg" width="1em" height="1em" viewBox="0 0 24 24">
//      <path fill="currentColor" d="m8 22l1-7H4l9-13h2l-1 8h6L10 22z"/>
// </svg>

<?= icon('material-symbols:bolt', ['class' => 'text-2xl', "style" => "color: yellow;"]) ?>
// <svg class="text-2xl" style="color: yellow;" [...]>...</svg>

<?= phpicons('material-symbols:bolt')
        ->attr('class', 'text-2xl')
        ->attr('style', 'color: yellow;') ?>
// <svg class="text-2xl" style="color: yellow;" [...]>...</svg>

For more usage info, see php icons docs.

⚙️ Configuration

Checkout PHPIcons config reference to tweak things as you please.

// new file - app/Config/Iconify.php
<?php

declare(strict_types=1);

namespace Config;

// ...
use CodeIgniterIconify\Config\Iconify as CodeIgniterIconify;

class Iconify extends CodeIgniterIconify
{
    public string $phpIconsConfigPath = ROOTPATH . 'php-icons.php';
}