Skip to content

Augment and improve Nav Editor (and block) documentation #31891

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
getdave merged 8 commits into from
May 24, 2021
Merged

Augment and improve Nav Editor (and block) documentation #31891

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
0de466c
Document different editor save and render modes
getdave May 17, 2021
ec06356
Add code references and correct grammar
getdave May 17, 2021
e2dfc0b
Tidy unrequired sentances
getdave May 17, 2021
04f049d
Document menu item to block attribute mapping
getdave May 17, 2021
164314c
Bring mappings adjacent to each other. Improve documenting inconsiste…
getdave May 17, 2021
24e92b7
Add helpful links
getdave May 17, 2021
9be12e7
Quick ref to the block
getdave May 17, 2021
b7441f4
Seperate out the colophon
getdave May 17, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Quick ref to the block
  • Loading branch information
@getdave
getdave committed May 19, 2021
commit 9be12e7e6ac2dfaae8be91bbf31d54a04044ca82
2 changes: 2 additions & 0 deletions packages/edit-navigation/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ initialize( '#navigation-editor-root', blockEditorSettings );

By default, the Navigation Editor screen allows users to create and edit complex navigations using a block-based UI. The aim is to supercede [the current Menus screen](https://codex.wordpress.org/WordPress_Menu_User_Guide) by providing a superior experience whilst retaining backwards compatibility.

The editing experience is provided as a block editor wrapper around the core functionality of the **Navigation _block_**. Features of the block are disabled/enhanced as necessary to provide an experience appropriate to editing a navigation outside of a Full Site Editing context.

## Modes

The Navigation Editor has two "modes" for _persistence_ ("saving" navigations) and _rendering_:
Expand Down