import { CallbackPositioner, Positioner, StringPositioner } from '@remirror/extension-positioner';
import { UseMultiPositionerReturn } from './use-multi-positioner';
interface UsePositionerReturnActive<Data = any> extends UseMultiPositionerReturn<Data> {
    /**
     * When `true`, the position is active and the positioner will be displayed.
     */
    active: true;
}
interface UsePositionerReturnInactive<Data = any> extends Omit<UseMultiPositionerReturn<Data>, 'ref' | 'data'> {
    /**
     * When `true`, the position is active and the positioner will be displayed.
     */
    active: false;
    /**
     * When active is `true` this will contain a ref that must be applied to the component that is
     * being positioned in order to correctly obtain the position data.
     * When active is `false` this will be undefined.
     */
    ref: undefined;
    /**
     * When active is `true` this will contain metadata associated with the position.
     * When active is `false` this we be an empty object.
     */
    data: Record<string, never>;
}
export type UsePositionerReturn<Data = any> = UsePositionerReturnActive<Data> | UsePositionerReturnInactive<Data>;
/**
 * A hook for creating a positioner with the `PositionerExtension`. When an
 * active position exists for the provided positioner it will return an object
 * with the `ref`, `top`, `left`, `bottom`, `right` properties.
 *
 * @param isActive - Set this to a boolean to override whether the positioner is
 * active. `true` leaves the behaviour unchanged.
 *
 * In a recent update, the positioner is now automatically memoized for you.
 *
 *
 * @remarks
 *
 * Must apply the ref to the component when called.
 *
 * ```ts
 * import { usePositioner } from '@remirror/react';
 *
 * const MenuComponent: FC = () => {
 *   const positions = usePositioner('bubble');
 *
 *   return (
 *     <div style={{ bottom, left }} ref={ref}>
 *       <MenuIcon {...options} />
 *     </div>
 *   );
 * }
 *
 * const Wrapper = () => (
 *   <Remirror extensions={[]}>
 *     <MenuComponent />
 *   </Remirror>
 * )
 * ```
 *
 * @param positioner - the positioner to use which can be a string or a
 * `Positioner` instance.
 * @param activeOrDeps - the dependency array which will cause the positioner to
 * be updated when changed or a boolean value when the positioner is a string
 * which can be used to override whether the positioner is active.
 */
export declare function usePositioner<Data = any>(positioner: StringPositioner, isActive?: boolean): UsePositionerReturn<Data>;
export declare function usePositioner<Data = any>(positioner: Positioner | CallbackPositioner, deps: unknown[]): UsePositionerReturn<Data>;
export {};