Skip to content

moh3n9595/react-beacon-hint

Repository files navigation

React Beacon Hint

User Onboarding Component for React with Fully Configurable Options

CI/CD Codecov CodeFactor NPM Size GitHub contributors GitHub license PRs Welcome Prettier EsLint React Vite TS Demo Documentation

Banner

📄 Documentation   |    🌐 Demo


✨ Features

  • 🛠 Use Floating UI (the evolution of Popper 2) with fully configurable options as anchor positioning system.
  • 🎨 Fully customizable presence animation powered by Framer Motion.
  • ⚙️ Beautiful by default, with zero-config, and can be customized.
  • 📦 Light as a feather (~60kB).
  • 🏖 Easy to use, just wrap <Hint> around your component.
  • 📝 Written in TypeScript.
  • Read more.

📖 Documentation

For documentation about React Beacon Hint, please visit our website.

The documentation is automatically generated on every commit pushed to the main branch from the files in the website directory.

🔮 Inspiration

React Beacon Hint is heavily inspired by Floating UI.

🙋 Contributing

For help on setting up the repo locally, building, testing, and contributing please see CONTRIBUTING.md.

🧑‍💻 Code of Conduct

All developers who wish to contribute through code or issues, take a look at the CODE_OF_CONDUCT.md.

📃 License

This project is licensed under the MIT License - see the LICENSE.md file for details.