source: node_modules/react-is/README.md

Last change on this file was a762898, checked in by istevanoska <ilinastevanoska@…>, 5 months ago

Added visualizations

  • Property mode set to 100644
File size: 2.3 KB
RevLine 
[a762898]1# `react-is`
2
3This 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
9yarn add react-is
10
11# NPM
12npm install react-is
13```
14
15## Usage
16
17### Determining if a Component is Valid
18
19```js
20import React from "react";
21import * as ReactIs from "react-is";
22
23class ClassComponent extends React.Component {
24 render() {
25 return React.createElement("div");
26 }
27}
28
29const FunctionComponent = () => React.createElement("div");
30
31const ForwardRefComponent = React.forwardRef((props, ref) =>
32 React.createElement(Component, { forwardedRef: ref, ...props })
33);
34
35const Context = React.createContext(false);
36
37ReactIs.isValidElementType("div"); // true
38ReactIs.isValidElementType(ClassComponent); // true
39ReactIs.isValidElementType(FunctionComponent); // true
40ReactIs.isValidElementType(ForwardRefComponent); // true
41ReactIs.isValidElementType(Context.Provider); // true
42ReactIs.isValidElementType(Context.Consumer); // true
43```
44
45### Determining an Element's Type
46
47#### Context
48
49```js
50import React from "react";
51import * as ReactIs from 'react-is';
52
53const ThemeContext = React.createContext("blue");
54
55ReactIs.isContextConsumer(<ThemeContext.Consumer />); // true
56ReactIs.isContextProvider(<ThemeContext.Provider />); // true
57ReactIs.typeOf(<ThemeContext.Provider />) === ReactIs.ContextProvider; // true
58ReactIs.typeOf(<ThemeContext.Consumer />) === ReactIs.ContextConsumer; // true
59```
60
61#### Element
62
63```js
64import React from "react";
65import * as ReactIs from 'react-is';
66
67ReactIs.isElement(<div />); // true
68ReactIs.typeOf(<div />) === ReactIs.Element; // true
69```
70
71#### Fragment
72
73```js
74import React from "react";
75import * as ReactIs from 'react-is';
76
77ReactIs.isFragment(<></>); // true
78ReactIs.typeOf(<></>) === ReactIs.Fragment; // true
79```
80
81#### Portal
82
83```js
84import React from "react";
85import ReactDOM from "react-dom";
86import * as ReactIs from 'react-is';
87
88const div = document.createElement("div");
89const portal = ReactDOM.createPortal(<div />, div);
90
91ReactIs.isPortal(portal); // true
92ReactIs.typeOf(portal) === ReactIs.Portal; // true
93```
94
95#### StrictMode
96
97```js
98import React from "react";
99import * as ReactIs from 'react-is';
100
101ReactIs.isStrictMode(<React.StrictMode />); // true
102ReactIs.typeOf(<React.StrictMode />) === ReactIs.StrictMode; // true
103```
Note: See TracBrowser for help on using the repository browser.