Browse Source

[Beta] isValidElement API (#5152)

main
dan 2 years ago
committed by GitHub
parent
commit
440741dde2
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 120
      beta/src/content/apis/react/isValidElement.md
  2. 3
      beta/src/sidebarReference.json

120
beta/src/content/apis/react/isValidElement.md

@ -2,21 +2,125 @@
title: isValidElement
---
<Wip>
<Intro>
This section is incomplete, please see the old docs for [isValidElement.](https://reactjs.org/docs/react-api.html#isvalidelement)
`isValidElement` checks whether a value is a React element.
</Wip>
```js
const isElement = isValidElement(value)
```
</Intro>
<Intro>
<InlineToc />
---
## Usage {/*usage*/}
### Checking if something is a React element {/*checking-if-something-is-a-react-element*/}
Call `isValidElement` to check if some value is a *React element.*
React elements are:
- Values produced by writing a [JSX tag](/learn/writing-markup-with-jsx)
- Values produced by calling [`createElement`](/api/react/createElement)
Verifies the object is a React element. Returns true or false.
For React elements, `isValidElement` returns `true`:
```js
React.isValidElement(object)
import { isValidElement, createElement } from 'react';
// ✅ JSX tags are React elements
console.log(isValidElement(<p />)); // true
console.log(isValidElement(<MyComponent />)); // true
// ✅ Values returned by createElement are React elements
console.log(isValidElement(createElement('p'))); // true
console.log(isValidElement(createElement(MyComponent))); // true
```
</Intro>
Any other values, such as strings, numbers, or arbitrary objects and arrays, are not React elements.
<InlineToc />
For them, `isValidElement` returns `false`:
```js
// ❌ These are *not* React elements
console.log(isValidElement(null)); // false
console.log(isValidElement(25)); // false
console.log(isValidElement('Hello')); // false
console.log(isValidElement({ age: 42 })); // false
console.log(isValidElement([<div />, <div />])); // false
console.log(isValidElement(MyComponent)); // false
```
It is very uncommon to need `isValidElement`. It's mostly useful if you're calling another API that *only* accepts elements (like [`cloneElement`](/api/react/cloneElement) does) and you want to avoid an error when your argument is not a React element.
Unless you have some very specific reason to add an `isValidElement` check, you probably don't need it.
<DeepDive title="React elements vs React nodes">
When you write a component, you can return any kind of *React node* from it:
```js
function MyComponent() {
// ... you can return any React node ...
}
```
A React node can be:
- A React element created like `<div />` or `createElement('div')`
- A portal created with [`createPortal`](/apis/react-dom/createPortal)
- A string
- A number
- `true`, `false`, `null`, or `undefined` (which are not displayed)
- An array of other React nodes
**Note `isValidElement` checks whether the argument is a *React element,* not whether it's a React node.** For example, `42` is not a valid React element. However, it is a perfectly valid React node:
```js
function MyComponent() {
return 42; // It's ok to return a number from component
}
```
This is why you shouldn't use `isValidElement` as a way to check whether something can be rendered.
</DeepDive>
---
## Reference {/*reference*/}
### `isValidElement(value)` {/*isvalidelement*/}
Call `isValidElement(value)` to check whether `value` is a React element.
```js
import { isValidElement } from 'react';
// ✅ React elements
console.log(isValidElement(<p />)); // true
console.log(isValidElement(createElement('p'))); // true
// ❌ Not React elements
console.log(isValidElement(25)); // false
console.log(isValidElement('Hello')); // false
console.log(isValidElement({ age: 42 })); // false
```
[See more examples above.](#usage)
#### Parameters {/*parameters*/}
* `value`: The `value` you want to check. It can be any a value of any type.
#### Returns {/*returns*/}
`isValidElement` returns `true` if the `value` is a React element. Otherwise, it returns `false`.
#### Caveats {/*caveats*/}
* **Only [JSX tags](/learn/writing-markup-with-jsx) and objects returned by [`createElement`](/api/react/createElement) are considered to be React elements.** For example, even though a number like `42` is a valid React *node* (and can be returned from a component), it is not a valid React element. Arrays and portals created with [`createPortal`](/apis/react-dom/createPortal) are also *not* considered to be React elements.

3
beta/src/sidebarReference.json

@ -54,8 +54,7 @@
},
{
"title": "isValidElement",
"path": "/apis/react/isValidElement",
"wip": true
"path": "/apis/react/isValidElement"
},
{
"title": "lazy",

Loading…
Cancel
Save