@mantine/hooks 9.0.1 → 9.1.0

package/lib/use-roving-index/use-roving-index.d.ts

@@ -0,0 +1,49 @@
+export interface UseRovingIndexInput {
+    /** Total number of items in the group */
+    total: number;
+    /** Which arrow keys navigate, `'horizontal'` by default */
+    orientation?: 'horizontal' | 'vertical' | 'both';
+    /** Whether navigation wraps at boundaries, `true` by default */
+    loop?: boolean;
+    /** Text direction, `'ltr'` by default */
+    dir?: 'rtl' | 'ltr';
+    /** Whether to click element when it receives focus via keyboard, `false` by default */
+    activateOnFocus?: boolean;
+    /** Number of columns for grid (2D) navigation. When set, enables grid mode */
+    columns?: number;
+    /** Controlled focused index */
+    focusedIndex?: number;
+    /** Initial focused index for uncontrolled mode, first non-disabled item by default */
+    initialIndex?: number;
+    /** Called when focused index changes */
+    onFocusChange?: (index: number) => void;
+    /** Function to check if item at given index is disabled, `() => false` by default */
+    isItemDisabled?: (index: number) => boolean;
+}
+export interface UseRovingIndexGetItemPropsInput {
+    /** Index of the item in the group */
+    index: number;
+    /** Called when item is clicked */
+    onClick?: React.MouseEventHandler;
+    /** Called when keydown event fires on item */
+    onKeyDown?: React.KeyboardEventHandler;
+}
+export interface UseRovingIndexReturnValue {
+    /** Get props to spread on each navigable item */
+    getItemProps: (options: UseRovingIndexGetItemPropsInput) => {
+        tabIndex: 0 | -1;
+        onKeyDown: React.KeyboardEventHandler;
+        onClick: React.MouseEventHandler;
+        ref: React.RefCallback<HTMLElement>;
+    };
+    /** Currently focused index */
+    focusedIndex: number;
+    /** Programmatically set focused index */
+    setFocusedIndex: (index: number) => void;
+}
+export declare function useRovingIndex(input: UseRovingIndexInput): UseRovingIndexReturnValue;
+export declare namespace useRovingIndex {
+    type Input = UseRovingIndexInput;
+    type GetItemPropsInput = UseRovingIndexGetItemPropsInput;
+    type ReturnValue = UseRovingIndexReturnValue;
+}

package/lib/use-scroll-into-view/use-scroll-into-view.d.ts

@@ -5,6 +5,8 @@ interface UseScrollIntoViewAnimation {
 export interface UseScrollIntoViewOptions {
     /** Callback fired after scroll */
     onScrollFinish?: () => void;
+    /** Callback fired when scroll animation is canceled by user interaction */
+    onScrollCancel?: () => void;
     /** Duration of scroll in milliseconds */
     duration?: number;
     /** Axis of scroll */
@@ -23,8 +25,9 @@ export interface UseScrollIntoViewReturnValue<Target extends HTMLElement = any,
     targetRef: React.RefObject<Target | null>;
     scrollIntoView: (params?: UseScrollIntoViewAnimation) => void;
     cancel: () => void;
+    scrolling: boolean;
 }
-export declare function useScrollIntoView<Target extends HTMLElement = any, Parent extends HTMLElement | null = null>({ duration, axis, onScrollFinish, easing, offset, cancelable, isList, }?: UseScrollIntoViewOptions): UseScrollIntoViewReturnValue<Target, Parent>;
+export declare function useScrollIntoView<Target extends HTMLElement = any, Parent extends HTMLElement | null = null>({ duration, axis, onScrollFinish, onScrollCancel, easing, offset, cancelable, isList, }?: UseScrollIntoViewOptions): UseScrollIntoViewReturnValue<Target, Parent>;
 export declare namespace useScrollIntoView {
     type Options = UseScrollIntoViewOptions;
     type ReturnValue<Target extends HTMLElement, Parent extends HTMLElement | null> = UseScrollIntoViewReturnValue<Target, Parent>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mantine/hooks",
-  "version": "9.0.1",
+  "version": "9.1.0",
   "description": "A collection of 50+ hooks for state and UI management",
   "homepage": "https://mantine.dev",
   "license": "MIT",