https://github.com/renatodeleao/floating-ui-x

Implementation of [@floating-ui](https://github.com/floating-ui/floating-ui/) primitives for platforms other than React.
https://github.com/renatodeleao/floating-ui-x

floating-ui flyout popper svelte vue

Last synced: about 1 month ago
JSON representation

Implementation of [@floating-ui](https://github.com/floating-ui/floating-ui/) primitives for platforms other than React.

• Host: GitHub
• URL: https://github.com/renatodeleao/floating-ui-x
• Owner: renatodeleao
• License: mit
• Created: 2022-10-24T11:26:38.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-11-14T18:10:40.000Z (about 2 years ago)
• Last Synced: 2024-10-16T17:45:54.946Z (3 months ago)
• Topics: floating-ui, flyout, popper, svelte, vue
• Language: JavaScript
• Homepage:
• Size: 87.9 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# floating-ui-x

Implementation of [@floating-ui](https://github.com/floating-ui/floating-ui/) primitives for platforms other than React. 

## Goals

1. keep api as close as possible to the original package, so that we can leverage their existent documentation site. Exceptions can be made if platform has a fundamental different way of doing things.

1. make it good enough to request integration into `floating-ui` monorepo, because I don't deserve nor want the burden of maintaining this alone.

## No TypeScript?! 😱😱

I'm adding this chapter in the unlikely event of this getting shared somewhere. _Why aren't you writing this in TypeScript in 2022?! Are you mad mate?!_:

No, I just prioritize features over types **for the free time** I will spend on this. I've worked with TypeScript but I'm not a TypeScript jedi neither a fanboy. As such, I prefer to spend my **free effort** on keeping feature-parity with the original package than in finding solutions for the type hieroglyphs problems that come from consumers of "platform X"  package. The cost does not yet justifies the means, because typescript is **very** time consuming for library developers[^1], can be a barrier for contributors and this is just a personal project for now.

If you reading this and want TypeScript so badly, please note that I accept the corresponding type definitions files, and even kickstart this with some a few ones — _See i'm not that stubborn_. Happy to take any improvements on those. Here's some [guidelines](https://github.com/sindresorhus/typescript-definition-style-guide) on how to do it take some of the points with a pinch of salt. But as i've said before, if someone contributes with a cool feature that works but can't make `tsc` happy I will ship it anyways.

[^1]: https://erock.prose.sh/typescript-terrible-for-library-developers

## Motivation

Because poppers/tooltips/fly-outs are something I'll use in every web project during my dev career, independently of the tech stack, and popper.js (now floating-ui) is the best position engine out there.

## Acknowledgements

It started as a fork from https://github.com/allindevelopers/vue-floating-ui/pull/1