DataViews / DataViewsPicker: Add an optional padding prop with named values #72989
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| /** | ||
| * Internal dependencies | ||
| */ | ||
| import type { | ||
| PaddingSize, | ||
| PaddingOptions, | ||
| DimensionVariant, | ||
| } from '../../types/private'; | ||
|
|
||
| /** | ||
| * Maps padding size tokens to CSS values. | ||
| * Aligned with the Card component's spacing scale (space function with 4px base): | ||
| * - x-small: space(2) = 8px | ||
| * - small: space(4) = 16px | ||
| * - medium: space(6) = 24px | ||
| * - large: space(8) = 32px | ||
| * - x-large: space(12) = 48px | ||
| */ | ||
| const paddingValuesBySize: Record< PaddingSize, string > = { | ||
| 'x-small': '8px', | ||
| small: '16px', | ||
| medium: '24px', | ||
| large: '32px', | ||
| 'x-large': '48px', | ||
| none: '0', | ||
| }; | ||
|
Comment on lines
+10
to
+26
Contributor
Author
There was a problem hiding this comment. Very happy for feedback on the naming and sizing of this, maybe |
||
|
|
||
| /** | ||
| * Gets the CSS value for a single padding size token. | ||
| * | ||
| * @param size The padding size token. | ||
| * @return The CSS value for the padding size. | ||
| */ | ||
| function getSinglePaddingValue( size: PaddingSize ): string { | ||
| return paddingValuesBySize[ size ]; | ||
| } | ||
|
|
||
| /** | ||
| * Converts padding options into CSS custom property style values. | ||
| * Returns an object with the appropriate CSS custom properties set. | ||
| * When padding is undefined, returns an empty object to allow SCSS | ||
| * defaults and container queries to apply. | ||
| * | ||
| * @param padding The padding option (single size or directional variants), or undefined to use SCSS defaults | ||
| * @return An object with CSS custom property values, or empty object to use SCSS defaults | ||
| */ | ||
| export function getPaddingBySizeStyles( | ||
| padding: PaddingOptions | undefined | ||
| ): Record< string, string > { | ||
| const styles: Record< string, string > = {}; | ||
|
|
||
| // Handle string-based sizes (single value applied to all directional variants) | ||
| if ( typeof padding === 'string' ) { | ||
| const value = getSinglePaddingValue( padding ); | ||
| styles[ '--wp-dataviews-padding-block-start' ] = value; | ||
| styles[ '--wp-dataviews-padding-block-end' ] = value; | ||
| styles[ '--wp-dataviews-padding-inline-start' ] = value; | ||
| styles[ '--wp-dataviews-padding-inline-end' ] = value; | ||
| return styles; | ||
| } | ||
|
|
||
| // If no padding specified, return empty object to use SCSS defaults | ||
| if ( ! padding ) { | ||
| return styles; | ||
| } | ||
|
|
||
| // Handle object with directional variants | ||
| const { block, blockStart, blockEnd, inline, inlineStart, inlineEnd } = | ||
| padding as DimensionVariant< PaddingSize >; | ||
|
|
||
| if ( block !== undefined ) { | ||
| const value = getSinglePaddingValue( block ); | ||
| if ( blockStart === undefined ) { | ||
| styles[ '--wp-dataviews-padding-block-start' ] = value; | ||
| } | ||
| if ( blockEnd === undefined ) { | ||
| styles[ '--wp-dataviews-padding-block-end' ] = value; | ||
| } | ||
| } | ||
|
|
||
| if ( blockStart !== undefined ) { | ||
| styles[ '--wp-dataviews-padding-block-start' ] = | ||
| getSinglePaddingValue( blockStart ); | ||
| } | ||
|
|
||
| if ( blockEnd !== undefined ) { | ||
| styles[ '--wp-dataviews-padding-block-end' ] = | ||
| getSinglePaddingValue( blockEnd ); | ||
| } | ||
|
|
||
| if ( inline !== undefined ) { | ||
| const value = getSinglePaddingValue( inline ); | ||
| if ( inlineStart === undefined ) { | ||
| styles[ '--wp-dataviews-padding-inline-start' ] = value; | ||
| } | ||
| if ( inlineEnd === undefined ) { | ||
| styles[ '--wp-dataviews-padding-inline-end' ] = value; | ||
| } | ||
| } | ||
|
|
||
| if ( inlineStart !== undefined ) { | ||
| styles[ '--wp-dataviews-padding-inline-start' ] = | ||
| getSinglePaddingValue( inlineStart ); | ||
| } | ||
|
|
||
| if ( inlineEnd !== undefined ) { | ||
| styles[ '--wp-dataviews-padding-inline-end' ] = | ||
| getSinglePaddingValue( inlineEnd ); | ||
| } | ||
|
|
||
| return styles; | ||
| } | ||
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I asked the same question in the other place, resurfacing here as well:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
--wpds-tokens come from from the Theme package and are consumed by the components in the new UI package.Eventually we'll want this variable to reference one of those tokens for the fallback instead of
grid-unit-15. E.g.:var(--wp-dataviews-padding-block-end, --wpds-dimension-padding-surface-lg)I don't have any strong feelings about how the DataView-specific variables should be named.