Skip to content

Commit

Permalink
Version bump and update readmes.
Browse files Browse the repository at this point in the history
  • Loading branch information
ndiego committed Jul 20, 2024
1 parent d0b0722 commit 324b805
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 40 deletions.
35 changes: 16 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

![The Icon Block](https://github.com/ndiego/icon-block/blob/main/_wordpress-org/banner-1544x500.png)

[![Active Installs](https://img.shields.io/wordpress/plugin/installs/icon-block?logo=wordpress&logoColor=%23fff&label=Active%20Installs&labelColor=%230F172A&color=%230F172A)](https://wordpress.org/plugins/social-sharing-block/) [![Playground Demo Link](https://img.shields.io/wordpress/plugin/v/icon-block?logo=wordpress&logoColor=%23fff&label=Playground%20Demo&labelColor=%233858e9&color=%233858e9)](https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/ndiego/icon-block/main/_playground/blueprint.json)
[![Active Installs](https://img.shields.io/wordpress/plugin/installs/icon-block?logo=wordpress&logoColor=%23fff&label=Active%20Installs&labelColor=%2323282dA&color=%2323282dA)](https://wordpress.org/plugins/social-sharing-block/) [![Playground Demo Link](https://img.shields.io/wordpress/plugin/v/icon-block?logo=wordpress&logoColor=%23fff&label=Playground%20Demo&labelColor=%233858e9&color=%233858e9)](https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/ndiego/icon-block/main/_playground/blueprint.json)

The Icon Block plugin registers a single, easy-to-use block that allows you to add custom SVG icons and graphics to the WordPress block editor (Gutenberg). The plugin also includes the complete WordPress icon library with 290+ SVG icons.

### Key Features
### Key features

- 290+ native WordPress icons, including social logos
- Use any custom SVG icon or graphic
Expand All @@ -18,25 +18,9 @@ The Icon Block plugin registers a single, easy-to-use block that allows you to a
- Will get additional functionality as it's added to WordPress core
- Register your own custom icon library. [Learn more](https://nickdiego.com/adding-custom-icons-to-the-icon-block/).

## Requirements

- WordPress 6.2+
- PHP 7.0+

## Development

1. Set up a local WordPress development environment.
2. Clone / download this repository into the `wp-content/plugins` folder.
3. Navigate to the `wp-content/plugins/icon-block` folder in the command line.
4. Run `npm install` to install the plugin's dependencies within a `/node_modules/` folder.
5. Run `composer install` to install the additional WordPress composer tools within a `/vendor/` folder.
6. Run `npm run start` to compile and watch source files for changes while developing.

Refer to `package.json` for additional commands.

## Extensibility

The Icon Block includes a handful of extensibility features, allowing you to tailor the block to meet your needs.
The Icon Block includes several extensibility features that allow you to tailor the block to meet your needs.

### Hooks & Filters

Expand Down Expand Up @@ -81,5 +65,18 @@ You can easily disable border and spacing settings in the Editor UI if your them
...
```

## Requirements

- WordPress 6.4+
- PHP 7.4+

## Development

1. Set up a local WordPress development environment.
2. Clone / download this repository into the `wp-content/plugins` folder.
3. Navigate to the `wp-content/plugins/icon-block` folder in the command line.
4. Run `npm install` to install the plugin's dependencies within a `/node_modules/` folder.
5. Run `composer install` to install the additional WordPress composer tools within a `/vendor/` folder.
6. Run `npm run start` to compile and watch source files for changes while developing.

Refer to `package.json` for additional commands.
10 changes: 6 additions & 4 deletions icon-block.php
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<?php
/**
* Plugin Name: The Icon Block
* Description: Effortlessly add SVG icons and graphics to the WordPress block editor.
* Requires at least: 6.3
* Requires PHP: 7.0
* Version: 1.8.0
* Description: Easily add SVG icons and graphics to the WordPress block editor.
* Requires at least: 6.4
* Requires PHP: 7.4
* Version: 1.9.0
* Author: Nick Diego
* Author URI: https://www.nickdiego.com
* License: GPL-2.0-or-later
Expand All @@ -14,6 +14,8 @@
* @package The Icon Block
*/

defined( 'ABSPATH' ) || exit;

/**
* Registers the Icon Block using the metadata loaded from the `block.json`
* file. Behind the scenes, it registers also all assets so they can be enqueued
Expand Down
44 changes: 27 additions & 17 deletions readme.txt
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
=== The Icon Block ===
Contributors: ndiego, outermostdesign
Tags: icon, icon block, SVG, SVG block, block
Requires at least: 6.3
Tested up to: 6.5
Requires PHP: 7.0
Stable tag: 1.8.0
Requires at least: 6.4
Tested up to: 6.6
Requires PHP: 7.4
Stable tag: 1.9.0
License: GPL-2.0-or-later
License URI: https://www.gnu.org/licenses/gpl-2.0.html

Effortlessly add SVG icons and graphics to the WordPress block editor.
Easily add SVG icons and graphics to the WordPress block editor.

== Description ==

The Icon Block plugin registers a single, easy-to-use block that allows you to add custom SVG icons and graphics to the WordPress block editor (Gutenberg).

The plugin also includes the complete WordPress icon library with 290+ SVG icons.

=== Key Features ===
=== Key features ===

* 290+ native WordPress icons, including social logos
* Use any custom SVG icon or graphic
Expand All @@ -28,7 +28,7 @@ The plugin also includes the complete WordPress icon library with 290+ SVG icons
* Will get additional functionality as it's added to WordPress core
* Register your own custom icon library. [Learn more](https://nickdiego.com/adding-custom-icons-to-the-icon-block/)

=== Stay Connected ===
=== Stay connected ===

* [View on GitHub](https://github.com/ndiego/icon-block)
* [Visit plugin project page](https://nickdiego.com/projects/icon-block/)
Expand Down Expand Up @@ -67,22 +67,32 @@ Note that WordPress multisite installations have additional restrictions. "Unfil

== Screenshots ==

1. The Icon Block includes the WordPress icon library, allowing you to insert 270+ graphics.
2. Create your own custom icons by simply copying/pasting the SVG code. Then, modify the icon to suit your needs.
3. The Icon Block includes icon controls such as color, rotation, alignment, padding, and border-radius.
4. The Icon Block adapts to your layout, whether you need a big or small icon.
5. Use the "quick inserter" to pick the WordPress icon you need.
6. The WordPress icon library modal has categories, search, and preview size functionality.
7. Custom icons are added via their own insertion modal with a large text area and the ability to preview the SVG code.
8. You are not limited to traditional icons. Any SVG-based graphic will work as well. The block will respect any hard-coded color/fill values in the provided SVG.
1. The Icon Block includes icon controls such as color, rotation, alignment, padding, and border-radius.
2. The Icon Block adapts to your layout, whether you need a big or small icon.
3. Use the "quick inserter" to pick the WordPress icon you need.
4. The Icon Block includes the WordPress icon library, allowing you to insert 270+ graphics.
5. Create your own custom icons by simply copying/pasting the SVG code. Then, modify the icon to suit your needs.
6. You are not limited to traditional icons. Any SVG-based graphic will work as well. The block will respect any hard-coded color/fill values in the provided SVG.

== Changelog ==

= 1.9.0 = 2024-06-TBD
= 1.9.0 = 2024-07-20

**Added**

* Added support for `clientNavigation` interactivity, meaning that the Icon Block can now be placed in Query Loops with client-side navigation enabled.
* Add support for `clientNavigation` interactivity, meaning that the Icon Block can now be placed in Query Loops with client-side navigation enabled.

**Changed**

* Update "Tested up to" to WordPress 6.6.
* Update minimum WordPress version to 6.4.
* Update minimum PHP version 7.4.
* Update the settings panel to use the `ToolsPanel` component, which is consistent with WordPress Core.
* Update the Playground blueprint for the Live Preview.

**Removed**

* Remove the custom `OptionsPanel` component in favor of the Core `ToolsPanel` and `ToolsPanelItems` components.

**Fixed**

Expand Down

0 comments on commit 324b805

Please sign in to comment.