You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
41 lines
1.5 KiB
41 lines
1.5 KiB
import type { FloatingElement, ReferenceElement } from './types'; |
|
export type AutoUpdateOptions = Partial<{ |
|
/** |
|
* Whether to update the position when an overflow ancestor is scrolled. |
|
* @default true |
|
*/ |
|
ancestorScroll: boolean; |
|
/** |
|
* Whether to update the position when an overflow ancestor is resized. This |
|
* uses the native `resize` event. |
|
* @default true |
|
*/ |
|
ancestorResize: boolean; |
|
/** |
|
* Whether to update the position when either the reference or floating |
|
* elements resized. This uses a `ResizeObserver`. |
|
* @default true |
|
*/ |
|
elementResize: boolean; |
|
/** |
|
* Whether to update the position when the reference relocated on the screen |
|
* due to layout shift. |
|
* @default true |
|
*/ |
|
layoutShift: boolean; |
|
/** |
|
* Whether to update on every animation frame if necessary. Only use if you |
|
* need to update the position in response to an animation using transforms. |
|
* @default false |
|
*/ |
|
animationFrame: boolean; |
|
}>; |
|
/** |
|
* Automatically updates the position of the floating element when necessary. |
|
* Should only be called when the floating element is mounted on the DOM or |
|
* visible on the screen. |
|
* @returns cleanup function that should be invoked when the floating element is |
|
* removed from the DOM or hidden from the screen. |
|
* @see https://floating-ui.com/docs/autoUpdate |
|
*/ |
|
export declare function autoUpdate(reference: ReferenceElement, floating: FloatingElement, update: () => void, options?: AutoUpdateOptions): () => void;
|
|
|