import { Position } from "./position.enum"; import { PositionAnchor } from "./position-anchor.enum"; /** Options that can be passed to `position()` method. */ export interface PositioningOptions { /** Indicates which point on the positioned element it should be positioned by. */ anchor?: PositionAnchor; /** * An array of pixel offsets. Each offset is applied * to the corresponding term in `position`. So to continue the above example of * `"bottom left"`, if the offsets are `[-7, 9]`, the element will be placed at * the bottom of the `relativeTo` element minus 7 pixels, and at the left of it * plus 9 pixels. (NB: The values will be converted to rem.) */ offsets?: number[]; /** * When using `relativeTo`, this describes the positioning relationship between * the two elements. For example, if it's `"bottom left"`, the positioned element * will be placed at the bottom left of the `relativeTo` element. */ position?: Position; /** * Normally, an element positioned by the service will simply have its current * position on the page locked in place. Instead you can have it positioned * relative to another element. */ relativeTo?: HTMLElement; /** * The width of the positioned element will be set to the width of the element * provided to the relativeTo option, rather than its own natural width. */ useRelativeTargetWidth?: boolean; /** Specify a z-index override for the positioned element. */ zIndex?: number; /** The element's ancestor that scrolls, if it's not the window itself */ scrollParent?: HTMLElement; } export declare const DEFAULT_POSITIONING_OPTIONS: PositioningOptions;