Skip to content

Commit 0b76a25

Browse files
Site editor routes: add docs for areas and prevent edit area from rendering when canvas is edit (#66309)
Co-authored-by: oandregal <[email protected]> Co-authored-by: youknowriad <[email protected]>
1 parent a4aeb1a commit 0b76a25

File tree

2 files changed

+32
-10
lines changed

2 files changed

+32
-10
lines changed

packages/edit-site/src/components/layout/index.js

+12-10
Original file line numberDiff line numberDiff line change
@@ -183,16 +183,18 @@ export default function Layout( { route } ) {
183183
</div>
184184
) }
185185

186-
{ ! isMobileViewport && areas.edit && (
187-
<div
188-
className="edit-site-layout__area"
189-
style={ {
190-
maxWidth: widths?.edit,
191-
} }
192-
>
193-
{ areas.edit }
194-
</div>
195-
) }
186+
{ ! isMobileViewport &&
187+
areas.edit &&
188+
canvasMode !== 'edit' && (
189+
<div
190+
className="edit-site-layout__area"
191+
style={ {
192+
maxWidth: widths?.edit,
193+
} }
194+
>
195+
{ areas.edit }
196+
</div>
197+
) }
196198

197199
{ ! isMobileViewport && areas.preview && (
198200
<div className="edit-site-layout__canvas-container">
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Site Editor Routes
2+
3+
## Areas
4+
5+
When `canvasMode` is not `edit`, the areas avaliable to use are:
6+
7+
| Area | Non-mobile viewport | Mobile viewport |
8+
| --- | --- | --- |
9+
| `sidebar` | Always rendered. | Only if `mobile` is not provided. |
10+
| `content` | Rendered if provided. | Not rendered. |
11+
| `preview` | Rendered if provided. | Not rendered. |
12+
| `edit` | Rendered if provided. | Not rendered. |
13+
| `mobile` | Not rendered | Rendered as full-screen, if provided. |
14+
15+
When `canvasMode` is `edit`, the areas avaliable to use are:
16+
17+
| Area | Non-mobile viewport | Mobile viewport |
18+
| --- | --- | --- |
19+
| `preview` | Rendered as full-screen, if provided. Otherwise, it'll display an empty blank sidebar. | Not rendered. |
20+
| `mobile` | Not rendered | Rendered as full-screen, if provided. Otherwise, it'll display an empty blank sidebar. |

0 commit comments

Comments
 (0)