Giter Club home page Giter Club logo

rcal's Introduction

React Click Away Listener (rcal)

npm version

license

A simple react click away listener component for React applications.

Installation

Install the package using npm:

npm install @usmangurowa/rcal

Install the package using yarn:

yarn add @usmangurowa/rcal

Usage

Here's a basic example of how to use @usmangurowa/rcal:

import React from "react";
import ClickAwayListener from "@usmangurowa/rcal";

const App = () => {
  const [open, setOpen] = React.useState(false);
  return (
    <ClickAwayListener as={"ul"} onClickAway={() => setOpen(false)}>
      {/* Your component  */}
    </ClickAwayListener>
  );
};

export default App;

API

ClickAwayListener

The ClickAwayListener component listen to click events outside of it.

Props:

  • as (optional): element to render as ul, div, button, e.t.c.
  • onClickAway: function to trigger when clicked outside is detected.
  • ...props : all other props like className, style, e.t.c.

Contributing

Contributions are welcome! Feel free to open an issue or submit a pull request.

rcal's People

Contributors

usmangurowa avatar

Stargazers

 avatar  avatar

Watchers

 avatar

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.