@intility/bifrost-react/dist/hooks/useFloatingMessage.js

React library for Intility's design system, Bifrost.

"use client";

import { useContext } from "react";
import FloatingMessageContext from "../components/FloatingMessage/FloatingMessageContext.internal.js";

/**
 * 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() {
  return useContext(FloatingMessageContext);
}