https://github.com/devzkhalil/laravel-primer-octicons
A Laravel package to integrate GitHub's Octicons into your Laravel project effortlessly. This package allows you to use Octicons directly in your Blade templates with ease.
https://github.com/devzkhalil/laravel-primer-octicons
laravel-octicons laravel-octicons-primer laravel-primer laravel-primer-octicons laravel-svg-icon laravel-svg-icon-package octicons primer
Last synced: about 2 months ago
JSON representation
A Laravel package to integrate GitHub's Octicons into your Laravel project effortlessly. This package allows you to use Octicons directly in your Blade templates with ease.
- Host: GitHub
- URL: https://github.com/devzkhalil/laravel-primer-octicons
- Owner: devzkhalil
- Created: 2024-07-30T14:40:19.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2024-08-02T12:30:41.000Z (9 months ago)
- Last Synced: 2025-02-17T13:53:44.573Z (2 months ago)
- Topics: laravel-octicons, laravel-octicons-primer, laravel-primer, laravel-primer-octicons, laravel-svg-icon, laravel-svg-icon-package, octicons, primer
- Language: Blade
- Homepage: https://primer.style/foundations/icons
- Size: 224 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Laravel Primer Octicons
A Laravel package to integrate GitHub's Octicons into your Laravel project effortlessly. This package allows you to use Octicons directly in your Blade templates with ease.
## About
Octicons are a scalable set of icons handcrafted by GitHub. They are designed to be highly legible, even at small sizes, and are perfect for adding a consistent visual language to your web projects.
GitHub Repository: [primer/octicons](https://github.com/primer/octicons)
Official Site: [Octicons](https://primer.style/octicons)
## Installation
You can install the package via Composer:
```bash
composer require devzkhalil/laravel-primer-octicons
```
## Usage
After installing, you can use the Octicons in your Blade templates like this:
```blade
```
## Icon Sizes and Parameters
In this package:
- GitHub `16px` icons are referred to as `bold`.
- GitHub `24px` icons are referred to as `thin`.
### Component Parameters
**For Bold Icons (16px):**
- `width` is optional; the default size is `16px`.
- `height` is optional; the default size is `16px`.
- `fill` is optional; the default color is `black`.
**For Thin Icons (24px):**
- `width` is optional; the default size is `16px`.
- `height` is optional; the default size is `16px`.
- `fill` is optional; the default color is `black`.
### Finding Icon Names
To find the name of an icon:
1. Visit the official Octicons site: [Octicons](https://primer.style/foundations/icons).
2. Locate and copy the name of your desired icon.
3. Use the icon in your Blade templates with the appropriate size:
For `16px` icons (bold):
```blade
```
For `24px` icons (thin):
```blade
```
## Publish Components
Publish the components file with the following command:
```bash
php artisan vendor:publish --tag=primer-octicons
```