Skip to content
Merged
Changes from 1 commit
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
Prev Previous commit
Next Next commit
Documentation nits
  • Loading branch information
bvaughn committed Feb 11, 2018
commit 21a64bdbb797bb26b153aaf59cdc5bee8cc2cef4
46 changes: 20 additions & 26 deletions packages/react-is/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,72 +18,66 @@ npm install react-is --save

```js
import React from "react";
import { AsyncMode, isAsyncMode, typeOf } from "react-is";
import * as ReactIs from 'react-is';

isAsyncMode(<React.unstable_AsyncMode />); // true
typeOf(<React.unstable_AsyncMode />) === AsyncMode; // true
ReactIs.isAsyncMode(<React.unstable_AsyncMode />); // true
ReactIs.typeOf(<React.unstable_AsyncMode />) === ReactIs.AsyncMode; // true
```

### Context

```js
import React from "react";
import {
ContextConsumer,
ContextProvider,
isContextConsumer,
isContextProvider,
typeOf
} from "react-is";
import * as ReactIs from 'react-is';

const ThemeContext = React.createContext("blue");

isContextConsumer(<ThemeContext.Consumer />); // true
isContextProvider(<ThemeContext.Provider />); // true
typeOf(<ThemeContext.Provider />) === ContextProvider; // true
typeOf(<ThemeContext.Consumer />) === ContextConsumer; // true
ReactIs.isContextConsumer(<ThemeContext.Consumer />); // true
ReactIs.isContextProvider(<ThemeContext.Provider />); // true
ReactIs.typeOf(<ThemeContext.Provider />) === ReactIs.ContextProvider; // true
ReactIs.typeOf(<ThemeContext.Consumer />) === ReactIs.ContextConsumer; // true
```

### Element

```js
import React from "react";
import { Element, isElement, typeOf } from "react-is";
import * as ReactIs from 'react-is';

isElement(<div />); // true
typeOf(<div />) === Element; // true
ReactIs.isElement(<div />); // true
ReactIs.typeOf(<div />) === ReactIs.Element; // true
```

### Fragment

```js
import React from "react";
import { Fragment, isFragment, typeOf } from "react-is";
import * as ReactIs from 'react-is';

isFragment(<></>); // true
typeOf(<></>) === Fragment; // true
ReactIs.isFragment(<></>); // true
ReactIs.typeOf(<></>) === ReactIs.Fragment; // true
```

### Portal

```js
import React from "react";
import ReactDOM from "react-dom";
import { isPortal, Portal, typeOf } from "react-is";
import * as ReactIs from 'react-is';

const div = document.createElement("div");
const portal = ReactDOM.createPortal(<div />, div);

isPortal(portal); // true
typeOf(portal) === Portal; // true
ReactIs.isPortal(portal); // true
ReactIs.typeOf(portal) === ReactIs.Portal; // true
```

### StrictMode

```js
import React from "react";
import { isStrictMode, StrictMode, TypeOf } from "react-is";
import * as ReactIs from 'react-is';

isStrictMode(<React.StrictMode />); // true
typeOf(<React.StrictMode />) === StrictMode; // true
ReactIs.isStrictMode(<React.StrictMode />); // true
ReactIs.typeOf(<React.StrictMode />) === ReactIs.StrictMode; // true
```