[styled-engine] Drop withComponent support

[oliviertassinari]

Breaking changes

• [styled-engine] Drop withComponent support (#27780) @oliviertassinari
  Use the as prop instead. It's not style destructive when using multiple layers of styled() calls.

---

Why?

1. styled-components talks about removing it

https://styled-components.com/docs/api#withcomponent

2. goober doesn't support it

https://goober.js.org/

3. We almost never use it in the codebase, the smaller the API surface, the easier we can make changes.

I have noticed this in #27776.

[mui-pr-bot]

No bundle size changes (experimental)

Generated by 🚫 dangerJS against e29ffb2

[mnajdova]

Suggested change

	const ItemLink = styled(Item, {
	const ItemLink = styled(({ component = Link, ...props }) => <Item component={component} {...props} />, {

isn't this the equivalent?

[oliviertassinari]

I imagine the equivalent is :

Suggested change

	const ItemLink = styled(Item, {
	const ItemLink = styled(({ component = Link, ...props }) => <Item as={component} {...props} />, {

but there is already an as prop coming from the navigation that conflicts, e.g. as: '/api/accordion' so it doesn't work.

[mnajdova]

We are not even documenting this API anywhere so we should be good to go..

[eps1lon]

We almost never use it in the codebase, the smaller the API surface, the easier we can make changes.

👍🏻

[oliviertassinari]

Do we want to push it the extra mile with the tradeoff of @dimitropoulos in #20012 (comment)?

Suggested change

	ComponentSelector {}
	ComponentSelector {
	/**
	* Use the `as` prop instead.
	* It's not style destructive when using multiple layers of styled() calls.
	*/
	withComponent(tag: any): never;
	}

[oliviertassinari]

Actually, it doesn't work in this context. It would silence the missing support in TypeScript.