laurenttacco / kirby-remixicon
3000+ Remix Icons for the Kirby Panel
Package info
github.com/LaurentTacco/kirby-remixicon
Type:kirby-plugin
pkg:composer/laurenttacco/kirby-remixicon
Requires
- php: >=8.1
- ext-zip: *
- getkirby/composer-installer: ^1.1
README
Use 3000+ Remix Icon icons directly in your Kirby Panel blueprints — pages, sections, tabs, and more.
No icons are shipped with this plugin. They are automatically downloaded from the official Remix Icon repository on first Panel load.
Installation
Composer (recommended)
composer require laurenttacco/kirby-remixicon
That's it. The icons are downloaded automatically the first time you open the Kirby Panel.
Manual (Git)
cd site/plugins
git clone https://github.com/LaurentTacco/kirby-remixicon.git
php site/plugins/kirby-remixicon/update.php
Manual (Download)
- Download and extract the latest release
- Copy the
kirby-remixiconfolder intosite/plugins/ - Run:
php site/plugins/kirby-remixicon/update.php
Usage
Use any Remix Icon name in your blueprints. Each icon comes in two styles:
| Style | Suffix | Example |
|---|---|---|
| Outlined | -line |
home-line |
| Solid | -fill |
home-fill |
Page icon
# site/blueprints/pages/project.yml title: Project icon: folder-3-line
Section icons
# site/blueprints/pages/default.yml sections: gallery: type: pages label: Gallery icon: gallery-view-2 articles: type: pages label: Articles icon: article-line files: type: files label: Documents icon: attachment-line
Tab icons
tabs: content: icon: file-text-line label: Content seo: icon: search-line label: SEO settings: icon: settings-3-line label: Settings
Browse all available icons at remixicon.com.
Updating icons
Run the update script to fetch the latest icons from GitHub:
php site/plugins/kirby-remixicon/update.php
The script compares versions and skips the download if already up to date.
Automate with Composer
Add this to your project's composer.json to update icons on every composer update:
{
"scripts": {
"post-update-cmd": [
"@php site/plugins/kirby-remixicon/update.php"
]
}
}
Version info
The current Remix Icon version is visible in the Kirby Panel under System > kirby-remixicon.
Requirements
- Kirby 4 or 5
- PHP 8.1+ with
zipextension (enabled by default on most hosts)
How it works
- On first Panel load,
index.phpdetects that no icons are present (index.jsis empty) - It downloads the Remix Icon repository as a zip archive
- All SVG paths are extracted and compiled into a single
index.jsfile - Kirby's Panel loads this file and makes every icon available in blueprints
No Node.js, npm, or build step required.
License
- Plugin: MIT
- Remix Icon: Apache 2.0 by Remix Design