UNPKG

914 BTypeScriptView Raw
1import { type ConditionalValue, type HTMLChakraProps, type SystemStyleObject } from "../../styled-system";
2export interface FloatOptions {
3 /**
4 * The x offset of the indicator
5 */
6 offsetX?: SystemStyleObject["left"];
7 /**
8 * The y offset of the indicator
9 */
10 offsetY?: SystemStyleObject["top"];
11 /**
12 * The x and y offset of the indicator
13 */
14 offset?: SystemStyleObject["top"];
15 /**
16 * The placement of the indicator
17 * @default "top-end"
18 */
19 placement?: ConditionalValue<"bottom-end" | "bottom-start" | "top-end" | "top-start" | "bottom-center" | "top-center" | "middle-center" | "middle-end" | "middle-start">;
20}
21export interface FloatProps extends Omit<HTMLChakraProps<"div">, keyof FloatOptions>, FloatOptions {
22}
23export declare const Float: import("react").ForwardRefExoticComponent<FloatProps & import("react").RefAttributes<HTMLDivElement>>;