hintorium-react
v1.1.0
Published
React wrapper for Hintorium tooltip library
Maintainers
Readme
Hintorium Plugin (React)
React plugin to hintorium-core package. Built with React and Typescript
🚀 Installation
npm install hintorium-core
# or
pnpm add hintorium-core
# or
yarn add hintorium-core🧩 Usage
Import the core styles in your app:
import "hintorium-core/dist/hintorium-core.css";Import hook / declarative component in your component
export const MyComponent = () => {
const tooltipRef = useTooltip('Click me!', { position: 'top' });
return <button ref={tooltipRef}>Hover me</button>;
}Optionally you can add a global context to handle global configuration
function App(){
return (
<TooltipProvider options={{theme:"dark"}}>
<YourApp/>
</TooltipProvider>
)
}Architecture
src
├── index.ts # Main file
├── types.ts # Package types
├── hooks/ # Hooks
├── components/ # Declarative components
└── context/ # Context📘 Documentation
👉 Full documentation, examples, and live demos available at
Docs : https://hintorium.vercel.app
Storybook (For Devs) : https://hintorium-storybook.vercel.app
🧱 Project Structure
This library is part of the Hintorium Monorepo:
.
├── apps/
│ └── docs/ # documentation and examples
└── packages/
└── hintorium/ # the core tooltip library
└── hintorium-react/ # react plugin🧾 License
MIT © Kamil Engineer
See LICENSE
