Weston Ruter

Payton Swick

<p><em>Important note:</em> This project was first started before the Gutenberg feature plugin was started. As such, the JS Widgets plugin should now be considered a <em>prototype</em> which may inform the way that widget <em>blocks</em> get implemented in Gutenberg. This plugin will no longer be actively developed.</p>
<p>Also could be known as Widget Customizer 2.0, Widgets 3.0, or Widgets Next Generation.</p>
<p><em>Warning:</em> 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.</p>
<p>This plugin implements:</p>
<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>
<p>Features:</p>
<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>
<p>This plugin doesn’t yet implement any widgets that use JS templating for <em>frontend</em> 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.</p>
<p>Limitations/Caveats:</p>
<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.

Rocco Aliberti

presscustomizr

<h4>What is Nimble Page Builder ?</h4>
<p><strong><a href="https://nimblebuilder.com/" rel="nofollow ugc">Nimble Page Builder</a></strong> is a fast and agile page builder plugin for WordPress. Nimble Builder uses the live customizer, native and powerful WordPress interface for real-time design.<br />
The plugin allows you to easily drag-and-drop modules like text-editor, post grids, images, contact forms, maps, icons, or ready-made sections and starter templates into any page of your site. You can edit your pages in real-time, and then click “publish” when you are happy with the result.</p>
<p>Watch the video below to see how this <a href="https://demo.presscustomizr.com/nimble-builder/" rel="nofollow ugc">demo page</a> has been built.</p>
<div class="embed-vimeo" style="text-align: center;"><iframe loading="lazy" src="https://player.vimeo.com/video/328473405" width="750" height="422" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe></div>
<h4>Live demos</h4>
<ul>
<li><a href="https://nimblebuilder.com/landing-page-with-header-and-footer/" rel="nofollow ugc">landing page with header and footer</a></li>
<li><a href="https://demo.presscustomizr.com/nimble-builder/" rel="nofollow ugc">integration with the Customizr theme</a></li>
<li><a href="https://demo-hueman.presscustomizr.com/nimble-builder/" rel="nofollow ugc">integration with the Hueman theme</a></li>
<li><a href="https://docs.presscustomizr.com/article/372-design-your-404-page-with-the-nimble-builder/" rel="nofollow ugc">404 page created with Nimble Builder</a></li>
</ul>
<h4>Works on any page of your site and with all WordPress themes</h4>
<p>Nimble Builder allows you to insert sections in any context of your site : home page, single post or page, category or tag page, even search results or <a href="https://docs.presscustomizr.com/article/372-design-your-404-page-with-the-nimble-builder/" rel="nofollow ugc">404 pages</a>. No only that, you can also decide to <a href="https://docs.presscustomizr.com/article/371-how-to-start-building-from-a-blank-page-with-the-wordpress-nimble-builder/" rel="nofollow ugc">start designing from a blank page</a> on any page of your site, and even create a custom header and footer. Nimble Builder uses native WordPress action hooks, which makes it compatible with all WordPress themes.</p>
<h4>Features overview</h4>
<ul>
<li><strong>Drag and drop neatly pre-designed sections</strong> and customize them in real-time preview.</li>
<li><strong>Works in any WordPress contexts</strong> : home, pages, posts, custom post types, archives, author pages, search page, …</li>
<li>Create content, style, move / duplicate / remove elements <strong>in real-time preview</strong>.</li>
<li>Save and reuse sections and templates.</li>
<li><strong>Site building</strong> : define <a href="https://docs.presscustomizr.com/article/428-how-to-use-site-templates-with-nimble-builder" rel="nofollow ugc">site templates</a> for pages, posts, archives, search page, author pages, 404 page.</li>
<li><strong>Many content modules available</strong> : classic text editor, image, column layouts, contact form, button, icons, map, html code, WordPress widget area, menu, and more.</li>
<li><strong>Insert engaging <a href="https://docs.presscustomizr.com/article/393-how-to-add-post-grids-to-any-wordpress-page-with-nimble-builder/" rel="nofollow ugc">post grids</a></strong> on any page, looking great on desktop and mobile devices.</li>
<li>Use <strong>full width image or video backgrounds</strong> for your sections, and <a href="https://docs.presscustomizr.com/article/380-how-to-set-a-parallax-background-for-a-section-in-wordpress-with-the-nimble-builder/" rel="nofollow ugc">enable a parallax effect</a>.</li>
<li><strong>Easily <a href="https://docs.presscustomizr.com/article/343-designing-for-mobile-devices-with-wordpress-nimble-builder/" rel="nofollow ugc">customize your content specifically for mobile devices</a></strong> : change the responsive breakpoint, adapt font-size, spacing, alignment, column layouts, in real-time preview.</li>
<li><strong>Customize any text <a href="https://docs.presscustomizr.com/article/364-how-to-use-google-fonts-with-the-nimble-builder/" rel="nofollow ugc">with Google Fonts</a></strong>.</li>
<li>Add <strong><a href="https://docs.presscustomizr.com/article/409-how-to-add-custom-css-to-a-specific-page-of-your-wordpress-site/" rel="nofollow ugc">custom CSS</a></strong> to any specific page of your site ( and only to this page ) : post, page, archive, 404 page, WooCommerce product, etc.</li>
<li><strong><a href="https://docs.presscustomizr.com/article/391-how-to-export-and-import-templates-with-nimble-builder" rel="nofollow ugc">Export / Import</a></strong> : re-use your sections in other pages and between sites.</li>
<li><strong><a href="https://docs.presscustomizr.com/article/350-how-to-use-shortcodes-from-other-plugins-with-the-nimble-builder-plugin/" rel="nofollow ugc">Embed shortcodes</a> from other plugins</strong>, and see the result in real-time preview.</li>
<li>Nimble Builder automatically generates responsive HTML markup for a <strong>pixel-perfect rendering on smartphones and tablets</strong>.</li>
<li>Nimble Builder leverages the WordPress live customizer features for auto-drafting and schedule publishing. You can safely build and save drafts of your content before deploying in production.</li>
</ul>
<h4>Mind blowing performances 🚀</h4>
<p>Nimble Builder pages load very fast, in particular on mobile devices. With a basic cache server configuration, the plugin gets an A grade on performance tests.</p>
<h4>Mobile first builder</h4>
<p>Nimble Builder is designed <strong><a href="https://docs.presscustomizr.com/article/343-designing-for-mobile-devices-with-wordpress-nimble-builder" rel="nofollow ugc">mobile-first</a></strong>. It uses a performant and lightweight flex CSS foundation which ensures perfect rendering on mobile devices. The plugin is an effective productivity tool, ideal for quickly sketching and publishing pages with sections and columns. Nimble Builder generates clean and fluid HTML markup that meets the highest SEO and accessibility standards.</p>
<h4>Content modules</h4>
<ul>
<li>Headings</li>
<li>WordPress text editor ( support blocks and shortcodes )</li>
<li><a href="https://docs.presscustomizr.com/article/381-how-to-enable-lightbox-on-your-images-with-the-nimble-builder/" rel="nofollow ugc">Image</a></li>
<li>Button</li>
<li>Icon</li>
<li>Post Grid</li>
<li>Image Carousel</li>
<li><a href="https://docs.presscustomizr.com/article/385-how-to-enable-recaptcha-protection-against-spam-in-your-forms-with-the-nimble-builder/" rel="nofollow ugc">Contact Form</a></li>
<li><a href="https://docs.presscustomizr.com/article/387-how-to-insert-google-maps-in-your-wordpress-pages-with-the-nimble-builder/" rel="nofollow ugc">Google Map</a></li>
<li>Menu</li>
<li>Social Profiles</li>
<li>Divider</li>
<li>Spacer</li>
<li>Columns</li>
<li>Quote</li>
<li>Widget zone</li>
<li>Accordion</li>
<li>Shortcode</li>
<li>Tabs ( coming soon )</li>
<li>… and more to come !</li>
</ul>
<h4>Getting started</h4>
<p>Once <a href="https://docs.presscustomizr.com/article/347-installing-the-nimble-builder-plugin/" rel="nofollow ugc">installed</a>, Nimble Builder can be accessed in the WordPress live customizer. You can <a href="https://docs.presscustomizr.com/article/337-getting-started-with-the-nimble-builder-plugin/" rel="nofollow ugc">start creating your first section</a> !</p>
<h3>Documentation</h3>
<p>You’ll find a growing online knowledge base for Nimble builder here : <a href="https://docs.presscustomizr.com/collection/334-nimble-builder/" rel="nofollow ugc">Nimble builder documentation</a>.</p>
<ul>
<li><a href="https://docs.presscustomizr.com/article/337-getting-started-with-the-nimble-builder-plugin" rel="nofollow ugc">Getting started with Nimble Page Builder for WordPress</a></li>
<li><a href="https://docs.presscustomizr.com/article/355-technical-requirements-server-browser-php-version-wordpress-version" rel="nofollow ugc">Technical requirements for Nimble Builder : server, browser, php version, WP version</a></li>
<li><a href="https://docs.presscustomizr.com/article/343-designing-for-mobile-devices-with-wordpress-nimble-builder" rel="nofollow ugc">Designing for mobile devices with the WordPress Nimble Builder</a></li>
<li><a href="https://docs.presscustomizr.com/article/371-how-to-start-building-from-a-blank-page-with-the-wordpress-nimble-builder" rel="nofollow ugc">How to start building from a blank page with the WordPress Nimble Builder?</a></li>
<li><a href="https://docs.presscustomizr.com/article/358-building-your-header-and-footer-with-the-nimble-builder" rel="nofollow ugc">How to build your WordPress header and footer with Nimble Builder ?</a></li>
<li><a href="https://docs.presscustomizr.com/article/380-how-to-set-a-parallax-background-for-a-section-in-wordpress-with-the-nimble-builder" rel="nofollow ugc">How to set a parallax background for a section in WordPress with Nimble Builder ?</a></li>
<li><a href="https://docs.presscustomizr.com/article/385-how-to-enable-recaptcha-protection-against-spam-in-your-forms-with-the-nimble-builder" rel="nofollow ugc">How to enable reCAPTCHA protection against spam in your forms with Nimble Builder?</a></li>
<li><a href="https://docs.presscustomizr.com/article/339-changing-the-page-template" rel="nofollow ugc">How to change the page template with Nimble Builder ?</a></li>
</ul>


Nimble Page Builder

Simple and smart companion that allows you to insert sections into any existing page, create landing pages or entire websites including header and foo …

JS Widgets vs Nimble Page Builder