Wondering what’s next for npm?Check out our public roadmap! »

    react-is
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/react-is package

    17.0.2 • Public • Published

    react-is

    This package allows you to test arbitrary values and see if they're a particular React element type.

    Installation

    # Yarn
    yarn add react-is
    
    # NPM
    npm install react-is

    Usage

    Determining if a Component is Valid

    import React from "react";
    import * as ReactIs from "react-is";
    
    class ClassComponent extends React.Component {
      render() {
        return React.createElement("div");
      }
    }
    
    const FunctionComponent = () => React.createElement("div");
    
    const ForwardRefComponent = React.forwardRef((props, ref) =>
      React.createElement(Component, { forwardedRef: ref, ...props })
    );
    
    const Context = React.createContext(false);
    
    ReactIs.isValidElementType("div"); // true
    ReactIs.isValidElementType(ClassComponent); // true
    ReactIs.isValidElementType(FunctionComponent); // true
    ReactIs.isValidElementType(ForwardRefComponent); // true
    ReactIs.isValidElementType(Context.Provider); // true
    ReactIs.isValidElementType(Context.Consumer); // true
    ReactIs.isValidElementType(React.createFactory("div")); // true

    Determining an Element's Type

    Context

    import React from "react";
    import * as ReactIs from 'react-is';
    
    const ThemeContext = React.createContext("blue");
    
    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

    import React from "react";
    import * as ReactIs from 'react-is';
    
    ReactIs.isElement(<div />); // true
    ReactIs.typeOf(<div />) === ReactIs.Element; // true

    Fragment

    import React from "react";
    import * as ReactIs from 'react-is';
    
    ReactIs.isFragment(<></>); // true
    ReactIs.typeOf(<></>) === ReactIs.Fragment; // true

    Portal

    import React from "react";
    import ReactDOM from "react-dom";
    import * as ReactIs from 'react-is';
    
    const div = document.createElement("div");
    const portal = ReactDOM.createPortal(<div />, div);
    
    ReactIs.isPortal(portal); // true
    ReactIs.typeOf(portal) === ReactIs.Portal; // true

    StrictMode

    import React from "react";
    import * as ReactIs from 'react-is';
    
    ReactIs.isStrictMode(<React.StrictMode />); // true
    ReactIs.typeOf(<React.StrictMode />) === ReactIs.StrictMode; // true

    Keywords

    Install

    npm i react-is

    DownloadsWeekly Downloads

    25,096,678

    Version

    17.0.2

    License

    MIT

    Unpacked Size

    24.8 kB

    Total Files

    9

    Homepage

    reactjs.org/

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar