import type { Coords, Middleware, MiddlewareState } from '../types';
|
type OffsetValue = number | {
|
/**
|
* The axis that runs along the side of the floating element. Represents
|
* the distance (gutter or margin) between the reference and floating
|
* element.
|
* @default 0
|
*/
|
mainAxis?: number;
|
/**
|
* The axis that runs along the alignment of the floating element.
|
* Represents the skidding between the reference and floating element.
|
* @default 0
|
*/
|
crossAxis?: number;
|
/**
|
* The same axis as `crossAxis` but applies only to aligned placements
|
* and inverts the `end` alignment. When set to a number, it overrides the
|
* `crossAxis` value.
|
*
|
* A positive number will move the floating element in the direction of
|
* the opposite edge to the one that is aligned, while a negative number
|
* the reverse.
|
* @default null
|
*/
|
alignmentAxis?: number | null;
|
};
|
type OffsetFunction = (state: MiddlewareState) => OffsetValue;
|
export type Options = OffsetValue | OffsetFunction;
|
export declare function convertValueToCoords(state: MiddlewareState, value: Options): Promise<Coords>;
|
/**
|
* Modifies the placement by translating the floating element along the
|
* specified axes.
|
* A number (shorthand for `mainAxis` or distance), or an axes configuration
|
* object may be passed.
|
* @see https://floating-ui.com/docs/offset
|
*/
|
export declare const offset: (value?: Options) => Middleware;
|
export {};
|
