@react-hive/honey-layout 2.4.1 → 2.6.0

package/dist/components/HoneyOverlay.d.ts

@@ -0,0 +1,28 @@
+import { ReactNode, HTMLAttributes } from 'react';
+import { HoneyActiveOverlay, HoneyOverlayId, Nullable } from '../types';
+import { HoneyBoxProps } from './HoneyBox';
+type HoneyOverlayProps = HTMLAttributes<HTMLDivElement> & HoneyBoxProps & {
+    /**
+     * The content of the overlay, either as static nodes or a function that receives the active overlay object.
+     */
+    children: ReactNode | ((overlay: Nullable<HoneyActiveOverlay>) => ReactNode);
+    /**
+     * Determines whether the overlay is currently active.
+     */
+    isActive: boolean;
+    /**
+     * An optional unique identifier for the overlay.
+     */
+    overlayId?: HoneyOverlayId;
+    /**
+     * Callback invoked when the overlay is closed.
+     */
+    onClose: () => void;
+};
+/**
+ * Component for creating overlays that can handle active states and keyboard interactions.
+ *
+ * @param {HoneyOverlayProps} props - The properties for configuring the overlay.
+ */
+export declare const HoneyOverlay: ({ children, isActive, overlayId, onClose, ...props }: HoneyOverlayProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/components/index.d.ts

@@ -6,3 +6,4 @@ export * from './HoneyList';
 export * from './HoneyLoopingList';
 export * from './HoneyStatusContent';
 export * from './HoneyLazyContent';
+export * from './HoneyOverlay';

package/dist/contexts/HoneyLayoutContext.d.ts

@@ -1,5 +1,5 @@
 import { DefaultTheme, Interpolation } from 'styled-components';
-import { HoneyColorKey, HoneyCSSColor, HoneyDimensionName, HoneyFontName, HoneyOverlayConfig, HoneySpacings, Nullable, HoneyScreenState, HoneyCSSDimensionUnit, HoneyCSSDimensionValue, HoneyCSSMultiValue, HoneyOverlayId, HoneyOverlay } from '../types';
+import { HoneyColorKey, HoneyCSSColor, HoneyDimensionName, HoneyFontName, HoneyOverlayConfig, HoneySpacings, Nullable, HoneyScreenState, HoneyCSSDimensionUnit, HoneyCSSDimensionValue, HoneyCSSMultiValue, HoneyOverlayId, HoneyActiveOverlay } from '../types';
 import { ResolveSpacingResult } from '../helpers';
 /**
  * Function to unregister a previously registered overlay.
@@ -10,7 +10,7 @@ export type HoneyUnregisterOverlay = (targetOverlayId: HoneyOverlayId) => void;
  *
  * @param {HoneyOverlayConfig} overlayConfig - Configuration object for the overlay.
  */
-export type HoneyRegisterOverlay = (overlayConfig: HoneyOverlayConfig) => HoneyOverlay;
+export type HoneyRegisterOverlay = (overlayConfig: HoneyOverlayConfig) => HoneyActiveOverlay;
 export type HoneyLayoutContextValue = {
     /**
      * Represents the theme object.
@@ -21,9 +21,9 @@ export type HoneyLayoutContextValue = {
      */
     screenState: HoneyScreenState;
     /**
-     * Overlays.
+     * Active overlays.
      */
-    overlays: HoneyOverlay[];
+    overlays: HoneyActiveOverlay[];
     /**
      * Function to register a new overlay.
      */

package/dist/helpers/dom.helpers.d.ts

@@ -0,0 +1 @@
+export declare const getFocusableHTMLElements: (container: HTMLElement, selectors?: string[]) => NodeListOf<HTMLElement>;

package/dist/{helpers.d.ts → helpers/helpers.d.ts}

@@ -1,6 +1,6 @@
 import { HTMLAttributes } from 'react';
 import { ExecutionContext, StyleFunction, css } from 'styled-components';
-import { Nullable, HoneyBreakpointName, HoneyCSSArrayValue, HoneyCSSDimensionShortHandValue, HoneyCSSDimensionUnit, HoneyCSSMultiValue, HoneyCSSMediaRule, HoneySpacings, HoneyColorKey, HoneyFontName, HoneyCSSColor, HoneyDimensionName, HoneyPrefixedCSSProperties, HoneyBreakpoints, HoneyScreenState, HoneyCSSDimensionValue } from './types';
+import { Nullable, HoneyBreakpointName, HoneyCSSArrayValue, HoneyCSSDimensionShortHandValue, HoneyCSSDimensionUnit, HoneyCSSMultiValue, HoneyCSSMediaRule, HoneySpacings, HoneyColorKey, HoneyFontName, HoneyCSSColor, HoneyDimensionName, HoneyPrefixedCSSProperties, HoneyBreakpoints, HoneyScreenState, HoneyCSSDimensionValue } from '../types';
 export declare const generateUniqueId: () => string;
 /**
  * Conditional type to determine the return type of the `resolveSpacing` function.

package/dist/helpers/index.d.ts

@@ -0,0 +1,3 @@
+export * from './dom.helpers';
+export * from './react.helpers';
+export * from './helpers';

package/dist/helpers/react.helpers.d.ts

@@ -0,0 +1,2 @@
+import { IStyleSheetManager } from 'styled-components';
+export declare const shouldForwardProp: IStyleSheetManager['shouldForwardProp'];

package/dist/hooks/use-honey-overlay.d.ts

@@ -21,5 +21,5 @@ type UseHoneyOverlayOptions = {
  * });
  * ```
  */
-export declare const useHoneyOverlay: (targetOverlayId: HoneyOverlayId, { onKeyUp }?: UseHoneyOverlayOptions) => import('../types').HoneyOverlay | undefined;
+export declare const useHoneyOverlay: (targetOverlayId: HoneyOverlayId, { onKeyUp }?: UseHoneyOverlayOptions) => import('../types').HoneyActiveOverlay | undefined;
 export {};

package/dist/hooks/use-register-honey-overlay.d.ts

@@ -1,2 +1,10 @@
-import { HoneyOverlay, HoneyOverlayConfig, Nullable } from '../types';
-export declare const useRegisterHoneyOverlay: (isRegister: boolean, overlayConfig: HoneyOverlayConfig) => Nullable<HoneyOverlay>;
+import { HoneyActiveOverlay, HoneyOverlayConfig, Nullable } from '../types';
+/**
+ * A hook for registering and managing an overlay in the layout system.
+ *
+ * @param {boolean} isRegister - A flag indicating whether the overlay should be registered.
+ * @param {HoneyOverlayConfig} overlayConfig - Configuration object specifying overlay behavior.
+ *
+ * @returns {Nullable<HoneyActiveOverlay>} - The registered overlay instance, or null if not registered.
+ */
+export declare const useRegisterHoneyOverlay: (isRegister: boolean, overlayConfig: HoneyOverlayConfig) => Nullable<HoneyActiveOverlay>;