Typography Panel: Make letter spacing jsDoc and prop use consistent #36367
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
aaronrobertshaw
added
[Feature] UI Components
7 tasks
|
Size Change: +6 B (0%) Total Size: 1.09 MB
ℹ️ View Unchanged
|
ciampo
reviewed
Nov 11, 2021
| * @param {Object} props Component props. | ||
| * @param {string} props.value Currently selected letter-spacing. | ||
| * @param {Function} props.onChange Handles change in letter-spacing selection. | ||
| * @param {string|number|null} props.__unstableInputWidth Input width to pass through to inner UnitControl. |
There was a problem hiding this comment.
While null is going to work at runtime (because of this check), it isn't really compatible with the type used in InputControl:
Ideally, we should change this to
Suggested change
| * @param {string|number|null} props.__unstableInputWidth Input width to pass through to inner UnitControl. | |
| * @param {import('react').CSSProperties['width'] | } props.__unstableInputWidth Input width to pass through to inner UnitControl. Should be a valid CSS width value. |
but I'm not sure it's actually going to work (it may require the JSDoc comment to be wrapped in
/* eslint-disable jsdoc/valid-types */
[...]
/* eslint-enable jsdoc/valid-types */
A simpler version could be to:
Suggested change
| * @param {string|number|null} props.__unstableInputWidth Input width to pass through to inner UnitControl. | |
| * @param {string|number|undefined} props.__unstableInputWidth Input width to pass through to inner UnitControl. Should be a valid CSS width value. |
and maybe pass either '100%' or '' instead of null ?
There was a problem hiding this comment.
The simpler approach looks good to me. The jsdoc is clear, no exceptions to linting rules, and the switch to use 100% is explicit. Hard to misinterpret that 🙂
Thanks!
Let me know if you'd still prefer the jsdoc to import the CSS width property type.
ciampo
approved these changes
Nov 12, 2021
aaronrobertshaw
force-pushed
the
update/letter-spacing-control-width
branch
from
ed6eaf8 to
85635f5
Compare
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
This PR addresses concerns raised in #35911 (review) where the default
__unstableWidthvalue for the letter spacing control is overridden so that100%width can be restored when in the context of the TypographyToolsPanel.How has this been tested?
100%width60pxwidthScreenshots
Types of changes
Enhancement.
Checklist:
*.native.jsfiles for terms that need renaming or removal).