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

fix: replace React.createElement with jsx runtime #8043

Draft
wants to merge 1 commit into
base: next
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all 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: 2 additions & 2 deletions .eslintrc.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -218,9 +218,9 @@ const config = {
},
{
name: 'react',
importNames: ['default', 'createContext'],
importNames: ['default', 'createContext', 'createElement'],
message:
'Please use named imports, e.g. `import {useEffect, useMemo, type ComponentType} from "react"` instead.\nPlease place "context" in _singletons',
'Please use named imports, e.g. `import {useEffect, useMemo, type ComponentType} from "react"` instead.\nPlease place "context" in _singletons\nPlease use JSX instead of createElement, for example `createElement(Icon)` should be `<Icon />`',
},
],
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ import {isMainThread, parentPort, Worker, workerData} from 'node:worker_threads'
import chalk from 'chalk'
import importFresh from 'import-fresh'
import {parse as parseHtml} from 'node-html-parser'
import {createElement} from 'react'
import {renderToStaticMarkup} from 'react-dom/server'

import {TIMESTAMPED_IMPORTMAP_INJECTOR_SCRIPT} from './constants'
Expand Down Expand Up @@ -231,7 +230,7 @@ function getDocumentHtml(

debug('Rendering document component using React')
const result = addTimestampedImportMapScriptToHtml(
renderToStaticMarkup(createElement(Document, {...defaultProps, ...props, css})),
renderToStaticMarkup(<Document {...defaultProps} {...props} css={css} />),
importMap,
)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {createElement, type MouseEvent, type ReactNode} from 'react'
import {type MouseEvent, type ReactNode} from 'react'

import {type Middleware} from './types'

Expand All @@ -10,9 +10,12 @@ export function onClick(event: MouseEvent<HTMLAnchorElement>): void {

function createLinkElement(url: string): ReactNode {
const href = url.startsWith('http') ? url : `https://${url}`
const props = {href, target: '_blank', rel: 'noopener noreferrer', key: url, onClick}

return createElement('a', props, url)
return (
<a key={url} href={href} target="_blank" rel="noopener noreferrer" onClick={onClick}>
{url}
</a>
)
}

/**
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {createElement, isValidElement, useState} from 'react'
import {isValidElement, useState} from 'react'
import {isValidElementType} from 'react-is'
import {useI18nText} from 'sanity'

Expand All @@ -17,7 +17,7 @@ export function UserComponentPane(props: UserComponentPaneProps) {
const {index, pane, paneKey, ...restProps} = props
const {
child,
component,
component: UserComponent,
menuItems,
menuItemGroups,
// eslint-disable-next-line @typescript-eslint/no-unused-vars
Expand All @@ -40,18 +40,19 @@ export function UserComponentPane(props: UserComponentPaneProps) {
/>

<UserComponentPaneContent>
{isValidElementType(component) &&
createElement(component, {
...restProps,
...restPane,
{isValidElementType(UserComponent) && (
<UserComponent
{...restProps}
{...restPane}
// NOTE: here we're utilizing the function form of refs so setting
// the ref causes a re-render for `UserComponentPaneHeader`
...({ref: setRef} as any),
child: child as any, // @todo: Fix typings
paneKey,
})}

{isValidElement(component) && component}
ref={setRef as any}
// @ts-expect-error - @TODO Fix typings
child={child}
paneKey={paneKey}
/>
)}
{isValidElement(UserComponent) && UserComponent}
</UserComponentPaneContent>
</Pane>
)
Expand Down
23 changes: 11 additions & 12 deletions packages/sanity/src/ui-components/menuItem/MenuItem.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ import {
Text,
} from '@sanity/ui'
import {
createElement,
forwardRef,
type HTMLProps,
isValidElement,
Expand Down Expand Up @@ -92,8 +91,8 @@ export const MenuItem = forwardRef(function MenuItem(
children: childrenProp,
disabled,
hotkeys,
icon,
iconRight,
icon: Icon,
iconRight: IconRight,
preview = null,
renderMenuItem,
text,
Expand All @@ -118,11 +117,11 @@ export const MenuItem = forwardRef(function MenuItem(
</Flex>
</PreviewWrapper>
)}
{icon && (
{Icon && (
<Box paddingRight={1}>
<Text size={FONT_SIZE}>
{isValidElement(icon) && icon}
{isValidElementType(icon) && createElement(icon)}
{isValidElement(Icon) && Icon}
{isValidElementType(Icon) && <Icon />}
</Text>
</Box>
)}
Expand All @@ -142,7 +141,7 @@ export const MenuItem = forwardRef(function MenuItem(
)}
</Stack>
)}
{(badgeText || hotkeys || iconRight) && (
{(badgeText || hotkeys || IconRight) && (
<Flex align="center" gap={3} marginLeft={3}>
{hotkeys && <Hotkeys keys={hotkeys} style={{marginTop: -4, marginBottom: -4}} />}

Expand All @@ -152,10 +151,10 @@ export const MenuItem = forwardRef(function MenuItem(
</Badge>
)}

{iconRight && (
{IconRight && (
<Text size={FONT_SIZE}>
{isValidElement(iconRight) && iconRight}
{isValidElementType(iconRight) && createElement(iconRight)}
{isValidElement(IconRight) && IconRight}
{isValidElementType(IconRight) && <IconRight />}
</Text>
)}
</Flex>
Expand All @@ -166,12 +165,12 @@ export const MenuItem = forwardRef(function MenuItem(
preview,
disabled,
__unstable_space,
icon,
Icon,
text,
__unstable_subtitle,
badgeText,
hotkeys,
iconRight,
IconRight,
])

const renderWrapper = useCallback<ConditionalWrapperRenderWrapperCallback>(
Expand Down
Loading