Skip to content

[code-infra] Remove components and componentsProps test from describeConformance for Material UI v9 #1244

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

Merged
Janpot merged 2 commits into from
Mar 27, 2026
Merged

[code-infra] Remove components and componentsProps test from describeConformance for Material UI v9 #1244

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c6c015a
Remove components and componentsProps test from describeConformance
ZeeshanTamboli Mar 25, 2026
e5d4ae3
Merge branch 'master' into remove-components-and-componentsProps-test…
Janpot Mar 27, 2026
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
208 changes: 2 additions & 206 deletions packages/test-utils/src/describeConformance.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@ import createDescribe from './createDescribe';
import { MuiRenderResult } from './createRenderer';
import { isJsdom } from './env';

function capitalize(string: string): string {
return string.charAt(0).toUpperCase() + string.slice(1);
}

interface DataProps {
[key: `data-${string}`]: string;
}
Expand Down Expand Up @@ -65,7 +61,6 @@ export interface ConformanceOptions {
testStateOverrides?: { prop?: string; value?: any; styleKey: string };
testCustomVariant?: boolean;
testVariantProps?: object;
testLegacyComponentsProp?: boolean | string[];
slots?: Record<string, SlotTestingOptions>;
ThemeProvider?: React.ElementType;
/**
Expand Down Expand Up @@ -303,26 +298,13 @@ function testSlotsProp(
} & React.RefAttributes<HTMLDivElement>
>;
};
components?: {
[x: string]:
| SlotTestingOptions['testWithComponent']
| keyof React.JSX.IntrinsicElements
| React.ForwardRefExoticComponent<
{
children: React.ReactNode;
} & React.RefAttributes<HTMLDivElement>
>;
};
slotProps: {
[x: string]: DataProps;
};
componentsProps?: {
[x: string]: DataProps;
};
}>,
getOptions: () => ConformanceOptions,
) {
const { render, slots, testLegacyComponentsProp } = getOptions();
const { render, slots } = getOptions();

const CustomComponent = React.forwardRef<
HTMLElement,
Expand Down Expand Up @@ -386,127 +368,16 @@ function testSlotsProp(
}
});
}

// For testing Material UI components v5, and v6. Likely to be removed in a future major release.
if (
testLegacyComponentsProp === true ||
(Array.isArray(testLegacyComponentsProp) && testLegacyComponentsProp.includes(slotName))
) {
it(`allows overriding the ${slotName} slot with a component using the components.${capitalize(
slotName,
)} prop`, async () => {
if (!render) {
throwMissingPropError('render');
}

const slotComponent = slotOptions.testWithComponent ?? CustomComponent;

const components = {
[capitalize(slotName)]: slotComponent,
};

const { queryByTestId } = await render(React.cloneElement(element, { components }));
const renderedElement = queryByTestId('custom');
expect(renderedElement).not.to.equal(null);
if (slotOptions.expectedClassName) {
expect(renderedElement).to.have.class(slotOptions.expectedClassName);
}
});

it(`prioritizes the 'slots.${slotName}' over components.${capitalize(
slotName,
)} if both are defined`, async () => {
if (!render) {
throwMissingPropError('render');
}

const ComponentForComponentsProp = React.forwardRef<
HTMLDivElement,
{ children: React.ReactNode }
>(({ children }, ref) => {
const SlotComponent = slotOptions.testWithComponent ?? 'div';
return (
<SlotComponent ref={ref} data-testid="from-components">
{children}
</SlotComponent>
);
});

const ComponentForSlotsProp = React.forwardRef<
HTMLDivElement,
{ children: React.ReactNode }
>(({ children }, ref) => {
const SlotComponent = slotOptions.testWithComponent ?? 'div';
return (
<SlotComponent ref={ref} data-testid="from-slots">
{children}
</SlotComponent>
);
});

const components = {
[capitalize(slotName)]: ComponentForComponentsProp,
};

const slotOverrides = {
[slotName]: ComponentForSlotsProp,
};

const { queryByTestId } = await render(
React.cloneElement(element, { components, slots: slotOverrides }),
);

expect(queryByTestId('from-slots')).not.to.equal(null);
expect(queryByTestId('from-components')).to.equal(null);
});

if (slotOptions.testWithElement !== null) {
it(`allows overriding the ${slotName} slot with an element using the components.${capitalize(
slotName,
)} prop`, async () => {
if (!render) {
throwMissingPropError('render');
}

const slotElement = slotOptions.testWithElement ?? 'i';

const components = {
[capitalize(slotName)]: slotElement,
};

const componentsProps = {
[slotName]: {
'data-testid': 'customized',
},
};

const { queryByTestId } = await render(
React.cloneElement(element, { components, componentsProps }),
);

const renderedElement = queryByTestId('customized');
expect(renderedElement).not.to.equal(null);

if (typeof slotElement === 'string') {
expect(renderedElement!.nodeName.toLowerCase()).to.equal(slotElement);
}
if (slotOptions.expectedClassName) {
expect(renderedElement).to.have.class(slotOptions.expectedClassName);
}
});
}
}
});
}

function testSlotPropsProp(
element: React.ReactElement<{
componentsProps?: Record<string, DataProps>;
slotProps: Record<string, DataProps>;
}>,
getOptions: () => ConformanceOptions,
) {
const { render, slots, testLegacyComponentsProp } = getOptions();
const { render, slots } = getOptions();

if (!render) {
throwMissingPropError('render');
Expand Down Expand Up @@ -544,50 +415,6 @@ function testSlotPropsProp(
expect(getByTestId('custom')).to.have.class(slotProps[slotName].className);
});
}

if (
testLegacyComponentsProp === true ||
(Array.isArray(testLegacyComponentsProp) && testLegacyComponentsProp.includes(slotName))
) {
it(`sets custom properties on the ${slotName} slot's element with the componentsProps.${slotName} prop`, async () => {
const componentsProps = {
[slotName]: {
'data-testid': 'custom',
},
};

const { queryByTestId } = await render(React.cloneElement(element, { componentsProps }));
const slotComponent = queryByTestId('custom');
expect(slotComponent).not.to.equal(null);

if (slotOptions.expectedClassName) {
expect(slotComponent).to.have.class(slotOptions.expectedClassName);
}
});

it(`prioritizes the 'slotProps.${slotName}' over componentsProps.${slotName} if both are defined`, async () => {
const componentsProps = {
[slotName]: {
'data-testid': 'custom',
'data-from-components-props': 'true',
},
};

const slotProps = {
[slotName]: {
'data-testid': 'custom',
'data-from-slot-props': 'true',
},
};

const { queryByTestId } = await render(
React.cloneElement(element, { componentsProps, slotProps }),
);
const slotComponent = queryByTestId('custom');
expect(slotComponent).to.have.attribute('data-from-slot-props', 'true');
expect(slotComponent).not.to.have.attribute('data-from-components-props');
});
}
});
}

Expand Down Expand Up @@ -651,36 +478,6 @@ function testSlotPropsCallbackWithPropsAsOwnerState(
});
}

/**
* MUI components have a `components` prop that allows rendering a different
* Components from @inheritComponent
*/
function testComponentsProp(
element: React.ReactElement<
{
components?: Record<string, string>;
} & DataProps
>,
getOptions: () => ConformanceOptions,
) {
describe('prop components:', () => {
it('can render another root component with the `components` prop', async () => {
const { render, testComponentsRootPropWith: component = 'em' } = getOptions();
if (!render) {
throwMissingPropError('render');
}

const testId = randomStringValue();

const { getByTestId } = await render(
React.cloneElement(element, { components: { Root: component }, 'data-testid': testId }),
);
expect(getByTestId(testId)).not.to.equal(null);
expect(getByTestId(testId).nodeName.toLowerCase()).to.eq(component);
});
});
}

/**
* MUI theme has a components section that allows specifying default props.
* Components from @inheritComponent
Expand Down Expand Up @@ -1142,7 +939,6 @@ function testThemeCustomPalette(

const fullSuite = {
componentProp: testComponentProp,
componentsProp: testComponentsProp,
mergeClassName: testClassName,
propsSpread: testPropsSpread,
refForwarding: describeRef,
Expand Down
Loading