Skip to content
On this page

快速開始

安裝

套件相依於 ReactReact DOMHeadless UI React,記得需要先安裝。

# npm
npm i @headlessui-float/react
# yarn
yarn add @headlessui-float/react

線上 Demo

開始使用

先去找一個需要自動定位元素位置的 Headless UI 元件,比如這裡用 <Menu> 元件來示範。引入 <Float> 元件:

import { Float } from '@headlessui-float/react'

然後在 <Menu.Button><Menu.Items> 外包一層 <Float>

<Menu>
+ <Float>
    <Menu.Button className="...">
      Options
    </Menu.Button>

    <Menu.Items className="...">
      ...
    </Menu.Items>
+ </Float>
</Menu>

需要注意,<Float> 必須包含2個子元素,第1個是參考元素,第2個是浮動元素。可以使用 Headless UI 元件或 HTML 元素。

如果要使用 HTML 元素,或手動控制 Headless UI 元件的顯示,請參考 顯示/隱藏

然後刪除掉 <Menu.Items>absoluteright-0 等定位 class,並加上 placement="bottom-end" 屬性:

<Menu>
  <Float placement="bottom-end">
    ...
  </Float>
</Menu>

刪除掉 <Menu.Items>mt-2 class,並加上 offset={4} 屬性:

<Menu>
  <Float placement="bottom-end" offset={4}>
    ...
  </Float>
</Menu>

然後 <Menu> 就可以自動定位內部的 <Menu.Items> 元件了。

除了 <Menu> 之外,同樣也可以用在 <Listbox><Popover><Combobox> 元件上,你可以使用 <Float> 在任何需要浮動定位的元素上。

快速開始 has loaded