Giter Club home page Giter Club logo

react-outside-click-handler's Introduction

Outside Click Handler

A react component for handling outside clicks without using unnecessary DOM operations. Faster and more practical!

Getting Started

It is developed for increasing efficiency when handling outside click. It does not use unnecessary DOM operations such as contains when handling outside click.

Installation

npm install react-outside-click-x

Usage

import OutsideClickHandler from 'react-outside-click-x';

function MyComponent() {
  return (
    <OutsideClickHandler
      onOutsideClick={() => {
        alert('Clicked outside!');
      }}
    >
      Hello World
    </OutsideClickHandler>
  );
}

Alternative Usage

By default, the OutsideClickHandler renders a

to wrap the subtree defined by children. It can be used alternatively without wrapping with additional div.

import OutsideClickHandler from 'react-outside-click-x';

function MyComponent() {
  return (
    <OutsideClickHandler
      onOutsideClick={() => {
        alert('Clicked outside!');
      }}
      targetElement={(ref) => { return (<MyComponent2 refHolder={ref} />) ;}}>
    />
  );
}
function MyComponent2(props) {
  return (
    <div ref={props.refHolder}>
      ...
    </div>
  );
}

Props

onOutsideClick: PropTypes.func.isRequired

When the user clicks outside of the given children, clickevent which is specified in onOutsideClick prop is triggered.

children: PropTypes.node

If children is defined, OutsideClickHandler wrap it with outer div and handles clicks outside of the given children.

targetElement: PropTypes.func

By default the OutsideClickHandler renders a <div /> to wrap children. Children can be given in the targetElement prop, so OutsideClickHandler does not render <div /> to wrap the children and the children is rendered without wrapping.

closeable: PropTypes.bool

If the closeable prop is false, outside clicks will not close given node. It is by default true so when outside clicks occur, given node is closed.

wrapperProps: PropTypes.object

When targetElement prop is not used, by default the OutsideClickHandler renders a <div /> to wrap children. By using wrapperProps prop, some properties can be passed to outer div such as styling.

Contributing

Please open an issue first to discuss the change you wish to make for major changes.

License

MIT

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.