Add margin-bottom lint rules for ToggleControl #64213
Merged
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
mirka
commented
Aug 2, 2024
| @@ -67,6 +67,7 @@ export default function ImageSettingsPanel( { | |||
| panelId={ panelId } | |||
| > | |||
| <ToggleControl | |||
| __nextHasNoMarginBottom | |||
There was a problem hiding this comment.
Testing instructions
In Global Styles, go to Blocks ▸ Image.
mirka
commented
Aug 2, 2024
| @@ -201,6 +201,7 @@ function BlockHooksControlPure( { | |||
|
|
|||
| return ( | |||
| <ToggleControl | |||
| __nextHasNoMarginBottom | |||
There was a problem hiding this comment.
Testing instructions
Apply the following diff. In the Site Editor, go to Templates ▸ Single Posts template. See the block inspector for the Content block.
diff --git a/gutenberg.php b/gutenberg.php
index b12c346741..fe14f2cafb 100644
--- a/gutenberg.php
+++ b/gutenberg.php
@@ -74,3 +74,14 @@ function gutenberg_pre_init() {
require_once __DIR__ . '/lib/load.php';
}
+
+add_filter( 'hooked_block_types', function ( $hooked_blocks, $position, $anchor_block ) {
+ if ( $anchor_block === 'core/post-content' && $position === 'after' ) {
+ // Add some core blocks after the post content.
+ $hooked_blocks[] = 'core/paragraph';
+ $hooked_blocks[] = 'core/separator';
+ $hooked_blocks[] = 'core/page-list';
+ }
+
+ return $hooked_blocks;
+}, 10, 3 );
|
Size Change: +1.38 kB (+0.08%) Total Size: 1.77 MB
ℹ️ View Unchanged
|
mirka
commented
Aug 2, 2024
| @@ -58,6 +58,7 @@ const AvatarInspectorControls = ( { | |||
| /> | |||
| { attributes.isLink && ( | |||
| <ToggleControl | |||
| __nextHasNoMarginBottom | |||
There was a problem hiding this comment.
Testing instruction
In the editor, add an Avatar block. In the block inspector, enable the "Link to user profile" toggle.
| @@ -48,6 +48,7 @@ function DetailsEdit( { attributes, setAttributes, clientId } ) { | |||
| <InspectorControls> | |||
| <PanelBody title={ __( 'Settings' ) }> | |||
| <ToggleControl | |||
| __nextHasNoMarginBottom | |||
There was a problem hiding this comment.
Testing instructions
In the editor, add a Details block and see the block inspector.
| @@ -202,6 +202,7 @@ export default function LatestPostsEdit( { attributes, setAttributes } ) { | |||
| <InspectorControls> | |||
| <PanelBody title={ __( 'Post content' ) }> | |||
| <ToggleControl | |||
| __nextHasNoMarginBottom | |||
There was a problem hiding this comment.
Testing instructions
In the editor, add a Latest Posts block and see the block inspector.
| @@ -36,6 +36,7 @@ export default function EnhancedPaginationControl( { | |||
| return ( | |||
| <> | |||
| <ToggleControl | |||
| __nextHasNoMarginBottom | |||
There was a problem hiding this comment.
Testing instructions
In the editor, add a Query Loop block and choose the Standard pattern. See the block inspector.
| @@ -169,6 +169,7 @@ function TagCloudEdit( { attributes, setAttributes } ) { | |||
| required | |||
| /> | |||
| <ToggleControl | |||
| __nextHasNoMarginBottom | |||
There was a problem hiding this comment.
Testing instructions
In the editor, add a Tag Cloud block and see the block inspector.
| @@ -74,6 +74,7 @@ export default function InitPatternModal() { | |||
| __next40pxDefaultSize | |||
| /> | |||
| <ToggleControl | |||
| __nextHasNoMarginBottom | |||
There was a problem hiding this comment.
Testing instructions
Go to wp-admin/post-new.php?post_type=wp_block.
| Before | After |
|---|---|
There was a problem hiding this comment.
Related discussion about how much space we actually want before the primary button. Tl;dr — we're not sure yet.
| @@ -131,6 +131,7 @@ export function CreatePatternModalContents( { | |||
| categoryMap={ categoryMap } | |||
| /> | |||
| <ToggleControl | |||
| __nextHasNoMarginBottom | |||
There was a problem hiding this comment.
Testing instructions
In the Site Editor, go to Patterns ▸ Add New Pattern ▸ Add New Pattern.
| Before | After |
|---|---|
49 tasks
mirka
commented
Aug 5, 2024
| @@ -176,6 +176,7 @@ export default function ReusableBlockConvertButton( { | |||
| placeholder={ __( 'My pattern' ) } | |||
| /> | |||
| <ToggleControl | |||
| __nextHasNoMarginBottom | |||
There was a problem hiding this comment.
As far as I can tell, this package is not used in the app code anymore. And the term "reusable block" has been changed to "synced patterns". But I think we can assume this create pattern modal is the same as the previous two.
mirka
requested review from
tellthemachines,
ellatrix and
ajitbohra
as code owners
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
tyxla
approved these changes
Aug 6, 2024
| @@ -296,6 +296,7 @@ module.exports = { | |||
| 'RangeControl', | |||
| 'SearchControl', | |||
| 'TextareaControl', | |||
| 'ToggleControl', | |||
There was a problem hiding this comment.
I assume we're intentionally adding the rules to:
- RN occurrences
- Readme occurrences
- Test occurrences
I wonder if it makes sense to add the prop to README occurrences at least? Right now, we're suggesting code that will lead to ESLint errors.
There was a problem hiding this comment.
Good point, I missed some places in the README and JSDocs. I'll do a final check for the rest of the components as well.
(Not sure if a typo, but we're not adding the prop to React Native components.)
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.
Part of #38730
What?
Adds eslint rules to prevent new instances of
ToggleControlto be introduced in the Gutenberg codebase without the__nextHasNoMarginBottomprop being added.Why?
These lint rules should prevent new violating usages from being added, until we are ready to officially deprecate the margins on the BaseControl-based components all at once.
Testing Instructions
See code comments.