react-popover

React Popover

A lightweight and flexible React Popover / Tooltip component.


๐ŸŒ Demo

Checkout Demo of react-popover

๐Ÿš€ Installation

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

๐Ÿ’ก Usage

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

const Page = () => {
    return (
        <div>
            <Popover
                content={<p className="p-4">Here Lies some useful content</p>}
                position="bottom"
                axis="center"
            >
                <button className="px-5 py-2 rounded-2xl bg-neutral-200 cursor-pointer">
                    Click ME!
                </button>
            </Popover>
        </div>
    );
};

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