All Projects → humanmade → Hm Gutenberg Tools

humanmade / Hm Gutenberg Tools

Licence: gpl-2.0
Useful helpers, components or tools for building things with Gutenberg

Programming Languages

javascript
184084 projects - #8 most used programming language

Human Made Gutenberg Tools

A place to bundle useful reusable Gutenberg components and other tools.

What does this include?

  • Post Select button. Provides a media modal like user experience for selecting single or multiple posts. It supports searching, filtering, sorting and custom post types (and taxonomies). stying to work better in the sidebar.
  • More Sidebar controls. Other components wrapped up in as standardised sidebar control components.
    • Link control. A wrapper for the core UrlInput, but with some style improvements.
    • Image. Sidebar UI for selecting an image.
    • Post. A wrapper for the post select button component.

Instructions

Install as a plugin, mu-plugin, or you can include it in your theme/plugin.

You will need to run npm install && npm run build in in the hm-gutenberg-tools directory to ensure all the built files are available (In the future I hope to make this step redundant and provide built release versions).

Note that if you are including in a theme (or anywhere outside of plugins/mu-plugins directories) you must define HM_GB_TOOLS_DIR and HM_GB_TOOLS_URL. For example

define( 'HM_GB_TOOLS_DIR', get_stylesheet_directory() . '/lib/hm-gutenberg-tools' );
define( 'HM_GB_TOOLS_URL', get_stylesheet_directory_uri() . '/lib/hm-gutenberg-tools' );

Then you should specify the script hm-gb-tools-editor as a dependency of the script in which you are using it.

HM Gutenberg Tools then exposes all functionality globally as window.hm. You can then use reference this in your project in much the the same way that you would use any other components from Gutenberg.

Refer to the Wiki for usage instructions on individual components

Post Select UI

image

Refer to the wiki for more information on how to use this component.

Development

  • npm run build Builds a production version of the code.
  • npm run watch Watches for changes and builds development versions of the code.
  • npm run lint Lints your JS and fixes your code.

Changelog

v1.1.0

  • Support for i18n.

v1.0.0

  • Refactor how it works for compatability with WordPress 5.0
    • Use core data store
    • Use custom endpoint to fetch content to handle multiple post types.

v0.2.0

  • Deprecate EditableHTML. You can now just use the Gutenberg component wp.editor.RichText and set the format prop to string.
  • Updates to work with the latest version of Gutenberg (3.5).
Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].