An open API service indexing awesome lists of open source software.

https://github.com/theprojectsx/react-popover

Single tool to use Popover and Tooltip in React
https://github.com/theprojectsx/react-popover

react react-dropdown react-popover react-tooltip

Last synced: 2 months ago
JSON representation

Single tool to use Popover and Tooltip in React

Awesome Lists containing this project

README

          

# React Popover

A lightweight and flexible React Popover / Tooltip component.

- โšก **No ID or Ref needed** โ€” just wrap and go!
- ๐ŸŽจ **Full control** โ€” no default styles applied to your content.
- ๐Ÿง  **Simple API** โ€” intuitive props for easy customization.

---

## ๐ŸŒ Demo

Checkout [Demo of react-popover](https://modasser.is-a.dev/react-popover/)

## ๐Ÿš€ Installation

```bash
npm install @theprojectsx/react-popover
# or
yarn add @theprojectsx/react-popover
```

---

## ๐Ÿ’ก Usage

```jsx
import Popover from "@theprojectsx/react-popover";

const Page = () => {
return (


Here Lies some useful content}
position="bottom"
axis="center"
>

Click ME!



);
};

export default Page;
```

---

## โš™๏ธ Props

| Prop | Type | Default | Description |
| ----------------- | ---------------------------------------------------- | ---------- | ------------------------------------------------------------------ |
| `content` | `React.ReactNode` | โ€” | Content to show inside the popover |
| `className` | `string` | โ€” | Class for the content wrapper |
| `parentStyles` | `React.CSSProperties` | โ€” | Inline styles for the parent element |
| `position` | `"top" \| "bottom" \| "left" \| "right"` | `"bottom"` | Where the popover appears relative to trigger |
| `axis` | `"center" \| "top" \| "bottom" \| "left" \| "right"` | `"center"` | Axis alignment of the popover |
| `triggerType` | `"auto" \| "manual"` | `"auto"` | Whether to trigger on interaction or control manually |
| `contentVisible` | `boolean` | `false` | Show/hide popover manually (used when `triggerType` is `"manual"`) |
| `viewOnHover` | `boolean` | `true` | Show popover on hover instead of click (only in `auto` mode) |
| `closeOnClick` | `boolean` | `true` | Close Popover when clicked in trigger |
| `onWrapperBlur` | `(e) => void` | โ€” | Called when user clicks outside the popover |
| `onStatusChanged` | `(status: boolean) => void` | โ€” | Called when Status of popover changes while `triggerType = auto` |
| `gap` | `number` | `10` | Used to decide the gap between trigger and content |

---

## ๐Ÿงช License

MIT ยฉ [@theprojectsx](https://github.com/theprojectsx)