Skip to content

Migrate element package to TS #70886

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
merged 8 commits into from
Sep 5, 2025
Merged

Migrate element package to TS #70886

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
9040304
migrate index file to TS
dhruvikpatel18 Jul 24, 2025
5315105
Migrate other files to typescript
dhruvikpatel18 Jul 28, 2025
d61a403
Fixed issues for unit tests
dhruvikpatel18 Jul 28, 2025
21e3164
converted the JSDoc-style comments to inline TypeScript documentation
dhruvikpatel18 Aug 5, 2025
1441d37
Refactored functions to remove non-null assertions
dhruvikpatel18 Aug 5, 2025
c45f459
Refactored functions to remove non-null assertions
dhruvikpatel18 Aug 5, 2025
8d50afb
Merge branch 'trunk' into try/convert-element-ts
dhruvikpatel18 Sep 4, 2025
74c6133
update README with detailed descriptions for undocumented declarations
dhruvikpatel18 Sep 5, 2025
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
91 changes: 18 additions & 73 deletions packages/element/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,11 @@ Concatenate two or more React children objects.

_Parameters_

- _childrenArguments_ `...?Object`: Array of children arguments (array of arrays/strings/objects) to concatenate.
- _childrenArguments_ `ReactNode[][]`: - Array of children arguments (array of arrays/strings/objects) to concatenate.

_Returns_

- `Array`: The concatenated value.
- `ReactNode[]`: The concatenated value.

### createContext

Expand Down Expand Up @@ -110,24 +110,15 @@ You would have something like this as the conversionMap value:
_Parameters_

- _interpolatedString_ `string`: The interpolation string to be parsed.
- _conversionMap_ `Record<string, Element>`: The map used to convert the string to a react element.
- _conversionMap_ `Record< string, ReactElement >`: The map used to convert the string to a react element.

_Returns_

- `Element`: A wp element.
- `ReactElement`: A wp element.

### createPortal

Creates a portal into which a component can be rendered.

_Related_

- <https://github.com/facebook/react/issues/10309#issuecomment-318433235>

_Parameters_

- _child_ `import('react').ReactElement`: Any renderable child, such as an element, string, or fragment.
- _container_ `HTMLElement`: DOM node into which element should be rendered.
Undocumented declaration.

### createRef

Expand All @@ -139,31 +130,15 @@ _Returns_

### createRoot

Creates a new React root for the target DOM node.

_Related_

- <https://react.dev/reference/react-dom/client/createRoot>

_Changelog_

`6.2.0` Introduced in WordPress core.
Undocumented declaration.

### findDOMNode

Finds the dom node of a React component.

_Parameters_

- _component_ `import('react').ComponentType`: Component's instance.
Undocumented declaration.

### flushSync

Forces React to flush any updates inside the provided callback synchronously.

_Parameters_

- _callback_ `Function`: Callback to run synchronously.
Undocumented declaration.

### forwardRef

Expand All @@ -183,33 +158,19 @@ A component which renders its children without any wrapping element.

### hydrate

> **Deprecated** since WordPress 6.2.0. Use `hydrateRoot` instead.

Hydrates a given element into the target DOM node.

_Related_

- <https://react.dev/reference/react-dom/hydrate>
Undocumented declaration.

### hydrateRoot

Creates a new React root for the target DOM node and hydrates it with a pre-generated markup.

_Related_

- <https://react.dev/reference/react-dom/client/hydrateRoot>

_Changelog_

`6.2.0` Introduced in WordPress core.
Undocumented declaration.

### isEmptyElement

Checks if the provided WP element is empty.

_Parameters_

- _element_ `*`: WP element to check.
- _element_ `unknown`: WP element to check.

_Returns_

Expand Down Expand Up @@ -298,27 +259,17 @@ _Returns_

### render

> **Deprecated** since WordPress 6.2.0. Use `createRoot` instead.

Renders a given element into the target DOM node.

_Related_

- <https://react.dev/reference/react-dom/render>
Undocumented declaration.

### renderToString

Serializes a React element to string.

_Parameters_

- _element_ `import('react').ReactNode`: Element to serialize.
- _context_ `[Object]`: Context object.
- _legacyContext_ `[Object]`: Legacy context object.

_Returns_

- `string`: Serialized element.
- _element_ `React.ReactNode`:
- _context_ `any`:
- _legacyContext_ `Record< string, any >`:

### startTransition

Expand All @@ -342,22 +293,16 @@ Switches the nodeName of all the elements in the children object.

_Parameters_

- _children_ `?Object`: Children object.
- _children_ `ReactNode`: Children object.
- _nodeName_ `string`: Node name.

_Returns_

- `?Object`: The updated children object.
- `ReactNode`: The updated children object.

### unmountComponentAtNode

> **Deprecated** since WordPress 6.2.0. Use `root.unmount()` instead.

Removes any mounted element from the target DOM node.

_Related_

- <https://react.dev/reference/react-dom/unmountComponentAtNode>
Undocumented declaration.

### useCallback

Expand Down
Loading
Loading