@intility/bifrost-react/dist/hooks/useFloatingMessage.d.ts

React library for Intility's design system, Bifrost.

/**
 * Hook for accessing `<FloatingMessage>` `showFloatingMessage()` method
 *
 * @returns An object containing:
 *   - `showFloatingMessage`: Function to display a message.
 *
 * @see https://bifrost.intility.com/react/useFloatingMessage
 * @see https://bifrost.intility.com/react/floatingMessage
 *
 * @example
 * import useFloatingMessage from "@intility/bifrost-react/hooks/useFloatingMessage";
 *
 * // from a component wrapped by `<FloatingMessage>`
 * const { showFloatingMessage } = useFloatingMessage();
 *
 * // show a simple message
 * showFloatingMessage("Hello world!");
 */
export default function useFloatingMessage(): {
    showFloatingMessage: import("../components/FloatingMessage/FloatingMessageContext.internal.js").ShowFloatingMessageFn;
    removeFloatingMessage?: () => void;
    _stack?: import("../components/FloatingMessage/FloatingMessage.js").FloatingMessageProps & {
        messages: import("../components/FloatingMessage/FloatingMessage.js").FloatingMessageType[];
        setMessages: React.Dispatch<React.SetStateAction<import("../components/FloatingMessage/FloatingMessage.js").FloatingMessageType[]>>;
        removeMessageByReference: (message: import("../components/FloatingMessage/FloatingMessage.js").FloatingMessageType) => void;
    };
};