@react-hive/honey-layout 1.0.0-beta → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -62,7 +62,7 @@ export type HoneyDragHandlers<Element extends HTMLElement> = {
62
62
  /**
63
63
  * A hook that provides touch and mouse-based dragging functionality for an element.
64
64
  * It tracks touch and mouse events, calculates dragging speed and distances during the drag,
65
- * and exposes `onStart`, `onMove`, and `onEnd` callbacks to handle various stages of dragging.
65
+ * and exposes `onStartDrag`, `onMoveDrag`, and `onEndDrag` callbacks to handle various stages of dragging.
66
66
  *
67
67
  * @param {MutableRefObject<Element>} draggableElementRef - A `ref` to the element that should be made draggable.
68
68
  * @param {HoneyDragHandlers<Element>} handlers - An object containing the callback functions for different dragging stages.
@@ -1,5 +1,5 @@
1
1
  import { HoneyScreenState } from '../types';
2
- type UseHoneyMediaQueryOptions = {
2
+ export type UseHoneyMediaQueryOptions = {
3
3
  /**
4
4
  * The delay in milliseconds before the resize event is processed.
5
5
  *
@@ -8,11 +8,12 @@ type UseHoneyMediaQueryOptions = {
8
8
  delay?: number;
9
9
  };
10
10
  /**
11
- * A hook for tracking the current screen state based on media queries defined in the theme.
11
+ * A custom hook that tracks the current screen state based on the theme's media breakpoints.
12
+ * It updates the state on window resize and orientation change.
12
13
  *
13
- * @param options - Optional configuration.
14
+ * @param options - Optional configuration object.
14
15
  *
15
- * @returns The current screen state.
16
+ * @returns The current screen state, indicating the orientation (portrait or landscape)
17
+ * and the active breakpoint (xs, sm, md, lg, xl).
16
18
  */
17
19
  export declare const useHoneyMediaQuery: ({ delay }?: UseHoneyMediaQueryOptions) => HoneyScreenState;
18
- export {};