ColorPalette, BorderControl, GradientPicker: refine types and logic around single vs multiple palettes #47384
There are no files selected for viewing
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| /** | ||
| * External dependencies | ||
| */ | ||
| import type { RefObject } from 'react'; | ||
| import { colord, extend } from 'colord'; | ||
| import namesPlugin from 'colord/plugins/names'; | ||
| import a11yPlugin from 'colord/plugins/a11y'; | ||
|
|
||
| /** | ||
| * WordPress dependencies | ||
| */ | ||
| import { __ } from '@wordpress/i18n'; | ||
|
|
||
| /** | ||
| * Internal dependencies | ||
| */ | ||
| import type { ColorObject, ColorPaletteProps, PaletteObject } from './types'; | ||
|
|
||
| extend( [ namesPlugin, a11yPlugin ] ); | ||
|
There was a problem hiding this comment. I had to add |
||
|
|
||
| export const extractColorNameFromCurrentValue = ( | ||
| currentValue?: ColorPaletteProps[ 'value' ], | ||
| colors: ColorPaletteProps[ 'colors' ] = [], | ||
| showMultiplePalettes: boolean = false | ||
| ) => { | ||
| if ( ! currentValue ) { | ||
| return ''; | ||
| } | ||
|
|
||
| const currentValueIsCssVariable = /^var\(/.test( currentValue ); | ||
| const normalizedCurrentValue = currentValueIsCssVariable | ||
| ? currentValue | ||
| : colord( currentValue ).toHex(); | ||
|
|
||
| // Normalize format of `colors` to simplify the following loop | ||
| type normalizedPaletteObject = { colors: ColorObject[] }; | ||
| const colorPalettes: normalizedPaletteObject[] = showMultiplePalettes | ||
| ? ( colors as PaletteObject[] ) | ||
| : [ { colors: colors as ColorObject[] } ]; | ||
| for ( const { colors: paletteColors } of colorPalettes ) { | ||
| for ( const { name: colorName, color: colorValue } of paletteColors ) { | ||
| const normalizedColorValue = currentValueIsCssVariable | ||
| ? colorValue | ||
| : colord( colorValue ).toHex(); | ||
|
|
||
| if ( normalizedCurrentValue === normalizedColorValue ) { | ||
| return colorName; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // translators: shown when the user has picked a custom color (i.e not in the palette of colors). | ||
| return __( 'Custom' ); | ||
| }; | ||
|
|
||
| export const showTransparentBackground = ( currentValue?: string ) => { | ||
| if ( typeof currentValue === 'undefined' ) { | ||
| return true; | ||
| } | ||
| return colord( currentValue ).alpha() === 0; | ||
| }; | ||
|
|
||
| // The PaletteObject type has a `colors` property (an array of ColorObject), | ||
| // while the ColorObject type has a `color` property (the CSS color value). | ||
| export const isMultiplePaletteObject = ( | ||
| obj: PaletteObject | ColorObject | ||
| ): obj is PaletteObject => | ||
| Array.isArray( ( obj as PaletteObject ).colors ) && ! ( 'color' in obj ); | ||
|
|
||
| export const isMultiplePaletteArray = ( | ||
| arr: ( PaletteObject | ColorObject )[] | ||
| ): arr is PaletteObject[] => { | ||
| return ( | ||
| arr.length > 0 && | ||
| arr.every( ( colorObj ) => isMultiplePaletteObject( colorObj ) ) | ||
| ); | ||
| }; | ||
|
Comment on lines
+63
to
+77
There was a problem hiding this comment. This is the only part that changes in this file. The rest of the lines are a simple copy/paste from |
||
|
|
||
| export const normalizeColorValue = ( | ||
| value: string | undefined, | ||
| ref: RefObject< HTMLElement > | null | ||
| ) => { | ||
| const currentValueIsCssVariable = /^var\(/.test( value ?? '' ); | ||
|
|
||
| if ( ! currentValueIsCssVariable || ! ref?.current ) { | ||
| return value; | ||
| } | ||
|
|
||
| const { ownerDocument } = ref.current; | ||
| const { defaultView } = ownerDocument; | ||
| const computedBackgroundColor = defaultView?.getComputedStyle( | ||
| ref.current | ||
| ).backgroundColor; | ||
|
|
||
| return computedBackgroundColor | ||
| ? colord( computedBackgroundColor ).toHex() | ||
| : value; | ||
| }; | ||
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
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.
This check is now embedded in
isMultiplePaletteArray