Fix toggle help indentation #63903
Merged
Fix toggle help indentation #63903
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
jameskoster
added
[Type] Bug
|
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. |
|
Ahh yes. This will also be helpful to have adjusted. Thanks James! |
|
Size Change: +214 B (+0.01%) Total Size: 1.76 MB
ℹ️ View Unchanged
|
|
Flaky tests detected in e216ada. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/10076859153
|
ciampo
reviewed
Jul 24, 2024
There was a problem hiding this comment.
This is testing well for me — although I'd like to suggest an alternative approach: instead of changing the markup in ToggleControl, we could just add display: inline-block to the span.components-toggle-control__help, which would cause the margin to apply to the whole paragraph (instead of the first line).
It won't remove the additional <span> that was pointed out in the previous PR, but it won't need to use BaseControl's internal classnames.
Bonus: instead of margin-left, let's use the logical equivalent margin-inline-start.
diff --git a/packages/components/src/toggle-control/index.tsx b/packages/components/src/toggle-control/index.tsx
index c84ad90f12..89ef34f6d6 100644
--- a/packages/components/src/toggle-control/index.tsx
+++ b/packages/components/src/toggle-control/index.tsx
@@ -88,7 +88,13 @@ export function ToggleControl(
return (
<BaseControl
id={ id }
- help={ helpLabel }
+ help={
+ helpLabel && (
+ <span className="components-toggle-control__help">
+ { helpLabel }
+ </span>
+ )
+ }
className={ classes }
__nextHasNoMarginBottom
>
diff --git a/packages/components/src/toggle-control/style.scss b/packages/components/src/toggle-control/style.scss
index be7966611f..68733b53a9 100644
--- a/packages/components/src/toggle-control/style.scss
+++ b/packages/components/src/toggle-control/style.scss
@@ -6,6 +6,7 @@
}
}
-.components-base-control__help {
- margin-left: $toggle-width + $grid-unit-10;
+.components-toggle-control__help {
+ display: inline-block;
+ margin-inline-start: $toggle-width + $grid-unit-10;
}
What do folks think?
|
Works for me :) |
|
Cool. Let's wait a bit in case anyone else wants to share an opinion, and then we can apply any changes and merge. |
|
Yes, @ciampo's approach is exactly what we did for CheckboxControl. Sorry I missed this in review 🙇 |
|
LGTM |
|
Pushed the suggested changes. |
tyxla
approved these changes
Jul 25, 2024
|
Ideally, markup should not be used for presentational purposes. As I suggested in #63490 (comment) it would be better to remove the added |
Yes, it's not exactly ideal, but it's to avoid having to target an internal classname of a separate component ( |
|
I reckon we should merge this to fix the visual bug, then explore solutions eliminate the need for additional markup separately. |
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.
Follow-up to #63490.
What?
Fix indentation when help text spans several lines.
Why?
Improves appearance.
Testing Instructions
ToggleControlwith longer help text, e.g. the 'Inner blocks use content width' option on Group blocks.