@siberiacancode/reactuse 0.0.112 → 0.0.114

package/dist/types/hooks/useWindowScroll/useWindowScroll.d.ts

@@ -0,0 +1,19 @@
+export interface ScrollPosition {
+    x: number;
+    y: number;
+}
+export declare const scrollTo: ({ x, y, behavior }: Partial<ScrollPosition & ScrollOptions>) => void;
+/**
+ * @name useWindowScroll
+ * @description - Hook that manages the window scroll position
+ * @category Browser
+ *
+ * @returns {UseWindowScrollReturn} An object containing the current window scroll position
+ *
+ * @example
+ * const { value, scrollTo } = useWindowScroll();
+ */
+export declare const useWindowScroll: () => {
+    value: ScrollPosition;
+    scrollTo: ({ x, y, behavior }: Partial<ScrollPosition & ScrollOptions>) => void;
+};

package/dist/types/hooks/useWindowSize/useWindowSize.d.ts

@@ -0,0 +1,29 @@
+/** The use window size return type */
+interface UseWindowSizeParams {
+    /** Whether to include the scrollbar in the window size calculation */
+    includeScrollbar?: boolean;
+}
+/** The use window size return type */
+export interface UseWindowSizeReturn {
+    /** The current window height */
+    height: number;
+    /** The current window width */
+    width: number;
+}
+/**
+ * @name useWindowSize
+ * @description - Hook that manages a window size
+ * @category Elements
+ *
+ * @param {number} [params.initialWidth=Number.POSITIVE_INFINITY] The initial window width
+ * @param {number} [params.initialHeight=Number.POSITIVE_INFINITY] The initial window height
+ * @returns {UseWindowSizeReturn} An object containing the current window width and height
+ *
+ * @example
+ * const { width, height } = useWindowSize();
+ */
+export declare const useWindowSize: (params?: UseWindowSizeParams) => {
+    width: number;
+    height: number;
+};
+export {};

package/dist/types/hooks/useWizard/useWizard.d.ts

@@ -0,0 +1,27 @@
+export interface WizardItem<WizardStepId> {
+    id: WizardStepId;
+    nodes?: WizardStepId[];
+}
+/**
+ * @name useWizard
+ * @description - Hook that manages a wizard
+ * @category Utilities
+ *
+ * @param {WizardItem<WizardStepId>[]} map The map of the wizard
+ * @param {WizardStepId} [initialStepId] The initial step id
+ * @returns {UseWizardReturn<WizardStepId>} An object containing the current step id and functions to interact with the wizard
+ *
+ * @example
+ * const { currentStepId, set, reset, back, history } = useWizard([
+ *  { id: 'step1', nodes: ['step2', 'step3'] },
+ *  { id: 'step2', nodes: ['step3'] },
+ *  { id: 'step3', nodes: [] },
+ * ])
+ */
+export declare const useWizard: <WizardStepId extends string>(map: WizardItem<WizardStepId>[], initialStepId?: WizardStepId) => {
+    currentStepId: WizardStepId;
+    set: (id: WizardStepId) => void;
+    reset: () => void;
+    back: () => void;
+    history: WizardStepId[];
+};