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.

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

Removing Reakit Composite implementation #58620

Merged
merged 8 commits into from
Feb 2, 2024
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
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
4 changes: 4 additions & 0 deletions packages/components/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,10 @@

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also unrelated, but just spotted that we have 2 "Enhancements" sections.

- `CheckboxControl`: Remove ability for label prop to be false ([#58339](https://github.com/WordPress/gutenberg/pull/58339)).

### Code Quality
andrewhayward marked this conversation as resolved.
Show resolved Hide resolved

- `Composite`: Removing Reakit `Composite` implementation ([#58620](https://github.com/WordPress/gutenberg/pull/58620)).

## 25.16.0 (2024-01-24)

### Enhancements
Expand Down
9 changes: 6 additions & 3 deletions packages/components/src/composite/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
// Until we migrate away from Reakit, the 'unstable'
// implementation remains the default.
// Originally this pointed at a Reakit implementation of
// `Composite`, but we are removing Reakit entirely from the
// codebase. We will continue to support the Reakit API
// through the 'legacy' version, which uses Ariakit under
// the hood.

export * from './unstable';
export * from './legacy';
13 changes: 0 additions & 13 deletions packages/components/src/composite/legacy/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
* WordPress dependencies
*/
import { forwardRef } from '@wordpress/element';
import deprecated from '@wordpress/deprecated';

/**
* Internal dependencies
Expand Down Expand Up @@ -99,14 +98,6 @@ type CompositeComponentProps = CompositeState &
| ComponentProps< typeof Current.CompositeRow >
);

function showDeprecationMessage( previous?: string, next?: string ) {
andrewhayward marked this conversation as resolved.
Show resolved Hide resolved
if ( previous ) {
deprecated( `wp.components.__unstable${ previous }`, {
alternative: `wp.components.${ next || previous }`,
} );
}
}

function mapLegacyStatePropsToComponentProps(
legacyProps: CompositeStateProps
): CompositeComponentProps {
Expand All @@ -128,8 +119,6 @@ function proxyComposite< C extends Component >(
): CompositeComponent< C > {
const displayName = ProxiedComponent.displayName;
const Component = ( legacyProps: CompositeStateProps ) => {
showDeprecationMessage( displayName );

const { store, ...rest } =
mapLegacyStatePropsToComponentProps( legacyProps );
const props = rest as ComponentProps< C >;
Expand Down Expand Up @@ -175,8 +164,6 @@ export const CompositeItem = proxyComposite( Current.CompositeItem, {
export function useCompositeState(
legacyStateOptions: LegacyStateOptions = {}
): CompositeState {
showDeprecationMessage( 'UseCompositeState', 'useCompositeStore' );

const {
baseId,
currentId: defaultActiveId,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import {
import { UseCompositeStatePlaceholder, transform } from './utils';

const meta: Meta< typeof UseCompositeStatePlaceholder > = {
title: 'Components/Composite (Legacy)',
title: 'Components/Composite',
component: UseCompositeStatePlaceholder,
subcomponents: {
Composite,
Expand Down
30 changes: 0 additions & 30 deletions packages/components/src/composite/legacy/test/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,6 @@ type InitialState = Parameters< typeof useCompositeState >[ 0 ];
type CompositeState = ReturnType< typeof useCompositeState >;
type CompositeStateProps = CompositeState | { state: CompositeState };

const warningsIssued = new Map();

async function renderAndValidate( ...args: Parameters< typeof render > ) {
const view = render( ...args );
await waitFor( () => {
Expand Down Expand Up @@ -180,20 +178,6 @@ describe.each( [
);
renderAndValidate( <Test /> );

// Using the legacy composite components issues a deprecation
// warning, but only on the first usage. As such, we only
// expect `console` to warn once; any further rendering
// should not warn.
const warningKey = 'single tab stop';
if ( warningsIssued.get( warningKey ) ) {
// eslint-disable-next-line jest/no-conditional-expect
expect( console ).not.toHaveWarned();
} else {
// eslint-disable-next-line jest/no-conditional-expect
expect( console ).toHaveWarned();
warningsIssued.set( warningKey, true );
}

await press.Tab();
expect( screen.getByText( 'Before' ) ).toHaveFocus();
await press.Tab();
Expand Down Expand Up @@ -450,20 +434,6 @@ describe.each( [
const { itemA1, itemA2, itemA3, itemB1, itemB2, itemC1, itemC3 } =
useTwoDimensionalTest();

// Using the legacy composite components issues a deprecation
// warning, but only on the first usage. As such, we only
// expect `console` to warn once; any further rendering
// should not warn.
const warningKey = 'directions';
if ( warningsIssued.get( warningKey ) ) {
// eslint-disable-next-line jest/no-conditional-expect
expect( console ).not.toHaveWarned();
} else {
// eslint-disable-next-line jest/no-conditional-expect
expect( console ).toHaveWarned();
warningsIssued.set( warningKey, true );
}

await press.Tab();
expect( itemA1 ).toHaveFocus();
await press.ArrowUp();
Expand Down
23 changes: 0 additions & 23 deletions packages/components/src/composite/unstable/index.ts

This file was deleted.

151 changes: 0 additions & 151 deletions packages/components/src/composite/unstable/stories/index.story.tsx

This file was deleted.

72 changes: 0 additions & 72 deletions packages/components/src/composite/unstable/stories/utils.tsx

This file was deleted.

Loading
Loading