@react-hive/honey-layout 2.4.0 → 2.4.1

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

@@ -2,5 +2,24 @@ import { HoneyOverlayId, HoneyOverlayEventListenerHandler } from '../types';
 type UseHoneyOverlayOptions = {
     onKeyUp?: HoneyOverlayEventListenerHandler;
 };
+/**
+ * Hook to interact with a specific overlay managed by the `HoneyLayoutProvider`.
+ *
+ * @param targetOverlayId - The unique identifier of the overlay to interact with.
+ * @param options - Configuration options for the overlay, such as keyboard event handling.
+ *
+ * @returns The overlay object associated with the provided `targetOverlayId`, or `undefined` if not found.
+ *
+ * @example
+ * ```tsx
+ * const overlay = useHoneyOverlay('my-overlay-id', {
+ *   onKeyUp: (keyCode, e) => {
+ *     if (keyCode === 'Escape') {
+ *       console.log('Escape key pressed');
+ *     }
+ *   },
+ * });
+ * ```
+ */
 export declare const useHoneyOverlay: (targetOverlayId: HoneyOverlayId, { onKeyUp }?: UseHoneyOverlayOptions) => import('../types').HoneyOverlay | undefined;
 export {};

package/dist/types/types.d.ts

@@ -188,7 +188,7 @@ interface BaseHoneyColors {
  * Example of augmenting the colors interface.
  *
  * @example
- * ```typescript
+ * ```ts
  * declare module '@react-hive/honey-layout' {
  *  export interface HoneyColors {
  *    neutral: Record<'charcoalDark' | 'charcoalGray' | 'crimsonRed', HoneyCSSColor>;
@@ -207,7 +207,7 @@ export interface HoneyColors extends BaseHoneyColors {
  * @example
  *
  * Given the `HoneyColors` interface:
- * ```typescript
+ * ```ts
  * interface HoneyColors {
  *   primary: Record<'blue' | 'green', HoneyCSSColor>;
  *   neutral: Record<'charcoalDark' | 'charcoalGray' | 'crimsonRed', HoneyCSSColor>;
@@ -215,7 +215,7 @@ export interface HoneyColors extends BaseHoneyColors {
  * ```
  *
  * The resulting `HoneyColorKey` type will be:
- * ```typescript
+ * ```ts
  * type HoneyColorKey = 'neutral.charcoalDark' | 'neutral.charcoalGray' | 'neutral.crimsonRed' | 'primary.blue' | 'primary.green';
  * ```
  */
@@ -233,7 +233,7 @@ export type HoneyFont = {
  * Example of augmenting the fonts interface.
  *
  * @example
- * ```typescript
+ * ```ts
  * declare module '@react-hive/honey-layout' {
  *  export interface HoneyFonts {
  *    body: HoneyFont;

package/package.json

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