Skip to content

Commit

Permalink
Merge branch 'trunk' into update/save-hub-behaviour
Browse files Browse the repository at this point in the history
  • Loading branch information
SaxonF committed Jun 6, 2023
2 parents c052b14 + a1d941e commit e147c67
Show file tree
Hide file tree
Showing 829 changed files with 13,554 additions and 5,691 deletions.
1 change: 1 addition & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ const restrictedImports = [
'invoke',
'isArray',
'isBoolean',
'isEmpty',
'isEqual',
'isFinite',
'isFunction',
Expand Down
121 changes: 0 additions & 121 deletions bin/generate-public-grammar.js

This file was deleted.

3 changes: 1 addition & 2 deletions bin/packages/get-packages.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
*/
const fs = require( 'fs' );
const path = require( 'path' );
const { isEmpty } = require( 'lodash' );

/**
* Absolute path to packages directory.
Expand Down Expand Up @@ -43,7 +42,7 @@ function hasModuleField( file ) {
return false;
}

return ! isEmpty( pkg.module );
return !! pkg.module;
}

/**
Expand Down
307 changes: 307 additions & 0 deletions changelog.txt

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/contributors/code/coding-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -771,9 +771,9 @@ Documenting a function component should be treated the same as any other functio
*
* @return {?string} Block title.
*/
````
```

For class components, there is no recommendation for documenting the props of the component. Gutenberg does not use or endorse the [`propTypes` static class member](https://reactjs.org/docs/typechecking-with-proptypes.html).
For class components, there is no recommendation for documenting the props of the component. Gutenberg does not use or endorse the [`propTypes` static class member](https://react.dev/reference/react/Component#static-proptypes).

## PHP

Expand Down
5 changes: 0 additions & 5 deletions docs/contributors/code/grammar.md

This file was deleted.

17 changes: 6 additions & 11 deletions docs/contributors/code/scripts.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The editor provides several vendor and internal scripts to plugin developers. Script names, handles, and descriptions are documented in the table below.

## WP Scripts
## WordPress scripts

The editor includes a number of packages to enable various pieces of functionality. Plugin developers can utilize them to create blocks, editor plugins, or generic plugins.

Expand Down Expand Up @@ -40,7 +40,7 @@ The editor includes a number of packages to enable various pieces of functionali
| [Viewport](/packages/viewport/README.md) | wp-viewport | Module for responding to changes in the browser viewport size |
| [Wordcount](/packages/wordcount/README.md) | wp-wordcount | WordPress word count utility |

## Vendor Scripts
## Vendor scripts

The editor also uses some popular third-party packages and scripts. Plugin developers can use these scripts as well without bundling them in their code (and increasing file sizes).

Expand All @@ -51,9 +51,10 @@ The editor also uses some popular third-party packages and scripts. Plugin devel
| [Moment](https://momentjs.com/) | moment | Parse, validate, manipulate, and display dates and times in JavaScript |
| [Lodash](https://lodash.com) | lodash | Lodash is a JavaScript library which provides utility functions for common programming tasks |

## Polyfill Scripts
## Polyfill scripts

The editor also provides polyfills for certain features that may not be available in all modern browsers.

It is recommended to use the main `wp-polyfill` script handle which takes care of loading all the below mentioned polyfills.

| Script Name | Handle | Description |
Expand All @@ -67,12 +68,6 @@ It is recommended to use the main `wp-polyfill` script handle which takes care o

## Bundling and code sharing

When using a JavaScript bundler like [webpack](https://webpack.js.org/), the scripts mentioned here
can be excluded from the bundle and provided by WordPress in the form of script dependencies [see
`wp_enqueue_script`](https://developer.wordpress.org/reference/functions/wp_enqueue_script/#default-scripts-included-and-registered-by-wordpress).
When using a JavaScript bundler like [webpack](https://webpack.js.org/), the scripts mentioned here can be excluded from the bundle and provided by WordPress in the form of script dependencies see [`wp_enqueue_script`](https://developer.wordpress.org/reference/functions/wp_enqueue_script/#default-scripts-included-and-registered-by-wordpress).

The
[`@wordpress/dependency-extraction-webpack-plugin`](https://github.com/WordPress/gutenberg/tree/HEAD/packages/dependency-extraction-webpack-plugin)
provides a webpack plugin to help extract WordPress dependencies from bundles. `@wordpress/scripts`
[`build`](https://github.com/WordPress/gutenberg/tree/HEAD/packages/scripts#build) script includes
the plugin by default.
The [`@wordpress/dependency-extraction-webpack-plugin`](https://github.com/WordPress/gutenberg/tree/HEAD/packages/dependency-extraction-webpack-plugin) provides a webpack plugin to help extract WordPress dependencies from bundles. The `@wordpress/scripts` [`build`](https://github.com/WordPress/gutenberg/tree/HEAD/packages/scripts#build) script includes the plugin by default.
31 changes: 0 additions & 31 deletions docs/contributors/roadmap.md

This file was deleted.

1 change: 1 addition & 0 deletions docs/explanations/architecture/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Let’s look at the big picture and the architectural and UX principles of the b

- [Key concepts](/docs/explanations/architecture/key-concepts.md).
- [Data format and data flow](/docs/explanations/architecture/data-flow.md).
- [Entities and undo/redo](/docs/explanations/architecture/entities.md).
- [Site editing templates](/docs/explanations/architecture/full-site-editing-templates.md).
- [Styles in the editor](/docs/explanations/architecture/styles.md).
- [Performance](/docs/explanations/architecture/performance.md).
Expand Down
63 changes: 63 additions & 0 deletions docs/explanations/architecture/entities.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Entities and Undo/Redo.

The WordPress editors, whether it's the post or site editor, manipulate what we call entity records. These are objects that represent a post, a page, a user, a term, a template, etc. They are the data that is stored in the database and that is manipulated by the editor. Each editor can fetch, edit and save multiple entity records at the same time.

For instance, when opening a page in the site editor:
- you can edit properties of the page itself (title, content...)
- you can edit properties of the template of the page (content of the template, design...)
- you can edit properties of template parts (header, footer) used with the template.

The editor keeps track of all these modifications and orchestrates the saving of all these modified records. This happens within the `@wordpress/core-data` package.


## Editing entities

To be able to edit an entity, you need to first fetch it and load it into the `core-data` store. For example, the following code loads the post with ID 1 into the store. (The entity is the post, the post 1 is the entity record).

````js
wp.data.dispatch( 'core' ).getEntityRecord( 'postType', 'post', 1 );
````

Once the entity is loaded, you can edit it. For example, the following code sets the title of the post to "Hello World". For each fetched entity record, the `core-data` store keeps track of:
- the "persisted" record: The last state of the record as it was fetched from the backend.
- A list of "edits": Unsaved local modifications for one or several properties of the record.

The package also exposes a set of actions to manipulate the fetched entity records.

To edit an entity record, you can call `editEntityRecord`, which takes the entity type, the entity ID and the new entity record as parameters. The following example sets the title of the post with ID 1 to "Hello World".

````js
wp.data.dispatch( 'core' ).editEntityRecord( 'postType', 'post', 1, { title: 'Hello World' } );
````

Once you have edited an entity record, you can save it. The following code saves the post with ID 1.

````js
wp.data.dispatch( 'core' ).saveEditedEntityRecord( 'postType', 'post', 1 );
````

## Undo/Redo

Since the WordPress editors allow multiple entity records to be edited at the same time, the `core-data` package keeps track of all the entity records that have been fetched and edited in a common undo/redo stack. Each step in the undo/redo stack contains a list of "edits" that should be undone or redone at the same time when calling the `undo` or `redo` action.

And to be able to perform both undo and redo operations propertly, each modification in the list of edits contains the following information:

- Entity kind and name: Each entity in core-data is identified by the pair _(kind, name)_. This corresponds to the identifier of the modified entity.
- Entity Record ID: The ID of the modified record.
- Property: The name of the modified property.
- From: The previous value of the property (needed to apply the undo operation).
- To: The new value of the property (needed to apply the redo operation).

For example, let's say a user edits the title of a post, followed by a modification to the post slug, and then a modification of the title of a reusable block used with the post. The following information is stored in the undo/redo stack:

- `[ { kind: 'postType', name: 'post', id: 1, property: 'title', from: '', to: 'Hello World' } ]`
- `[ { kind: 'postType', name: 'post', id: 1, property: 'slug', from: 'Previous slug', to: 'This is the slug of the hello world post' } ]`
- `[ { kind: 'postType', name: 'wp_block', id: 2, property: 'title', from: 'Reusable Block', to: 'Awesome Reusable Block' } ]`

The store also keep tracks of a "pointer" to the current "undo/redo" step. By default, the pointer always points to the last item in the stack. This pointer is updated when the user performs an undo or redo operation.

### Transient changes

The undo/redo core behavior also supports what we call "transient modifications". These are modifications that are not stored in the undo/redo stack right away. For instance, when a user starts typing in a text field, the value of the field is modified in the store, but this modification is not stored in the undo/redo stack until after the user moves to the next word or after a few milliseconds. This is done to avoid creating a new undo/redo step for each character typed by the user.

So by default, `core-data` store considers all modifications to properties that are marked as "transient" (like the `blocks` property in the post entity) as transient modifications. It keeps these modifications outside the undo/redo stack in what is called a "cache" of modifications and these modifications are only stored in the undo/redo stack when we explicitely call `__unstableCreateUndoLevel` or when the next non-transient modification is performed.
2 changes: 1 addition & 1 deletion docs/getting-started/create-block/block-anatomy.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Most of the properties are set in the `src/block.json` file.
```json
{
"$schema": "https://schemas.wp.org/trunk/block.json",
"apiVersion": 2,
"apiVersion": 3,
"name": "create-block/gutenpride",
"version": "0.1.0",
"title": "Gutenpride",
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/create-block/wp-plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ The `register_block_type` function registers the block we are going to create an
```json
{
"$schema": "https://schemas.wp.org/trunk/block.json",
"apiVersion": 2,
"apiVersion": 3,
"name": "create-block/gutenpride",
"version": "0.1.0",
"title": "Gutenpride",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -197,11 +197,15 @@ Like scripts, you can enqueue your block's styles using the `block.json` file.

Use the `editorStyle` property to a CSS file you want to load in the editor view, and use the `style` property for a CSS file you want to load on the frontend when the block is used.

It is worth noting that, if the editor content is iframed, both of these will
load in the iframe. `editorStyle` will also load outside the iframe, so it can
be used for editor content as well as UI.

For example:

```json
{
"apiVersion": 2,
"apiVersion": 3,
"name": "gutenberg-examples/example-02-stylesheets",
"title": "Example: Stylesheets",
"icon": "universal-access-alt",
Expand Down
Loading

0 comments on commit e147c67

Please sign in to comment.