Skip to content

Tooltip migration: boot consumers + shell-level Tooltip.Provider (5/5) #78692

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

Draft
ciampo wants to merge 1 commit into
base: trunk
Choose a base branch
from
Draft

Tooltip migration: boot consumers + shell-level Tooltip.Provider (5/5) #78692

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions packages/boot/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@
"@wordpress/private-apis": "file:../private-apis",
"@wordpress/route": "file:../route",
"@wordpress/theme": "file:../theme",
"@wordpress/ui": "file:../ui",
"@wordpress/url": "file:../url",
"clsx": "^2.1.1"
},
Expand Down
242 changes: 126 additions & 116 deletions packages/boot/src/components/root/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ import { menu } from '@wordpress/icons';
import { useState, useEffect } from '@wordpress/element';
import { __ } from '@wordpress/i18n';
import { Page } from '@wordpress/admin-ui';
// eslint-disable-next-line @wordpress/use-recommended-components -- `Tooltip` is not yet on the recommended `@wordpress/ui` allow-list; landing as a migration step ahead of the wider rollout.
import { Tooltip } from '@wordpress/ui';

/**
* Internal dependencies
Expand Down Expand Up @@ -59,130 +61,138 @@ export default function Root() {

return (
<SlotFillProvider>
<UserThemeProvider isRoot color={ { bg: '#f8f8f8' } }>
<UserThemeProvider color={ { bg: '#1d2327' } }>
<div
className={ clsx( 'boot-layout', {
'has-canvas': !! canvas || canvas === null,
'has-full-canvas': isFullScreen,
} ) }
>
<SavePanel />
<SnackbarNotices className="boot-notices__snackbar" />
{ isMobileViewport && (
<Page.SidebarToggleFill>
<Button
icon={ menu }
onClick={ () =>
setIsMobileSidebarOpen( true )
}
label={ __( 'Open navigation panel' ) }
size="compact"
/>
</Page.SidebarToggleFill>
) }
{ /* Mobile Sidebar Backdrop */ }
<AnimatePresence>
{ isMobileViewport &&
isMobileSidebarOpen &&
! isFullScreen && (
<motion.div
initial={ { opacity: 0 } }
animate={ { opacity: 1 } }
exit={ { opacity: 0 } }
transition={ {
type: 'tween',
duration: disableMotion ? 0 : 0.2,
ease: 'easeOut',
} }
className="boot-layout__sidebar-backdrop"
<Tooltip.Provider>
<UserThemeProvider isRoot color={ { bg: '#f8f8f8' } }>
<UserThemeProvider color={ { bg: '#1d2327' } }>
<div
className={ clsx( 'boot-layout', {
'has-canvas': !! canvas || canvas === null,
'has-full-canvas': isFullScreen,
} ) }
>
<SavePanel />
<SnackbarNotices className="boot-notices__snackbar" />
{ isMobileViewport && (
<Page.SidebarToggleFill>
<Button
icon={ menu }
onClick={ () =>
setIsMobileSidebarOpen( false )
setIsMobileSidebarOpen( true )
}
onKeyDown={ ( event ) => {
if ( event.key === 'Escape' ) {
setIsMobileSidebarOpen( false );
}
} }
role="button"
tabIndex={ -1 }
aria-label={ __(
'Close navigation panel'
) }
label={ __( 'Open navigation panel' ) }
size="compact"
/>
) }
</AnimatePresence>
{ /* Mobile Sidebar */ }
<AnimatePresence>
{ isMobileViewport &&
isMobileSidebarOpen &&
! isFullScreen && (
<motion.div
initial={ { x: '-100%' } }
animate={ { x: 0 } }
exit={ { x: '-100%' } }
transition={ {
type: 'tween',
duration: disableMotion ? 0 : 0.2,
ease: 'easeOut',
} }
className="boot-layout__sidebar is-mobile"
>
<Sidebar />
</motion.div>
) }
</AnimatePresence>
{ /* Desktop Sidebar */ }
{ ! isMobileViewport && ! isFullScreen && (
<div className="boot-layout__sidebar">
<Sidebar />
</div>
) }
<div className="boot-layout__surfaces">
<UserThemeProvider color={ { bg: '#ffffff' } }>
<Outlet />
{ /* Render Canvas in Root to prevent remounting on route changes */ }
{ ( canvas || canvas === null ) && (
<div
className={ clsx(
'boot-layout__canvas',
{
'has-mobile-drawer':
canvas?.isPreview &&
isMobileViewport,
</Page.SidebarToggleFill>
) }
{ /* Mobile Sidebar Backdrop */ }
<AnimatePresence>
{ isMobileViewport &&
isMobileSidebarOpen &&
! isFullScreen && (
<motion.div
initial={ { opacity: 0 } }
animate={ { opacity: 1 } }
exit={ { opacity: 0 } }
transition={ {
type: 'tween',
duration: disableMotion
? 0
: 0.2,
ease: 'easeOut',
} }
className="boot-layout__sidebar-backdrop"
onClick={ () =>
setIsMobileSidebarOpen( false )
}
) }
>
{ canvas?.isPreview &&
isMobileViewport && (
<div className="boot-layout__mobile-sidebar-drawer">
<Button
icon={ menu }
onClick={ () =>
setIsMobileSidebarOpen(
true
)
}
label={ __(
'Open navigation panel'
) }
size="compact"
/>
</div>
onKeyDown={ ( event ) => {
if ( event.key === 'Escape' ) {
setIsMobileSidebarOpen(
false
);
}
} }
role="button"
tabIndex={ -1 }
aria-label={ __(
'Close navigation panel'
) }
<CanvasRenderer
canvas={ canvas }
routeContentModule={
routeContentModule
}
/>
</div>
) }
</UserThemeProvider>
) }
</AnimatePresence>
{ /* Mobile Sidebar */ }
<AnimatePresence>
{ isMobileViewport &&
isMobileSidebarOpen &&
! isFullScreen && (
<motion.div
initial={ { x: '-100%' } }
animate={ { x: 0 } }
exit={ { x: '-100%' } }
transition={ {
type: 'tween',
duration: disableMotion
? 0
: 0.2,
ease: 'easeOut',
} }
className="boot-layout__sidebar is-mobile"
>
<Sidebar />
</motion.div>
) }
</AnimatePresence>
{ /* Desktop Sidebar */ }
{ ! isMobileViewport && ! isFullScreen && (
<div className="boot-layout__sidebar">
<Sidebar />
</div>
) }
<div className="boot-layout__surfaces">
<UserThemeProvider color={ { bg: '#ffffff' } }>
<Outlet />
{ /* Render Canvas in Root to prevent remounting on route changes */ }
{ ( canvas || canvas === null ) && (
<div
className={ clsx(
'boot-layout__canvas',
{
'has-mobile-drawer':
canvas?.isPreview &&
isMobileViewport,
}
) }
>
{ canvas?.isPreview &&
isMobileViewport && (
<div className="boot-layout__mobile-sidebar-drawer">
<Button
icon={ menu }
onClick={ () =>
setIsMobileSidebarOpen(
true
)
}
label={ __(
'Open navigation panel'
) }
size="compact"
/>
</div>
) }
<CanvasRenderer
canvas={ canvas }
routeContentModule={
routeContentModule
}
/>
</div>
) }
</UserThemeProvider>
</div>
</div>
</div>
</UserThemeProvider>
</UserThemeProvider>
</UserThemeProvider>
</Tooltip.Provider>
</SlotFillProvider>
);
}
51 changes: 31 additions & 20 deletions packages/boot/src/components/save-button/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ import { store as coreStore } from '@wordpress/core-data';
import { displayShortcut, rawShortcut } from '@wordpress/keycodes';
import { check } from '@wordpress/icons';
import { EntitiesSavedStates } from '@wordpress/editor';
import { Button, Modal, Tooltip as WCTooltip } from '@wordpress/components';
import { Button, Modal } from '@wordpress/components';
// eslint-disable-next-line @wordpress/use-recommended-components -- `Tooltip` is not yet on the recommended `@wordpress/ui` allow-list; landing as a migration step ahead of the wider rollout.
import { Tooltip } from '@wordpress/ui';

/**
* Internal dependencies
Expand Down Expand Up @@ -82,28 +84,37 @@ export default function SaveButton() {
);
};
const label = getLabel();
const shortcut = displayShortcut.primary( 's' );

return (
<>
<WCTooltip
text={ hasChanges ? label : undefined }
shortcut={ displayShortcut.primary( 's' ) }
>
<Button
variant="primary"
size="compact"
onClick={ () => setIsSaveViewOpened( true ) }
onBlur={ hideSavedState }
disabled={ disabled }
accessibleWhenDisabled
isBusy={ isSaving }
aria-keyshortcuts={ rawShortcut.primary( 's' ) }
className="boot-save-button"
icon={ isInSavedState ? check : undefined }
>
{ label }
</Button>
</WCTooltip>
<Tooltip.Root>
<Tooltip.Trigger
render={
<Button
variant="primary"
size="compact"
onClick={ () => setIsSaveViewOpened( true ) }
onBlur={ hideSavedState }
disabled={ disabled }
accessibleWhenDisabled
isBusy={ isSaving }
aria-keyshortcuts={ rawShortcut.primary( 's' ) }
className="boot-save-button"
icon={ isInSavedState ? check : undefined }
>
{ label }
</Button>
}
/>
<Tooltip.Popup>
{ hasChanges && label }
{ /* TODO: replace with a future `@wordpress/ui` `Shortcut` primitive once available; until then, render the shortcut inline with a local class name to avoid leaking the `components-*` namespace outside `@wordpress/components`. */ }
<span className="boot-save-button__shortcut">
{ shortcut }
</span>
</Tooltip.Popup>
</Tooltip.Root>
{ isSaveViewOpen && (
<Modal
title={ __( 'Review changes' ) }
Expand Down
6 changes: 6 additions & 0 deletions packages/boot/src/components/save-button/style.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
@use "@wordpress/base-styles/variables" as *;

.boot-save-button {
width: 100%;
}

.boot-save-button__shortcut {
margin-left: $grid-unit-10;
}
Loading
Loading