1 | # `react-is`
|
2 |
|
3 | This package allows you to test arbitrary values and see if they're a particular React element type.
|
4 |
|
5 | ## Installation
|
6 |
|
7 | ```sh
|
8 | # Yarn
|
9 | yarn add react-is
|
10 |
|
11 | # NPM
|
12 | npm install react-is
|
13 | ```
|
14 |
|
15 | ## Usage
|
16 |
|
17 | ### Determining if a Component is Valid
|
18 |
|
19 | ```js
|
20 | import * as ReactIs from "react-is";
|
21 |
|
22 | class ClassComponent extends React.Component {
|
23 | render() {
|
24 | return React.createElement("div");
|
25 | }
|
26 | }
|
27 |
|
28 | const StatelessComponent = () => React.createElement("div");
|
29 |
|
30 | const ForwardRefComponent = React.forwardRef((props, ref) =>
|
31 | React.createElement(Component, { forwardedRef: ref, ...props })
|
32 | );
|
33 |
|
34 | const Context = React.createContext(false);
|
35 |
|
36 | ReactIs.isValidElementType("div"); // true
|
37 | ReactIs.isValidElementType(ClassComponent); // true
|
38 | ReactIs.isValidElementType(StatelessComponent); // true
|
39 | ReactIs.isValidElementType(ForwardRefComponent); // true
|
40 | ReactIs.isValidElementType(Context.Provider); // true
|
41 | ReactIs.isValidElementType(Context.Consumer); // true
|
42 | ReactIs.isValidElementType(React.createFactory("div")); // true
|
43 | ```
|
44 |
|
45 | ### Determining an Element's Type
|
46 |
|
47 | #### ConcurrentMode
|
48 |
|
49 | ```js
|
50 | import React from "react";
|
51 | import * as ReactIs from 'react-is';
|
52 |
|
53 | ReactIs.isConcurrentMode(<React.unstable_ConcurrentMode />); // true
|
54 | ReactIs.typeOf(<React.unstable_ConcurrentMode />) === ReactIs.ConcurrentMode; // true
|
55 | ```
|
56 |
|
57 | #### Context
|
58 |
|
59 | ```js
|
60 | import React from "react";
|
61 | import * as ReactIs from 'react-is';
|
62 |
|
63 | const ThemeContext = React.createContext("blue");
|
64 |
|
65 | ReactIs.isContextConsumer(<ThemeContext.Consumer />); // true
|
66 | ReactIs.isContextProvider(<ThemeContext.Provider />); // true
|
67 | ReactIs.typeOf(<ThemeContext.Provider />) === ReactIs.ContextProvider; // true
|
68 | ReactIs.typeOf(<ThemeContext.Consumer />) === ReactIs.ContextConsumer; // true
|
69 | ```
|
70 |
|
71 | #### Element
|
72 |
|
73 | ```js
|
74 | import React from "react";
|
75 | import * as ReactIs from 'react-is';
|
76 |
|
77 | ReactIs.isElement(<div />); // true
|
78 | ReactIs.typeOf(<div />) === ReactIs.Element; // true
|
79 | ```
|
80 |
|
81 | #### Fragment
|
82 |
|
83 | ```js
|
84 | import React from "react";
|
85 | import * as ReactIs from 'react-is';
|
86 |
|
87 | ReactIs.isFragment(<></>); // true
|
88 | ReactIs.typeOf(<></>) === ReactIs.Fragment; // true
|
89 | ```
|
90 |
|
91 | #### Portal
|
92 |
|
93 | ```js
|
94 | import React from "react";
|
95 | import ReactDOM from "react-dom";
|
96 | import * as ReactIs from 'react-is';
|
97 |
|
98 | const div = document.createElement("div");
|
99 | const portal = ReactDOM.createPortal(<div />, div);
|
100 |
|
101 | ReactIs.isPortal(portal); // true
|
102 | ReactIs.typeOf(portal) === ReactIs.Portal; // true
|
103 | ```
|
104 |
|
105 | #### StrictMode
|
106 |
|
107 | ```js
|
108 | import React from "react";
|
109 | import * as ReactIs from 'react-is';
|
110 |
|
111 | ReactIs.isStrictMode(<React.StrictMode />); // true
|
112 | ReactIs.typeOf(<React.StrictMode />) === ReactIs.StrictMode; // true
|
113 | ```
|