Refactor preferences modal to the interface package #34195
Closed
Conversation
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
talldan
added
General Interface
18 tasks
|
Size Change: +2.69 kB (0%) Total Size: 1.04 MB
ℹ️ View Unchanged
|
talldan
force-pushed
the
refactor/preferences-modal-to-interface
branch
2 times, most recently
from
37872a6 to
b227687
Compare
Base automatically changed from
migrate/post-editor-feature-preferences-to-interface-package
to
trunk
August 23, 2021 08:59
gziolo
reviewed
Aug 23, 2021
|
|
||
| return ( | ||
| <PreferencesModal onRequestClose={ closeModal }> | ||
| <PreferencesModalTabs tabs={ tabs } /> |
There was a problem hiding this comment.
I would personally prefer to see several nested PreferencesModalTab components here rather than the array passed as a prop.
There was a problem hiding this comment.
I agree with that. It's a side effect of building on the TabPanel component, which works this way:
https://github.com/WordPress/gutenberg/blob/trunk/packages/components/src/tab-panel/README.md
I suppose that component could be reworked, deprecated and replaced, or the modal could use its own very similar system.
Weighing the effort vs reward, I'm not sure the array API is bad enough to warrant such a refactor.
gziolo
reviewed
Aug 23, 2021
| feature, | ||
| ...props | ||
| } ) { | ||
| const isChecked = useSelect( |
There was a problem hiding this comment.
The difference between PreferencesModalFeatureToggle and PreferencesModalToggle is very subtle. Is it worth exposing both components as part of the public API?
gziolo
reviewed
Aug 23, 2021
gziolo
reviewed
Aug 23, 2021
| export { default as ActionItem } from './action-item'; | ||
| export { default as PinnedItems } from './pinned-items'; | ||
| export { default as PreferencesModal } from './preferences-modal'; | ||
| export { default as PreferencesModalTabs } from './preferences-modal/tabs'; |
There was a problem hiding this comment.
Are tabs, sections, and toggles specific to the modal, or can they be used in any place?
There was a problem hiding this comment.
They're specific to the modal, there's quite a bit of CSS to make it appear the way it does.
gziolo
reviewed
Aug 23, 2021
Comment on lines
+70
to
+77
| <PreferencesModalFeatureToggle | ||
| scope="core/edit-post" | ||
| feature="focusMode" | ||
| help={ __( | ||
| 'Highlights the current block and fades other content.' | ||
| ) } | ||
| label={ __( 'Spotlight mode' ) } | ||
| /> |
There was a problem hiding this comment.
It's very similar to:
It makes me wonder whether we should compose those components differently. What about we build a general-purpose feature toggle button and we use as prop to render it differently depending on the context:
<EditorFeatureToggle
as={ PreferencesModalToggle }
scope="core/edit-post"
feature="focusMode"
help={ __(
'Highlights the current block and fades other content.'
) }
label={ __( 'Spotlight mode' ) }
/>There was a problem hiding this comment.
Hmm, yep, or a hook:
const props = useFeaturePreference( 'core/edit-post', 'topToolbar' );
return (
<PreferencesModalToggle
label={ __( 'Top toolbar' ) }
{ ...props }
/>
);There was a problem hiding this comment.
I had a look into it. I'm not sure it'd result in much gain, there would still be three components exported (EditorFeatureToggle, MoreMenuToggle and PreferencesModalToggle), which is more consistent, but I think it makes the API more complicated than a straightforward component that the implementer can import.
The problem with as is that it requires a component passed to it to have a particular interface (supporting props like value and onChange), so as implementers we end up writing adapter components to map those props to the underlying MenuItem (isSelected / onClick) and ToggleControl (checked / onChange) components.
A hook at least allows rewiring the props, but that can be verbose if there are lots of preferences (which is generally the case).
So I'm not sure it's worth reworking this.
talldan
force-pushed
the
refactor/preferences-modal-to-interface
branch
from
bf8686b to
d2c6da4
Compare
8 tasks
8 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Partly addresses #31965. Built on top of #34154.
Refactors the editor preferences modal to the interface package so that it can be implemented more easily in other editors.
How has this been tested?
Types of changes
New feature (non-breaking change which adds functionality)
Checklist:
*.native.jsfiles for terms that need renaming or removal).