Skip to content

Site Editor: Add navigation panel back button slot #26846

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
david-szabo97 merged 6 commits into from
Nov 12, 2020
Merged

Site Editor: Add navigation panel back button slot #26846

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9d2c22f
Create NavigationPanelMainBackButton
david-szabo97 Nov 10, 2020
4a181ba
Add slot wrapper to templates navigation
david-szabo97 Nov 10, 2020
bce0012
Export NavigationPanelMainBackButton as experimental
david-szabo97 Nov 10, 2020
916b943
Reuse MainDashboardButton
david-szabo97 Nov 11, 2020
c120d0d
Update docs
david-szabo97 Nov 11, 2020
1ee3a63
Remove old export
david-szabo97 Nov 12, 2020
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
39 changes: 34 additions & 5 deletions docs/designers-developers/developers/slotfills/main-dashboard-button.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
# MainDashboardButton

This slot allows replacing the default main dashboard button that's used for closing
the editor in fullscreen mode.
This slot allows replacing the default main dashboard button in the post editor
that's used for closing the editor in fullscreen mode. In the site editor this slot
refers to the "back to dashboard" button in the navigation sidebar.

## Example
## Examples

Basic usage:

```js
import { registerPlugin } from '@wordpress/plugins';
Expand All @@ -22,8 +25,8 @@ registerPlugin( 'main-dashboard-button-test', {
} );
```

If your goal is just to replace the icon of the existing button, that can be achieved
in the following way:
If your goal is just to replace the icon of the existing button in
the post editor, that can be achieved in the following way:

```js
import { registerPlugin } from '@wordpress/plugins';
Expand All @@ -46,3 +49,29 @@ registerPlugin( 'main-dashboard-button-icon-test', {
render: MainDashboardButtonIconTest,
} );
```

Site editor example:

```js
import { registerPlugin } from '@wordpress/plugins';
import {
__experimentalMainDashboardButton as MainDashboardButton,
} from '@wordpress/interface';
import {
__experimentalNavigationBackButton as NavigationBackButton,
} from '@wordpress/components';

const MainDashboardButtonIconTest = () => (
<MainDashboardButton>
<NavigationBackButton
backButtonLabel={ __( 'Back to dashboard' ) }
className="edit-site-navigation-panel__back-to-dashboard"
href="index.php"
/>
</MainDashboardButton>
);

registerPlugin( 'main-dashboard-button-icon-test', {
render: MainDashboardButtonIconTest,
} );
```
13 changes: 8 additions & 5 deletions ...ages/edit-site/src/components/navigation-sidebar/navigation-panel/templates-navigation.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import {
__experimentalNavigationItem as NavigationItem,
__experimentalNavigationBackButton as NavigationBackButton,
} from '@wordpress/components';
import { __experimentalMainDashboardButton as MainDashboardButton } from '@wordpress/interface';
import { useDispatch, useSelect } from '@wordpress/data';
import { __ } from '@wordpress/i18n';

Expand Down Expand Up @@ -50,11 +51,13 @@ export default function TemplatesNavigation() {
onActivateMenu={ setNavigationPanelActiveMenu }
>
{ activeMenu === MENU_ROOT && (
<NavigationBackButton
backButtonLabel={ __( 'Dashboard' ) }
className="edit-site-navigation-panel__back-to-dashboard"
href="index.php"
/>
<MainDashboardButton.Slot>
<NavigationBackButton
backButtonLabel={ __( 'Dashboard' ) }
className="edit-site-navigation-panel__back-to-dashboard"
href="index.php"
/>
</MainDashboardButton.Slot>
) }

<NavigationMenu title={ __( 'Theme' ) }>
Expand Down