idevelop / floating-ui Goto Github PK

Popper is now Floating UI! For Popper v2, visit its dedicated branch. For help on migrating, check out the Migration Guide.

Floating UI is a tiny, low-level library for creating "floating" elements like tooltips, popovers, dropdowns, menus, and more.

The library provides two key functionalities:

Anchor a floating element (like a tooltip) to another element (like a button) while simultaneously ensuring it stays in view as best as possible with collision detection.

Hooks and components for composing interactions to create accessible floating UI components.

Floating UI is platform-agnostic and supports a variety of platforms.

Use on the web with vanilla JavaScript (view tutorial).

npm install @floating-ui/dom

Use with React DOM or React Native.

# React DOM — positioning + interactions
npm install @floating-ui/react

# React DOM — positioning only
npm install @floating-ui/react-dom

# React Native — positioning only
npm install @floating-ui/react-native

Use with Vue.

npm install @floating-ui/vue

If you're targeting a platform other than the vanilla DOM (web), React, or React Native, you can create your own Platform.

This allows you to support things like Canvas/WebGL, or other platforms that can run JavaScript.

npm install @floating-ui/core

import {computePosition} from '@floating-ui/dom';

const referenceElement = document.querySelector('#button');
const floatingElement = document.querySelector('#tooltip');

function applyStyles({x = 0, y = 0, strategy = 'absolute'}) {
  Object.assign(floatingElement.style, {
    position: strategy,
    left: `${x}px`,
    top: `${y}px`,
  });
}

applyStyles();

computePosition(referenceElement, floatingElement, {
  placement: 'right',
}).then(applyStyles);

Visit the docs for detailed information.

Using webpack, Vite, or Parcel? Skip this section as modern bundlers handle this for you.

Floating UI uses process.env.NODE_ENV to determine whether your build is in development or production mode. This allows us to add console warnings and errors during development to help you but ensure they get stripped out in production to keep the bundle size small.

This causes an error in Rollup and low/no-build setups. To solve this, Floating UI exports browser-ready ES modules. Leverage the "browser" package export condition to use these modules.

import {nodeResolve} from '@rollup/plugin-node-resolve';

export default {
  // ...
  plugins: [
    nodeResolve({
      browser: true,

      // Add this line for development config, omit for
      // production config
      exportConditions: ['development'],
    }),
  ],
};

This project is a monorepo written in TypeScript using npm workspaces. The website is using Next.js SSG and Tailwind CSS for styling.

• Fork and clone the repo
• Install dependencies in root directory with npm install
• Build initial package dist files with npm run build

npm -w packages/dom run dev in the root will launch the @floating-ui/dom development visual tests at http://localhost:1234. The playground uses React to write each test route, bundled by Parcel.

Each route has screenshots taken of the page by Playwright to ensure all the functionalities work as expected; this is an easy, reliable and high-level way of testing the code.

Below the main container are UI controls to turn on certain state and options. Every single combination of state is tested visually via the snapshots to cover as much as possible.

The floating shapes in the banner image are made by the amazing artists @artstar3d, @killnicole and @liiiiiiii on Figma — check out their work!

MIT