The Block Editor project for WordPress and beyond. Plugin is available from the official repository.
Switch branches/tags
3.8 Gallery-Block-Add-Media-Library-buttons-to-the-upload-new-image-area add/allowed-blocks-middleware add/authors-block add/bind-attribute add/block-reedit-invalid add/block-warning-overwrite add/blocks-capability add/blur-signal-when-rich-text-deselected add/column-filters add/components-readme add/configurable-text-color-button add/contact-stripe-block add/createCustomColorsHOC-withColors-builder add/docs-builder add/document-approach-to-have-drafts-as-parent-page add/dom-parser-prototype add/dynamic-default-styles add/e2e-test-blocks.BlockEdit-filter add/end-2-end-tests-align-hook add/eslint-rule-no-unused-before-return add/featured-image-next-to-title add/file-version-handle add/general-sidebar-exitensibility add/generic-end-2-end-test-block-transforms add/html-to-blocks add/i18n-filters add/image-details add/layout-half-image-half-centerd-content add/link-block-for-unembeddable-links add/lock-blocks add/mobile-swipe add/navigable-toolbar-scope add/nesting-cover-image-take-2 add/nesting-cover-image add/options-menu-extensibility add/popular-plugins-e2e add/preview-interstitial-filter add/rich-text-selection-selector add/rss-block add/scripts-build-start add/slot-fill-screen-takeover-api-modal add/store-block-usage-locally-for-recent-blocks-population add/strip-dynamic-blocks-parsed add/support-action-generators add/table-block-background-text-color add/table-fixed-dimensions add/template-editor add/tests-e2e-package add/vue-adapter add/with-allowed-block-types-hoc add/with-context-provider add/withColors-documentation-and-sample add/withPropsChangeHoC-and-mechanism-to-use-custom-colors-on-withColors add/346-list-block/ui-global-state add/346-list-block/ui-redux add/365-make-core-tinymce-block-type add/365-make-core-tinymce-block-type2 add/3016-auto-focus-code-block c-shultz-try/publicize-integration chore/update-clipboard-package doc/clarify-multiselection-focus docs/contrib-readme docs/metabox/tutorial docs/11392/javascript eslint-jshint-config extend/postAuthor feat/3976-move-block-toolbar-allow-forward-tab feature/accessible-autocomplete feature/add-progress-bars-to-build feature/autosave-notices feature/enable-all-hook feature/heartbeat-post-locking feature/hooks-in-register-plugin feature/image-block-buttons-action feature/limit-blocks feature/local-saving-for-heartbeat-autosaves feature/native-toolbar-component fix/address-4674 fix/advancedinspectorcontrols-anchor fix/alt-sibling-insert fix/ampersand-in-post-tag-causes-editor-crash fix/author-dropdown-react-select fix/author-dropdown fix/autop-regex fix/autosave-reverting-edits fix/block-switch-hover fix/change-front-page-permalink fix/classic-block-css fix/covert-caption-shortcode-with-link fix/custom-color-picker-button fix/disable-copy-button-during-upload fix/disable-disabled fix/doc-outline fix/dont-show-child-stacked-icon-if-childs-are-hidden-on-inseter fix/dropcap-clear-height fix/duplicate-block-slot fix/duplicate-toolbar-class fix/empty-blocks-are-valid fix/empty-text-block-alt fix/fixed-quote-list-transformations fix/heartbeat-for-trunk fix/ie11-broken-button-dimensions fix/image-block-add-props fix/image-dimensions-label-image-block fix/image-that-is-uploaded-to-an-existing-gallery-does-not-appear-in-the-edit-gallery-view fix/improve-annotations-performance fix/initial-autosave-state fix/kses-for-author-role-users fix/link-container-accessiblity-from-keyboard fix/link-placeholder fix/media-text-block-on-ie fix/media-text-description fix/no-transforming-to-not-allowed-blocks fix/non-privileged-reusable-blocks-ux fix/post-mark-modified-on-load fix/potential-flaw-in-pure fix/quote-copy-paste-handling fix/respect-allowed-block-on-title-enter fix/respect-allowed-blocks-locking-copy-paste-enter fix/rich-text-selection-empty fix/rtl-datepicker fix/save-meta-on-preview-try2 fix/shared-blocks-state-memory-leak fix/subheading-on-enter fix/table-cell-focus-issue fix/texturize-encoding fix/type-error-cannot-read-property-prefix-of-null fix/url-add-query-args-undefined fix/use-supports-align-in-cover-fix-align-related-bugs fix/wp-utils-script-preserve fix/1069-ff-add-link-error fix/1607-cursor-moves-behind-first-character fix/2124-arrow-navigation fix/4478 fix/5216 fix/8750-more-input-width fix/11352-custom-class-names-save fix/12318-published-autosave fix/12677-preview-link-empty gh-pages i18n-updates karmatosed-patch-1 karmatosed-patch-2 lol/8822-delete-and-recreate-tinymce master mobile origin/add/get_blocks origin/update/image-block parser/add-browser-comparator parser/add-markers parser/add-post-parse-filter parser/do-blocks-with-full-parse perf/move-unused-declarations perf/reduce-rerendering-on-startup perf/throttle-editor-user-input pr/3378 refactor/getBlockContentSchema release/1.9.1 remove-feedback-form remove-temp-workaround remove-user-handbook-section remove/aria-props-pick remove/editor-jquery remove/redundant-inserter-index remove/rich-text-dead-code remove/rich-text-did-update-deep-equal remove/slot-div remove/4032-gallery-api-requests revert-3911-update/blocks-alignment-rtl revert/legacy-notices-compat rnmobile/block-format-controls-portal rnmobile/compatible_base rnmobile/demo-1811 rnmobile/export-getblocktypes rnmobile/fix-heading-issue-ios rnmobile/image-block-vol-03 rnmobile/image-block-vol-04 rnmobile/inserter-svgicons-take1-experiment rnmobile/is-selected-plain-text rnmobile/native-mobile-subtree rnmobile/parser rnmobile/port-heading-block2 rnmobile/port-quote-block-step-1 rnmobile/react-native-mobile-integration-first-steps rnmobile/rich-text-formats rnmobile/selectable-text-plain-text rnmobile/test-links rnmobile/toolbar-with-react-native-portal rnmobile/try-7890-richtext-state-structure rnmobile/try-add-aztec-code-para-mariotest rnmobile/try-port-paragraph-block rnmobile/update-RichText-call-on-enter rnmobile/use-latest-gb-master-july rnmobile/359-deleting-text-more-block try/cache-bust try/circle-crop-variation try/collapse-additional-rich-text-controls try/collapsible-tips try/combined-performance-improvments try/complex-formatter-api try/core-format-types try/create-wp-plugin try/custom-serialize try/customberg try/data-registry-rebase try/data-registry try/delay-private-publish try/dispatch-on-call try/drag-text try/drop-zone-pull try/dropzone-provider try/editable-footnote-style try/embeds-fix try/fetch-reusable-blocks-in-view-context try/fix-default-attribute-deprecation try/fix-image-size-names try/float-alignments-fix try/float-mover-fix try/focal-point-picker try/format-boundaries try/freeform-old-editor-floating-toolbar try/full-screen-animation-alternate try/grammar-package-mobile try/hide-terms-search-if-low-term-count try/implement-delete-block-merging try/improve-columns try/improve-left-menu-scrolling try/improve-permalink-editing try/improved-arrow-nav-rebased-without-codecov-change try/improved-arrow-nav-rebased try/inject-template try/lighter-cog try/list-render-select-with-dispathc try/list-use-value-indent-outdent try/make-non-dismissible-notices-push-content-down try/map-svg-elements try/movers-below-floats-wide try/multi-block-aware-controls try/multi-block-toolbar try/navigation-mode-B-experiment try/new-publishing-flow try/oembed-fallback try/play-with-flow try/post-title-input try/presentation-slides try/quirks-mode-console-log try/quote-nested-blocks try/react-hooks try/react-native-portals try/refactor-onChangeEditableValue try/refactor-onChangeEditableValueV2 try/register-block-type-filters try/resize-render try/reusable-block-e2e-test try/revise-on-split try/save-data-offline-7367 try/script-debug try/selector-weak-map-cache try/shift-arrow-block-selection-consolidate try/template-editor-blocks try/tinymce-on-demand-init try/vue try/with-history-amender try/with-select-context try/with-select-force-update try/with-select-subscribe-keys try/8211-ssl-option-local-env update/add-button-cover-image-nesting update/add-labeling-workflow-1 update/add-labeling-workflow update/api-fetch-custom-fetch-handler update/async-package-build update/block-list-merge-with-dispatch update/button-link update/children-value update/data-extend-registries update/data-optimize-run-selector update/default-block-inserter-shortcuts-color-contrast update/docs-block-styles update/documentation update/dont-allow-drag-drop-if-the-block-being-dragged-isnot-allowed update/editor-selection-split-button-improvements update/embed-preview-api update/embed-previews-optionally-interactive update/expose-wp-by-default-devex update/get-block-cache-meta-sourced update/handle-multi-mounted-slot update/hooks-perf update/i18n-excerpt-docs-link update/icon-button-icon-text-margin update/image-block update/imgur-responsive-opt-out update/improve-getSupportedBlocks-selector update/improve-tooltips-behavior update/improve-typing-performance update/is-typing-within-block update/lint-js-config update/list-end-appender update/long-file-name update/make-opens-in-new-tab-message-reusable update/move-stylelint-scripts update/navigate-regions-landmarks-improvements update/omit-block-inserter update/omit-drop-zone-children update/pass-content-to-dynamic-block-render-functions update/pass-slot-fill-props update/popover-viewport-hoc update/puppeteer-heart-travis update/radio-readme update/rangecontrol-readme update/raw-html-parsing-type update/react-colorpicker update/remove-deprecated-embed-blocks update/render-callback-name update/responsive-embeds-theme-docs update/setattributes-documentation update/show-preview-button-on-mobile update/skip-optional-install-steps-in-tests update/svg-css-selector update/test-e2e-script update/video-block update/with-focus-return.js-replace-enzyme-with-React.TestRenderer update/with-notices-notices-role-alert update/with-select-shallow-equals-object update/wordpress-embed-detection update/writing-flow-selection-direction-iseulde-2 update/writing-flow-selection-direction-iseulde update/1038-more-draw-add-buttons v3.5.0
Nothing to show
Clone or download
Latest commit b1c17a6 Dec 16, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Add a line to PR template for developer documentation (#12822) Dec 13, 2018
assets/stylesheets Mobile: Fix post visibility popover not appearing (#11954) Nov 18, 2018
bin Try: fix end 2 end inline tokens test (#12459) Dec 4, 2018
docs Fix Typo (#12918) Dec 16, 2018
languages Build: Include string extraction in production build (#5308) Mar 2, 2018
lib Fix php notice from the recent comments block (#12812) Dec 12, 2018
packages Some content format issues (#12636) Dec 14, 2018
phpunit Fix e2e tests after the WordPress 5.0 upgrade (#12715) Dec 9, 2018
test When a post is saved, check for tinymce and save any editors. (#12568) Dec 9, 2018
vendor Install `phpcs` using Composer (#1022) Jun 6, 2017
.browserslistrc Build: using a postcss plugin to generate the admin-schemes styles (#… May 15, 2018
.editorconfig chore: Update `.editorconfig` to match WordPress' upstream Jan 12, 2018
.eslintignore Remove code coverage setup (#11198) Nov 1, 2018
.eslintrc.js Packages: Reimplement ESLint config as plugin (#12763) Dec 12, 2018
.gitignore Remove code coverage setup (#11198) Nov 1, 2018
.jshintignore Add .jshintignore to ignore all since eslint is employed May 25, 2017
.npmrc Framework: Configure NPM to save exact versions Aug 25, 2017
.nvmrc Framework: Bump recommended Node version to active LTS Nov 1, 2017
.stylelintrc.json Add stylelint for SCSS linting (#8647) Aug 8, 2018
.travis.yml Travis CI: Remove `sudo: required` (#12092) Nov 25, 2018
CODE_OF_CONDUCT.md Adds in a Code of conduct Oct 7, 2017
CONTRIBUTING.md Rename backwards compatiblity to backward compatibility (#12751) Dec 10, 2018
CONTRIBUTORS.md Get wordcount type from translation (#12586) Dec 9, 2018
LICENSE.md Update copyright year to 2018 in license.md (#4511) Jan 16, 2018
README.md Rename backwards compatiblity to backward compatibility (#12751) Dec 10, 2018
SECURITY.md Use HTTPS for Hacker One URL (#4655) Jan 24, 2018
TESTS.md Add tests file. Mar 17, 2017
babel.config.js Framework: Update code to work with Babel 7 (#7832) Jul 11, 2018
composer.json Show lint errors when there are lint problems (#9661) Sep 13, 2018
composer.lock Upgrade WPCS to 1.0.0 (#9065) Aug 18, 2018
docker-compose-localdev.yml Allow access to the WordPress installation if DOCKER_ENV=localwpdev (#… Aug 10, 2018
docker-compose.yml Docker: Add user for cli image. (#7450) Sep 14, 2018
gutenberg.php 4.7 (#12819) Dec 12, 2018
jsconfig.json Remove code coverage setup (#11198) Nov 1, 2018
lerna.json Add changelog files back to the ingored changes by Lerna Nov 9, 2018
package-lock.json 4.7 (#12819) Dec 12, 2018
package.json 4.7 (#12819) Dec 12, 2018
phpcs.xml.dist Remove the textdomain from block library (#12215) Nov 22, 2018
phpunit.xml.dist Setup server side unit tests (#617) May 10, 2017
post-content.php Gallery: Duplicate image IDs into easy-to-parse attribute (#11540) Nov 19, 2018
webpack.config.js Build Tooling: Avoid `.default` on browser global assignments (#12006) Nov 19, 2018

README.md

Gutenberg

Build Status lerna

Screenshot of the Gutenberg Editor, editing a post in WordPress

This repo is the development hub for the editor focus in WordPress Core. Gutenberg is the project name.

Getting started

Gutenberg is more than an editor. While the project is currently focused on building the new editor for WordPress, it doesn't end there. This lays the groundwork for a new model for WordPress Core that will ultimately impact the entire publishing experience of the platform.

Editing focus

The editor will create a new page- and post-building experience that makes writing rich posts effortless, and has “blocks” to make it easy what today might take shortcodes, custom HTML, or “mystery meat” embed discovery.

— Matt Mullenweg

One thing that sets WordPress apart is that it allows you to create a post layout that's as rich as you can imagine—but only if you can build your own custom theme with HTML and CSS. By thinking of the editor as a tool that allows you to write rich posts and create beautiful layouts, we can transform WordPress into something users love, as opposed to something they choose because it happens to be what everyone else uses.

Gutenberg is a new way forward. It looks at the editor as more than a content field, revisiting a layout that has been largely unchanged for almost a decade. This project allows The WordPress Project to holistically design a modern editing experience and build a foundation for things to come.

Here's why we're looking at the whole editing screen, as opposed to just the content field:

  1. The block unifies multiple interfaces. If Gutenberg added blocks on top of the existing interface, it would add complexity, as opposed to removing it.
  2. Simplified (and enhanced) editing. By revisiting the interface, Gutenberg can modernize the writing, editing, and publishing experience, with usability and simplicity in mind, benefitting both new and casual users.
  3. Better interface usability. When singular block interface takes center stage, it demonstrates a clear path forward for developers to create premium blocks, superior to both shortcodes and widgets.
  4. A fresh look at content creation. Considering the whole interface lays a solid foundation for the next focus: full site customization.
  5. Modern tooling. Looking at the full editor screen also gives WordPress the opportunity to drastically modernize the foundation, and take steps towards a more fluid and JavaScript-powered future that fully leverages the WordPress REST API.

Writing in Gutenberg 1.6

Blocks

Blocks are the unifying evolution of what is now covered, in different ways, by shortcodes, embeds, widgets, post formats, custom post types, theme options, meta-boxes, and other formatting elements. They embrace the breadth of functionality WordPress is capable of, with the clarity of a consistent user experience.

Imagine a custom employee block that a client can drag onto an About page to automatically display a picture, name, and bio of all the employees. Imagine a whole universe of plugins just as flexible, all extending WordPress in the same way. Imagine simplified menus and widgets. Users who can instantly understand and use WordPress—and 90% of plugins. This will allow you to easily compose beautiful posts like this example.

Check out the FAQ for answers to the most common questions about the project.

Compatibility

Posts are backward compatible, and shortcodes will still work. We are continuously exploring how highly-tailored meta boxes can be accommodated, and are looking at solutions ranging from a plugin to disable Gutenberg to automatically detecting whether to load Gutenberg or not. While we want to make sure the new editing experience from writing to publishing is user-friendly, we’re committed to finding a good solution for highly-tailored existing sites.

The stages of Gutenberg

Gutenberg has three planned stages.

  1. The first, aimed for inclusion in WordPress 5.0, focuses on the post editing experience and the implementation of blocks. This initial phase focuses on a content-first approach. The use of blocks, as detailed above, allows you to focus on how your content will look without the distraction of other configuration options. This ultimately will help all users present their content in a way that is engaging, direct, and visual. These foundational elements will pave the way forward.
  2. Planned for 2019, The second stage focuses on overhauling The Customizer and page templates.
  3. Ultimately, full site customization will be possible.

Gutenberg is a big change. There will be ways to ensure that existing functionality (like shortcodes and meta-boxes) continue to work while allowing developers the time and paths to transition effectively. Ultimately, it will open new opportunities for plugin and theme developers to better serve users through a more engaging and visual experience that takes advantage of a toolset supported by core.

Get involved

We’re calling this editor project "Gutenberg" because it's a big undertaking. We are working on it every day in GitHub, and we'd love your help building it. You’re also welcome to give feedback, the easiest is to join us in our Slack channel, #core-editor. A weekly meeting is held in the Slack channel on Wednesdays at 13:00 UTC.

Contributors

Gutenberg is built by many contributors and volunteers. Please see the full list in CONTRIBUTORS.md.

How You Can Contribute

Please see CONTRIBUTING.md.

Further Reading



Code is Poetry.