monorepo/native/wordpress/maple-icons-wp
2026-02-02 14:17:16 -05:00
..
assets initial commit 2026-02-02 14:17:16 -05:00
includes initial commit 2026-02-02 14:17:16 -05:00
languages initial commit 2026-02-02 14:17:16 -05:00
presets initial commit 2026-02-02 14:17:16 -05:00
src initial commit 2026-02-02 14:17:16 -05:00
CLAUDE.MD initial commit 2026-02-02 14:17:16 -05:00
index.php initial commit 2026-02-02 14:17:16 -05:00
maple-icons.php initial commit 2026-02-02 14:17:16 -05:00
readme.txt initial commit 2026-02-02 14:17:16 -05:00
SECURITY.md initial commit 2026-02-02 14:17:16 -05:00
uninstall.php initial commit 2026-02-02 14:17:16 -05:00
WORDPRESS_COMPATIBILITY.md initial commit 2026-02-02 14:17:16 -05:00

=== Maple Icons ===
Contributors: jetrails
Tags: icons, svg, gutenberg, block, heroicons, lucide, feather, phosphor, material
Requires at least: 6.5
Tested up to: 6.7
Stable tag: 1.0.0
Requires PHP: 7.4
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html

Insert beautiful open-source icons into your content with a Gutenberg block. Download icon sets from CDN and serve locally.

== Description ==

Maple Icons provides a simple way to insert high-quality, open-source icons into your WordPress content using the Gutenberg block editor.

= Features =

* **Multiple Icon Sets** - Choose from popular open-source icon libraries:
  * Heroicons (~290 icons) - MIT License
  * Lucide (~1400 icons) - ISC License
  * Feather (~287 icons) - MIT License
  * Phosphor (~1200 icons per style) - MIT License
  * Material Symbols (~400 icons) - Apache 2.0 License

* **Local Storage** - Icons are downloaded from CDN and stored locally in your WordPress installation. No external requests are made when displaying icons on your site.

* **Gutenberg Block** - Easy-to-use block with:
  * Search and filter icons
  * Multiple style variants per set
  * Size control (12px - 256px)
  * Custom icon color
  * Background color
  * Padding and margin controls
  * Stroke width adjustment
  * Drop shadow effect

* **Performance Optimized**
  * Icons are inline SVG - no additional HTTP requests
  * No frontend JavaScript or CSS
  * Works in RSS feeds and email

* **Accessible**
  * Decorative icons automatically hidden from screen readers
  * Optional accessible labels for meaningful icons
  * Follows WCAG guidelines

= How It Works =

1. Go to Settings → Maple Icons
2. Download one or more icon sets
3. Set one icon set as active
4. In the Gutenberg editor, add a "Maple Icon" block
5. Search and select an icon
6. Customize size, color, and other settings

= Icon Storage =

Downloaded icons are stored in `wp-content/maple-icons/`. Each icon set is stored in its own subdirectory with the SVG files organized by style.

= Compatibility =

* WordPress 6.5+
* PHP 7.4+
* WooCommerce (HPOS compatible)
* Works with all properly coded themes
* Compatible with popular page builders that support Gutenberg blocks

== Installation ==

1. Upload the `maple-icons` folder to the `/wp-content/plugins/` directory
2. Activate the plugin through the 'Plugins' menu in WordPress
3. Go to Settings → Maple Icons to download icon sets
4. Start using the "Maple Icon" block in your content

== Frequently Asked Questions ==

= Are the icons free to use? =

Yes! All icon sets included are open-source with permissive licenses (MIT, ISC, or Apache 2.0) that allow commercial use.

= Can I use multiple icon sets? =

You can download multiple icon sets, but only one can be active at a time. The active set is what appears in the Gutenberg block icon picker.

= Where are the icons stored? =

Icons are downloaded from CDN (jsdelivr.net) and stored locally in `wp-content/maple-icons/`. Once downloaded, no external requests are made to display icons.

= How do I change the icon color? =

Icons automatically inherit the text color from your theme. You can also set a custom color in the block settings panel.

= Will icons work in RSS feeds? =

Yes! Icons are saved as inline SVG in your post content, so they work in RSS feeds, email newsletters, and anywhere else your content is displayed.

= What happens if I uninstall the plugin? =

Existing icons in your content will remain as inline SVG. However, you won't be able to add new icons or use the block settings. The downloaded icon files in `wp-content/maple-icons/` will be removed on uninstall.

= Is this plugin GDPR compliant? =

Yes. Maple Icons does not collect any user data, set cookies, or make external requests after icons are downloaded. All icon files are stored locally on your server.

== Screenshots ==

1. Settings page - Download and manage icon sets
2. Icon picker modal in Gutenberg editor
3. Block settings panel with customization options
4. Icon block rendered on the frontend

== Changelog ==

= 1.0.0 =
* Initial release
* Support for Heroicons, Lucide, Feather, Phosphor, and Material Symbols
* Gutenberg block with full customization options
* Local icon storage

== Upgrade Notice ==

= 1.0.0 =
Initial release of Maple Icons.