Weston Ruter

Payton Swick

Important note: This project was first started before the Gutenberg feature plugin was started. As such, the JS Widgets plugin should now be considered a prototype which may inform the way that widget blocks get implemented in Gutenberg. This plugin will no longer be actively developed.
Also could be known as Widget Customizer 2.0, Widgets 3.0, or Widgets Next Generation.
Warning: The APIs provided by this plugin are still in flux. If creating new widgets that extend the <code>WP_JS_Widget</code> class, please look at the changelog and ensure compatibility with your extended widgets before deploying.
This plugin implements:
<ul>
<li><a href="https://core.trac.wordpress.org/ticket/33507" rel="nofollow ugc">WP-CORE#33507</a>: Allow widget controls to be JS-driven.</li>
<li><a href="https://core.trac.wordpress.org/ticket/35574" rel="nofollow ugc">WP-CORE#35574</a>: Add REST API JSON schema information to WP_Widget.</li>
<li><a href="https://github.com/WP-API/WP-API/issues/19" rel="nofollow ugc">WP-API#19</a>: Add widget endpoints to the WP REST API.</li>
</ul>
Features:
<ul>
<li>Integrates with <a href="https://wordpress.org/plugins/shortcode-ui/" rel="ugc">Shortcake (Shortcode UI)</a> to allow all JS widgets to be made available as Post Elements in the editor.</li>
<li>Widget instance settings in the Customizer are exported from PHP as regular JSON without any PHP-serialized base64-encoded <code>encoded_serialized_instance</code> anywhere to be seen.</li>
<li>Previewing widget changes in the customizer is faster since the <code>update-widget</code> Ajax request can be eliminated since the JS control can directly manipulate the widget instance data.</li>
<li>Widgets control forms use JS content templates instead of PHP to render the markup for each control, reducing the weight of the customizer load, especially when there are a lot of widgets in use.</li>
<li>Widgets that extend <code>WP_JS_Widget</code> will editable from both the customizer and the widgets admin page using the same <code>Form</code> JS interface. This <code>Form</code> is also able to be embedded in other contexts, like on the frontend and as a Shortcake (Shortcode UI) form. See <a href="https://github.com/xwp/wp-js-widgets/issues/11" rel="nofollow ugc">#11</a>.</li>
<li>Widgets employ the JSON Schema from the REST API to define an instance with validation and sanitization of the instance properties, beyond also providing <code>validate</code> and <code>sanitize</code> methods that work on the instance array as a whole.</li>
<li>A widget instance can be blocked from being saved by returning a <code>WP_Error</code> from its <code>validate</code> or <code>sanitize</code> method. For example, the RSS widget will show an error message if the feed URL provided is invalid and the widget will block from saving until the URL is corrected.</li>
<li>Widgets are exposed under the <code>js-widgets/v1</code> namespace, for example to list all Recent Posts widgets via the <code>/js-widgets/v1/widgets/recent-posts</code> or to get the Text widget with the “ID” (number) of 6, <code>/js-widgets/v1/widgets/text/6</code>.</li>
<li>Customizer settings for widget instances (<code>widget_{id_base}[{number}]</code>) are directly mutated via JavaScript instead of needing to do an <code>update-widget</code> Admin Ajax roundtrip; this greatly speeds up previewing.</li>
<li>Widget control forms can be extended to employ any JS framework for managing the UI, allowing Backbone, React, or any other frontend technology to be used.</li>
<li>Compatible with widgets stored in a custom post type instead of options, via the Widget Posts module in the <a href="https://github.com/xwp/wp-customize-widgets-plus" rel="nofollow ugc">Customize Widgets Plus</a> plugin.</li>
<li>Compatible with <a href="https://github.com/xwp/wp-customize-snapshots" rel="nofollow ugc">Customize Snapshots</a>, allowing changes made in the Customizer to be applied to requests for widgets via the REST API.</li>
<li>Includes adaptations of all core widgets using the new <code>WP_JS_Widget</code> API.</li>
<li>The adapted core widgets include additional raw data in their REST API item responses so that JS can render them client-side.</li>
<li>The Notifications API is utilized to display warnings when a user attempts to provide markup in a core widget title or illegal HTML in a Text widget’s content.</li>
<li>The Pages widget in Core is enhanced to make use of <a href="https://wordpress.org/plugins/customize-object-selector/" rel="ugc">Customize Object Selector</a> if available to display a Select2 UI for selecting pages to exclude instead of providing page IDs.</li>
<li>An bonus bundled plugin provides a “Post Collection” widget which, if the <a href="https://wordpress.org/plugins/customize-object-selector/" rel="ugc">Customize Object Selector</a> plugin is installed, will provide a UI for curating an arbitrary list of posts to display.</li>
</ul>
This plugin doesn’t yet implement any widgets that use JS templating for frontend rendering of the widgets. For that, please see the <a href="https://github.com/xwp/wp-next-recent-posts-widget" rel="nofollow ugc">Next Recent Posts Widget</a> plugin.
Limitations/Caveats:
<ul>
<li>Only widgets that extend <code>WP_JS_Widget</code> will be exposed via the REST API. The plugin includes a <code>WP_JS_Widget</code> adapter class which demonstrates how to adapt existing <code>WP_Widget</code> classes for the new widget functionality.</li>
</ul>

JS Widgets

A prototype of next generation of widgets in core, embracing JS for UI and powering the Widgets REST API.

Themeum

Ari Stathopoulos

David Vongries

DannyCooper

Ignacio Cruz Moreno

wplemon

<a href="https://github.com/themeum/kirki" rel="nofollow ugc">Kirki</a> is a Customizer toolkit for WordPress. An open-source initiative by <a href="https://github.com/themeum" rel="nofollow ugc">Themeum</a> for WordPress theme developers.
Kirki allows you to build themes faster and more easily. With over 30 custom controls—ranging from simple sliders to advanced typography controls with Google Fonts integration—and features like automatic CSS generation and <code>postMessage</code> support, Kirki makes theme development a breeze.
<h3>Features ✅</h3>
<ul>
<li>Increased Performance</li>
<li>Simplified API</li>
<li>Automatic CSS Generation</li>
<li>Automatic postMessage Generation</li>
<li>Partial Refresh</li>
<li>Conditional Logic</li>
<li>GDPR Compliance</li>
<li>Improved Page Speed</li>
<li>And more!</li>
</ul>
<h3>Controls 🎛️</h3>
<ul>
<li><a href="https://docs.themeum.com/kirki/controls/background/" rel="nofollow ugc">Background Customizer Control</a></li>
<li><a href="https://docs.themeum.com/kirki/controls/code/" rel="nofollow ugc">Code Customizer Control</a></li>
<li><a href="https://docs.themeum.com/kirki/controls/checkbox/" rel="nofollow ugc">Checkbox Customizer Control</a></li>
<li><a href="https://docs.themeum.com/kirki/controls/color/" rel="nofollow ugc">Color Customizer Control</a></li>
<li><a href="https://docs.themeum.com/kirki/controls/color-palette/" rel="nofollow ugc">Color Palette Customizer Control</a></li>
<li><a href="https://docs.themeum.com/kirki/controls/dashicons/" rel="nofollow ugc">Dashicons Customizer Control</a></li>
<li><a href="https://docs.themeum.com/kirki/controls/date/" rel="nofollow ugc">Date Customizer Control</a></li>
<li><a href="https://docs.themeum.com/kirki/controls/dimension/" rel="nofollow ugc">Dimension Customizer Control</a></li>
<li><a href="https://docs.themeum.com/kirki/controls/dimensions/" rel="nofollow ugc">Dimensions Customizer Control</a></li>
<li><a href="https://docs.themeum.com/kirki/controls/dropdown-pages/" rel="nofollow ugc">Dropdown Pages Customizer Control</a></li>
<li><a href="https://docs.themeum.com/kirki/controls/editor/" rel="nofollow ugc">Editor Customizer Control</a></li>
<li><a href="https://docs.themeum.com/kirki/controls/generic/" rel="nofollow ugc">Generic Customizer Control</a></li>
<li><a href="https://docs.themeum.com/kirki/controls/image/" rel="nofollow ugc">Image Customizer Control</a></li>
<li><a href="https://docs.themeum.com/kirki/controls/url/" rel="nofollow ugc">Link Customizer Control</a></li>
<li><a href="https://docs.themeum.com/kirki/controls/multicheck/" rel="nofollow ugc">Multiple Checkbox Customizer Control</a></li>
<li><a href="https://docs.themeum.com/kirki/controls/multicolor/" rel="nofollow ugc">Multicolor Customizer Control</a></li>
<li><a href="https://docs.themeum.com/kirki/controls/number/" rel="nofollow ugc">Number Customizer Control</a></li>
<li><a href="https://docs.themeum.com/kirki/controls/radio/" rel="nofollow ugc">Radio Customizer Control</a></li>
<li><a href="https://docs.themeum.com/kirki/controls/radio-buttonset/" rel="nofollow ugc">Radio Buttonset Customizer Control</a></li>
<li><a href="https://docs.themeum.com/kirki/controls/radio-image/" rel="nofollow ugc">Radio Image Customizer Control</a></li>
<li><a href="https://docs.themeum.com/kirki/controls/repeater/" rel="nofollow ugc">Repeater Customizer Control</a></li>
<li><a href="https://docs.themeum.com/kirki/controls/select/" rel="nofollow ugc">Select Customizer Control</a></li>
<li><a href="https://docs.themeum.com/kirki/controls/slider/" rel="nofollow ugc">Slider Customizer Control</a></li>
<li><a href="https://docs.themeum.com/kirki/controls/sortable/" rel="nofollow ugc">Sortable Customizer Control</a></li>
<li><a href="https://docs.themeum.com/kirki/controls/switch/" rel="nofollow ugc">Switch Customizer Control</a></li>
<li><a href="https://docs.themeum.com/kirki/controls/text/" rel="nofollow ugc">Text Customizer Control</a></li>
<li><a href="https://docs.themeum.com/kirki/controls/textarea/" rel="nofollow ugc">Textarea Customizer Control</a></li>
<li><a href="https://docs.themeum.com/kirki/controls/toggle/" rel="nofollow ugc">Toggle Customizer Control</a></li>
<li><a href="https://docs.themeum.com/kirki/controls/typography/" rel="nofollow ugc">Typography Customizer Control</a></li>
<li><a href="https://docs.themeum.com/kirki/controls/upload/" rel="nofollow ugc">Upload Customizer Control</a></li>
<li><a href="https://docs.themeum.com/kirki/extensions/margin-padding/" rel="nofollow ugc">Margin & Padding Controls</a></li>
<li><a href="https://docs.themeum.com/kirki/extensions/headlines-dividers/" rel="nofollow ugc">Headlines & Dividers</a></li>
<li><a href="https://docs.themeum.com/kirki/extensions/responsive-controls/" rel="nofollow ugc">Responsive Controls</a></li>
<li><a href="https://docs.themeum.com/kirki/extensions/input-slider/" rel="nofollow ugc">Input Slider</a></li>
<li><a href="https://docs.themeum.com/kirki/extensions/tabs/" rel="nofollow ugc">Tabs</a></li>
</ul>
<h3>Documentation 📖</h3>
You can find detailed documentation on how to use Kirki on https://www.themeum.com/kirki/

Kirki Customizer Framework

The Ultimate Customizer Framework for WordPress Theme Developers

JS Widgets vs Kirki Customizer Framework