https://github.com/moh3n9595/react-beacon-hint

User Onboarding Component for React with Fully Configurable Options
https://github.com/moh3n9595/react-beacon-hint

beacon component floating-ui guide hint js onboarding popover popper react reactjs tour

Last synced: about 1 month ago
JSON representation

User Onboarding Component for React with Fully Configurable Options

• Host: GitHub
• URL: https://github.com/moh3n9595/react-beacon-hint
• Owner: moh3n9595
• License: mit
• Created: 2022-12-30T08:16:34.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-03-18T22:49:09.000Z (2 months ago)
• Last Synced: 2025-03-26T12:38:55.850Z (about 2 months ago)
• Topics: beacon, component, floating-ui, guide, hint, js, onboarding, popover, popper, react, reactjs, tour
• Language: TypeScript
• Homepage: https://react-beacon-hint.vercel.app
• Size: 4.15 MB
• Stars: 15
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
React Beacon Hint

User Onboarding Component for React with Fully Configurable Options



![CI/CD](https://github.com/moh3n9595/react-beacon-hint/actions/workflows/build.yml/badge.svg)

[![Codecov](https://codecov.io/gh/moh3n9595/react-beacon-hint/branch/main/graph/badge.svg?token=4L1NNC592T)](https://codecov.io/gh/moh3n9595/react-beacon-hint) [![CodeFactor](https://www.codefactor.io/repository/github/moh3n9595/react-beacon-hint/badge)](https://www.codefactor.io/repository/github/moh3n9595/react-beacon-hint)

[![NPM](https://img.shields.io/npm/v/react-beacon-hint.svg)](https://www.npmjs.com/package/react-beacon-hint)

[![Size](https://badgen.net/bundlephobia/minzip/react-beacon-hint)](https://bundlephobia.com/result?p=react-beacon-hint@latest)

[![GitHub contributors](https://img.shields.io/github/contributors/moh3n9595/react-beacon-hint.svg)](https://GitHub.com/moh3n9595/react-beacon-hint/contributors/)

[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/moh3n9595/react-beacon-hint/blob/master/LICENSE)

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-orange.svg)](https://github.com/moh3n9595/react-beacon-hint/compare)

[![Prettier](https://img.shields.io/badge/prettier-1A2C34?logo=prettier&logoColor=F7BA3E)](https://github.com/prettier/prettier)

[![EsLint](https://badges.aleen42.com/src/eslint.svg)](https://eslint.org/)

[![React](https://badges.aleen42.com/src/react.svg)](https://reactjs.org/)

[![Vite](https://badges.aleen42.com/src/vitejs.svg)](https://vitejs.dev/)

[![TS](https://badges.aleen42.com/src/typescript.svg)](https://www.typescriptlang.org/)

[![Demo](https://img.shields.io/github/deployments/moh3n9595/react-beacon-hint/Demo?label=Demo&logo=vercel)](https://react-beacon-hint.vercel.app/)

[![Documentation](https://img.shields.io/github/deployments/moh3n9595/react-beacon-hint/Documentation?label=Documentation&logo=vercel)](https://react-beacon-hint-doc.vercel.app/)





  





📄 Documentation   |   

🌐 Demo






## ✨ Features

- 🛠 Use [Floating UI](https://floating-ui.com/) (the evolution of Popper 2) with fully configurable options as anchor positioning system.

- ⚙️ Beautiful by default, with zero-config, and can be customized.

- 📦 Light as a feather (~60kB).

- 🏖 Easy to use, just wrap `` around your component.

- 📝 Written in `TypeScript`.

- [Read more](https://react-beacon-hint-doc.vercel.app/getting-started/installation).

## 📖 Documentation

For documentation about React Beacon Hint, please visit [our website](https://react-beacon-hint-doc.vercel.app).

The documentation is automatically generated on every commit pushed to the `main` branch from the files in [the `website` directory](website).

## 🔮 Inspiration

React Beacon Hint is heavily inspired by [Floating UI](https://floating-ui.com/).

## 🙋 Contributing

For help on setting up the repo locally, building, testing, and contributing

please see [CONTRIBUTING.md](https://github.com/moh3n9595/react-beacon-hint/blob/master/CONTRIBUTING.md).

## 🧑‍💻 Code of Conduct

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

[CODE_OF_CONDUCT.md](https://github.com/moh3n9595/react-beacon-hint/blob/master/CODE_OF_CONDUCT.md).

## 📃 License

This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/moh3n9595/react-beacon-hint/blob/master/LICENSE) file for details.

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    

      
Mohsen
💻 🚧 ⚠️ 📖

    

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!