@react-hive/honey-layout 2.6.1 → 2.7.0

package/dist/components/HoneyOverlay.d.ts

@@ -1,11 +1,22 @@
 import { ReactNode, HTMLAttributes } from 'react';
 import { HoneyActiveOverlay, HoneyOverlayId, Nullable } from '../types';
 import { HoneyBoxProps } from './HoneyBox';
-export type HoneyOverlayProps = HTMLAttributes<HTMLDivElement> & HoneyBoxProps & {
+type OverlayContext = {
     /**
-     * The content of the overlay, either as static nodes or a function that receives the active overlay object.
+     * The current overlay instance, including methods and metadata for managing the overlay.
      */
-    children: ReactNode | ((overlay: Nullable<HoneyActiveOverlay>) => ReactNode);
+    overlay: Nullable<HoneyActiveOverlay>;
+    /**
+     * Function to deactivate the overlay. Typically, triggers the `onDeactivate` callback.
+     */
+    deactivateOverlay: () => void;
+};
+export type HoneyOverlayProps = Omit<HTMLAttributes<HTMLDivElement>, 'children'> & HoneyBoxProps & {
+    /**
+     * The content of the overlay, either as static nodes or a function that receives the object
+     * with the current overlay state and helper methods.
+     */
+    children: ReactNode | ((overlayContext: OverlayContext) => ReactNode);
     /**
      * Determines whether the overlay is currently active.
      */
@@ -15,13 +26,20 @@ export type HoneyOverlayProps = HTMLAttributes<HTMLDivElement> & HoneyBoxProps &
      */
     overlayId?: HoneyOverlayId;
     /**
-     * Callback invoked when the overlay is closed.
+     * Callback function invoked when the overlay is deactivated.
+     * Typically called when the "Escape" key is pressed or another user-defined action triggers deactivation.
      */
-    onClose: () => void;
+    onDeactivate: () => void;
 };
 /**
- * Component for creating overlays that can handle active states and keyboard interactions.
+ * A reusable overlay component that manages active states and keyboard interactions.
+ *
+ * The `HoneyOverlay` component integrates with the `useRegisterHoneyOverlay` hook to:
+ * - Automatically register/deregister the overlay.
+ * - Handle keyboard events, such as closing the overlay with the "Escape" key.
+ * - Provide a context to dynamically manage overlay content and state.
  *
- * @param {HoneyOverlayProps} props - The properties for configuring the overlay.
+ * @param {HoneyOverlayProps} props - The properties used to configure the overlay.
  */
-export declare const HoneyOverlay: ({ children, isActive, overlayId, onClose, ...props }: HoneyOverlayProps) => import("react/jsx-runtime").JSX.Element;
+export declare const HoneyOverlay: ({ children, isActive, overlayId, onDeactivate, ...props }: HoneyOverlayProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/index.js

@@ -1371,7 +1371,7 @@ const Mn = /* @__PURE__ */ Er(Dn), Fn = ({
   children: n,
   isActive: o,
   overlayId: i,
-  onClose: s,
+  onDeactivate: s,
   ...f
 }) => {
   const c = Wn(o, {
@@ -1383,7 +1383,10 @@ const Mn = /* @__PURE__ */ Er(Dn), Fn = ({
       [s]
     )
   });
-  return /* @__PURE__ */ G.jsx(St, { ref: c == null ? void 0 : c.setContainerRef, "aria-hidden": !o, ...f, children: typeof n == "function" ? n(c) : n });
+  return /* @__PURE__ */ G.jsx(St, { ref: c == null ? void 0 : c.setContainerRef, "aria-hidden": !o, ...f, children: typeof n == "function" ? n({
+    overlay: c,
+    deactivateOverlay: s
+  }) : n });
 }, Yn = () => {
   const [n, o] = xt([]);
   pe(() => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-hive/honey-layout",
-  "version": "2.6.1",
+  "version": "2.7.0",
   "description": "",
   "keywords": [
     "react",