forked from WordPress/gutenberg
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Site editor routes: add docs for areas and prevent
edit
area from r…
…endering when canvas is `edit` (WordPress#66309) Co-authored-by: oandregal <[email protected]> Co-authored-by: youknowriad <[email protected]>
- Loading branch information
1 parent
a4aeb1a
commit 0b76a25
Showing
2 changed files
with
32 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
20 changes: 20 additions & 0 deletions
20
packages/edit-site/src/components/site-editor-routes/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# Site Editor Routes | ||
|
||
## Areas | ||
|
||
When `canvasMode` is not `edit`, the areas avaliable to use are: | ||
|
||
| Area | Non-mobile viewport | Mobile viewport | | ||
| --- | --- | --- | | ||
| `sidebar` | Always rendered. | Only if `mobile` is not provided. | | ||
| `content` | Rendered if provided. | Not rendered. | | ||
| `preview` | Rendered if provided. | Not rendered. | | ||
| `edit` | Rendered if provided. | Not rendered. | | ||
| `mobile` | Not rendered | Rendered as full-screen, if provided. | | ||
|
||
When `canvasMode` is `edit`, the areas avaliable to use are: | ||
|
||
| Area | Non-mobile viewport | Mobile viewport | | ||
| --- | --- | --- | | ||
| `preview` | Rendered as full-screen, if provided. Otherwise, it'll display an empty blank sidebar. | Not rendered. | | ||
| `mobile` | Not rendered | Rendered as full-screen, if provided. Otherwise, it'll display an empty blank sidebar. | |