Floating UI Options #

placement #

Floating positioning placement:

<Float placement="left-start">

All 12 placement in the Floating UI can be used:

• top
• top-start
• top-end
• right
• right-start
• right-end
• bottom
• bottom-start
• bottom-end
• left
• left-start
• left-end

strategy #

The type of CSS position property, absolute or fixed:

<Float strategy="fixed">

offset #

The offset (px) of the floating element from the reference element:

<Float offset={8}>

shift #

Move the reference elements back into the view:

<Float shift>

Set the offset (px) of the floating element from the view border:

<Float shift={8}>

flip #

Change to the opposite placement to keep it in view:

<Float flip>

Sets the minimum padding (px) of the floating element from the view border when flip:

<Float flip={10}>

autoPlacement #

Floating elements choose the placement with more space left:

<Float autoPlacement>

hide v0.13+ #

When the reference element is not visible, will apply the class of referenceHiddenClass, which can add the invisible class to hide the floating element:

<Float
  hide
  referenceHiddenClass="invisible"
>

You can also use another strategy, which is to apply the class of escapedClass if you can't see the floating element:

<Float
  hide={{ strategy: 'escaped' }}
  escapedClass="opacity-50"
>

When you want to use two strategies, you can pass in an array:

<Float
  hide={[{}, { strategy: 'escaped' }]}
>

autoUpdate #

Automatically update floating elements when needed, the default value is true. Can be set to false to disable autoUpdate:

<Float autoUpdate={false}>

middleware #

If the above basic settings do not satisfy your needs, you can add the Floating UI middleware yourself:

import { offset } from '@floating-ui/react-dom'

const middleware = [
  offset({
    mainAxis: 10,
    crossAxis: 6,
  }),
]

<Float middleware={middleware}>

Or pass a function to get reference elements and floating elements in the parameters:

const middleware = ({ referenceEl, floatingEl }) => [
  ...
]