Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Backport #65772 to 6.7 #65905

Merged
merged 2 commits into from
Oct 8, 2024
Merged

Backport #65772 to 6.7 #65905

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c30d6f0
`PaletteEdit`: dedupe palette element slugs (#65772)
ramonjd Oct 4, 2024
0791d4f
Update CHANGELOG section
ciampo Oct 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions packages/components/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@

## Unreleased

### Enhancements
### Bug Fixes

- `Guide`: Update finish button to use the new default size ([#65680](https://github.com/WordPress/gutenberg/pull/65680)).
- `PaletteEdit`: dedupe palette element slugs ([#65772](https://github.com/WordPress/gutenberg/pull/65772)).

## 28.9.0 (2024-10-03)

### Bug Fixes

Expand All @@ -15,6 +17,10 @@
- `Composite`: make items tabbable if active element gets removed ([#65720](https://github.com/WordPress/gutenberg/pull/65720)).
- `DatePicker`: Use compact button size. ([#65653](https://github.com/WordPress/gutenberg/pull/65653)).

### Enhancements

- `Guide`: Update finish button to use the new default size ([#65680](https://github.com/WordPress/gutenberg/pull/65680)).

## 28.8.0 (2024-09-19)

### Bug Fixes
Expand Down
35 changes: 30 additions & 5 deletions packages/components/src/palette-edit/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,6 @@ import { kebabCase } from '../utils/strings';
import type {
Color,
ColorPickerPopoverProps,
Gradient,
NameInputProps,
OptionProps,
PaletteEditListViewProps,
Expand All @@ -70,6 +69,28 @@ function NameInput( { value, onChange, label }: NameInputProps ) {
);
}

/*
* Deduplicates the slugs of the provided elements.
*/
export function deduplicateElementSlugs< T extends PaletteElement >(
elements: T[]
) {
const slugCounts: { [ slug: string ]: number } = {};

return elements.map( ( element ) => {
let newSlug: string | undefined;

const { slug } = element;
slugCounts[ slug ] = ( slugCounts[ slug ] || 0 ) + 1;

if ( slugCounts[ slug ] > 1 ) {
newSlug = `${ slug }-${ slugCounts[ slug ] - 1 }`;
}

return { ...element, slug: newSlug ?? slug };
} );
}

/**
* Returns a name and slug for a palette item. The name takes the format "Color + id".
* To ensure there are no duplicate ids, this function checks all slugs.
Expand Down Expand Up @@ -109,7 +130,7 @@ export function getNameAndSlugForPosition(
};
}

function ColorPickerPopover< T extends Color | Gradient >( {
function ColorPickerPopover< T extends PaletteElement >( {
isGradient,
element,
onChange,
Expand Down Expand Up @@ -167,7 +188,7 @@ function ColorPickerPopover< T extends Color | Gradient >( {
);
}

function Option< T extends Color | Gradient >( {
function Option< T extends PaletteElement >( {
canOnlyChangeValues,
element,
onChange,
Expand Down Expand Up @@ -265,7 +286,7 @@ function Option< T extends Color | Gradient >( {
);
}

function PaletteEditListView< T extends Color | Gradient >( {
function PaletteEditListView< T extends PaletteElement >( {
elements,
onChange,
canOnlyChangeValues,
Expand All @@ -280,7 +301,11 @@ function PaletteEditListView< T extends Color | Gradient >( {
elementsReferenceRef.current = elements;
}, [ elements ] );

const debounceOnChange = useDebounce( onChange, 100 );
const debounceOnChange = useDebounce(
( updatedElements: T[] ) =>
onChange( deduplicateElementSlugs( updatedElements ) ),
100
);

return (
<VStack spacing={ 3 }>
Expand Down
51 changes: 50 additions & 1 deletion packages/components/src/palette-edit/test/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@ import { click, type, press } from '@ariakit/test';
/**
* Internal dependencies
*/
import PaletteEdit, { getNameAndSlugForPosition } from '..';
import PaletteEdit, {
getNameAndSlugForPosition,
deduplicateElementSlugs,
} from '..';
import type { PaletteElement } from '../types';

const noop = () => {};
Expand Down Expand Up @@ -97,6 +100,52 @@ describe( 'getNameAndSlugForPosition', () => {
} );
} );

describe( 'deduplicateElementSlugs', () => {
it( 'should not change the slugs if they are unique', () => {
const elements: PaletteElement[] = [
{
slug: 'test-color-1',
color: '#ffffff',
name: 'Test Color 1',
},
{
slug: 'test-color-2',
color: '#1a4548',
name: 'Test Color 2',
},
];

expect( deduplicateElementSlugs( elements ) ).toEqual( elements );
} );
it( 'should change the slugs if they are not unique', () => {
const elements: PaletteElement[] = [
{
slug: 'test-color-1',
color: '#ffffff',
name: 'Test Color 1',
},
{
slug: 'test-color-1',
color: '#1a4548',
name: 'Test Color 2',
},
];

expect( deduplicateElementSlugs( elements ) ).toEqual( [
{
slug: 'test-color-1',
color: '#ffffff',
name: 'Test Color 1',
},
{
slug: 'test-color-1-1',
color: '#1a4548',
name: 'Test Color 2',
},
] );
} );
} );

describe( 'PaletteEdit', () => {
const defaultProps = {
paletteLabel: 'Test label',
Expand Down
Loading