import { Alignment, Placement, Side, autoUpdate, offset as flOffset, flip, shift, useFloating, } from "@floating-ui/react"; import React, { HTMLAttributes, forwardRef } from "react"; import { useModalContext } from "../modal/Modal.context"; import { omit, useClientLayoutEffect } from "../utils-external"; import { DismissableLayer } from "../utils/components/dismissablelayer/DismissableLayer"; import { cl } from "../utils/helpers"; import { useMergeRefs } from "../utils/hooks"; import PopoverContent, { PopoverContentType } from "./PopoverContent"; export interface PopoverProps extends HTMLAttributes { /** * Popover content */ children: React.ReactNode; /** * Element popover anchors to */ anchorEl: Element | null; /** * Open state */ open: boolean; /** * onClose callback */ onClose: () => void; /** * Default orientation of popover * * Try to keep general usage to "top", "bottom", "left", "right". * @default "top" */ placement?: | "top" | "bottom" | "right" | "left" | "top-start" | "top-end" | "bottom-start" | "bottom-end" | "right-start" | "right-end" | "left-start" | "left-end"; /** * @deprecated No longer has any effect. */ arrow?: boolean; /** * Distance from anchor to popover * @default 8 */ offset?: number; /** * Changes what CSS position property to use * You want to use "fixed" if reference element is inside a fixed container, but popover is not * @default "absolute" */ strategy?: "absolute" | "fixed"; /** * Changes placement of the floating element in order to keep it in view. * @default true */ flip?: boolean; } interface PopoverComponent extends React.ForwardRefExoticComponent< PopoverProps & React.RefAttributes > { Content: PopoverContentType; } /** * A component that displays a popover. * * @see [📝 Documentation](https://aksel.nav.no/komponenter/core/popover) * @see 🏷️ {@link PopoverProps} * * @example * ```jsx * * setOpenState(false)} * anchorEl={buttonRef.current} * > * Innhold her! * * ``` */ export const Popover = forwardRef( ( { className, children, anchorEl, open, onClose, placement = "top", offset, strategy: userStrategy, flip: _flip = true, ...restProps }, ref, ) => { const isInModal = useModalContext(false) !== undefined; const chosenStrategy = userStrategy ?? (isInModal ? "fixed" : "absolute"); const { update, refs, placement: flPlacement, floatingStyles, } = useFloating({ strategy: chosenStrategy, placement, open, middleware: [ flOffset(offset ?? 8), _flip && flip({ padding: 5, fallbackPlacements: getOppositePlacement(placement), }), shift({ padding: 12 }), ], }); useClientLayoutEffect(() => { refs.setReference(anchorEl); }, [anchorEl, refs]); const floatingRef = useMergeRefs(refs.setFloating, ref); useClientLayoutEffect(() => { if (!refs.reference.current || !refs.floating.current || !open) return; const cleanup = autoUpdate( refs.reference.current, refs.floating.current, update, ); return () => cleanup(); }, [refs.floating, refs.reference, update, open, anchorEl]); return ( open && onClose?.()} enabled={open} >
{children}
); }, ) as PopoverComponent; const oppositeSideMap: Record = { top: "bottom", bottom: "top", left: "right", right: "left", }; /** * If placement is side+alignment, we want to preserve the alignment * when flipping to the opposite side. */ function getOppositePlacement(placement: Placement): Placement[] { /** * In most cases, the fallback for left/right should be top/bottom * as there is usually more space vertically than horizontally. */ if (placement.startsWith("left") || placement.startsWith("right")) { return ["bottom", "top"]; } const [side, alignment] = placement.split("-") as [Side, Alignment?]; const oppositeSide = oppositeSideMap[side]; return [alignment ? `${oppositeSide}-${alignment}` : oppositeSide]; } Popover.Content = PopoverContent; export default Popover;