|
1 | 1 | # Icon Manager for Craft CMS |
2 | 2 |
|
| 3 | +[](https://packagist.org/packages/lindemannrock/craft-icon-manager) |
| 4 | +[](https://craftcms.com/) |
| 5 | +[](https://php.net/) |
| 6 | +[](https://github.com/LindemannRock/craft-logging-library) |
| 7 | +[](LICENSE) |
| 8 | + |
3 | 9 | A comprehensive icon management field supporting SVG libraries and icon fonts for Craft CMS 5.x. |
4 | 10 |
|
5 | 11 | ## Table of Contents |
6 | 12 |
|
7 | | -- [Quick Start](#quick-start) |
8 | | -- [Features](#features) |
9 | | -- [Development Status](#development-status) |
10 | | -- [Requirements](#requirements) |
11 | | -- [Installation](#installation) |
12 | | -- [Configuration](#configuration) |
13 | | - - [Plugin Settings](#plugin-settings) |
14 | | - - [Config File](#config-file) |
15 | | - - [Scan Control Settings](#scan-control-settings) |
16 | | - - [Creating Icon Sets](#creating-icon-sets) |
17 | | -- [Usage](#usage) |
18 | | - - [Field Type](#field-type) |
19 | | - - [Template Variables](#template-variables) |
20 | | - - [Rendering Options](#rendering-options) |
21 | | -- [Icon Metadata](#icon-metadata) |
22 | | -- [Security](#security) |
23 | | -- [Field Settings](#field-settings) |
24 | | -- [Caching](#caching) |
25 | | -- [Logging](#logging) |
26 | | -- [Environment-Specific Paths](#environment-specific-paths) |
27 | | -- [SVG Optimization](#svg-optimization) |
28 | | - - [Issue Detection](#issue-detection) |
29 | | - - [PHP Optimizer](#php-optimizer-default) |
30 | | - - [SVGO](#svgo-advanced) |
31 | | - - [Scan Controls vs SVGO Configuration](#scan-controls-vs-svgo-configuration) |
32 | | -- [Performance Tips](#performance-tips) |
33 | | -- [Troubleshooting](#troubleshooting) |
34 | | -- [Examples](#examples) |
35 | | -- [Support](#support) |
36 | | -- [License](#license) |
| 13 | +- [Icon Manager for Craft CMS](#icon-manager-for-craft-cms) |
| 14 | + - [Table of Contents](#table-of-contents) |
| 15 | + - [Quick Start](#quick-start) |
| 16 | + - [Features](#features) |
| 17 | + - [Development Status](#development-status) |
| 18 | + - [Requirements](#requirements) |
| 19 | + - [Installation](#installation) |
| 20 | + - [Via Composer](#via-composer) |
| 21 | + - [Using DDEV](#using-ddev) |
| 22 | + - [Via Control Panel](#via-control-panel) |
| 23 | + - [Configuration](#configuration) |
| 24 | + - [Plugin Settings](#plugin-settings) |
| 25 | + - [Config File](#config-file) |
| 26 | + - [Available Configuration Options](#available-configuration-options) |
| 27 | + - [Scan Control Settings](#scan-control-settings) |
| 28 | + - [Creating Icon Sets](#creating-icon-sets) |
| 29 | + - [SVG Folder](#svg-folder) |
| 30 | + - [SVG Sprite](#svg-sprite) |
| 31 | + - [Font Awesome](#font-awesome) |
| 32 | + - [Material Icons](#material-icons) |
| 33 | + - [Web Font](#web-font) |
| 34 | + - [Usage](#usage) |
| 35 | + - [Field Type](#field-type) |
| 36 | + - [Template Variables](#template-variables) |
| 37 | + - [Basic Icon Rendering](#basic-icon-rendering) |
| 38 | + - [Working with Icon Objects](#working-with-icon-objects) |
| 39 | + - [List Icons from a Set](#list-icons-from-a-set) |
| 40 | + - [Search Icons](#search-icons) |
| 41 | + - [Working with Icon Sets](#working-with-icon-sets) |
| 42 | + - [Rendering Options](#rendering-options) |
| 43 | + - [Icon Metadata](#icon-metadata) |
| 44 | + - [Basic Structure](#basic-structure) |
| 45 | + - [Advanced Structure with Multilingual Support](#advanced-structure-with-multilingual-support) |
| 46 | + - [Label Resolution Priority](#label-resolution-priority) |
| 47 | + - [Supported Metadata Properties](#supported-metadata-properties) |
| 48 | + - [Security](#security) |
| 49 | + - [Automatic Sanitization](#automatic-sanitization) |
| 50 | + - [How It Works](#how-it-works) |
| 51 | + - [What's Not Sanitized](#whats-not-sanitized) |
| 52 | + - [Template Safety](#template-safety) |
| 53 | + - [Field Settings](#field-settings) |
| 54 | + - [Icon Size](#icon-size) |
| 55 | + - [Show Labels](#show-labels) |
| 56 | + - [Enable Search](#enable-search) |
| 57 | + - [Caching](#caching) |
| 58 | + - [Configuration](#configuration-1) |
| 59 | + - [Cache Management](#cache-management) |
| 60 | + - [Logging](#logging) |
| 61 | + - [Environment-Specific Paths](#environment-specific-paths) |
| 62 | + - [SVG Optimization](#svg-optimization) |
| 63 | + - [Enabling/Disabling Optimization](#enablingdisabling-optimization) |
| 64 | + - [Optimization Features](#optimization-features) |
| 65 | + - [Issue Detection](#issue-detection) |
| 66 | + - [PHP Optimizer (Default)](#php-optimizer-default) |
| 67 | + - [SVGO (Advanced)](#svgo-advanced) |
| 68 | + - [Scan Controls vs SVGO Configuration](#scan-controls-vs-svgo-configuration) |
| 69 | + - [Missing Icon Handling](#missing-icon-handling) |
| 70 | + - [Performance Tips](#performance-tips) |
| 71 | + - [For Large Icon Sets (500+ icons)](#for-large-icon-sets-500-icons) |
| 72 | + - [For Material Icons](#for-material-icons) |
| 73 | + - [Cache Strategy by Environment](#cache-strategy-by-environment) |
| 74 | + - [Troubleshooting](#troubleshooting) |
| 75 | + - [Icons Not Showing in Picker](#icons-not-showing-in-picker) |
| 76 | + - [Icons Not Rendering in Templates](#icons-not-rendering-in-templates) |
| 77 | + - [Optimization Not Working](#optimization-not-working) |
| 78 | + - [Performance Issues with Large Icon Sets](#performance-issues-with-large-icon-sets) |
| 79 | + - [Config File Not Working](#config-file-not-working) |
| 80 | + - [Examples](#examples) |
| 81 | + - [Support](#support) |
| 82 | + - [License](#license) |
37 | 83 |
|
38 | 84 | ## Quick Start |
39 | 85 |
|
@@ -85,6 +131,7 @@ SVG folder icons are fully stable and production-ready. |
85 | 131 |
|
86 | 132 | - Craft CMS 5.0 or greater |
87 | 133 | - PHP 8.3 or greater |
| 134 | +- [Logging Library](https://github.com/LindemannRock/craft-logging-library) 5.0 or greater (installed automatically as dependency) |
88 | 135 |
|
89 | 136 | ## Installation |
90 | 137 |
|
|
0 commit comments