@himanshu-sorathiya/react-kit 1.0.16 → 1.0.18

package/dist/events.d.ts

@@ -0,0 +1,32 @@
+// Generated by dts-bundle-generator v9.5.1
+
+import { RefObject } from 'react';
+
+declare const validKeyEventTypes: readonly [
+	"keydown",
+	"keyup",
+	"keypress"
+];
+export type KeyEventType = (typeof validKeyEventTypes)[number];
+export interface BaseKeyOptions {
+	enabled?: boolean;
+	target?: RefObject<HTMLElement | null> | Window;
+	preventDefault?: boolean;
+	stopPropagation?: boolean;
+	ignoreWhenFocusedInInputs?: boolean;
+	ctrlKey?: boolean;
+	shiftKey?: boolean;
+	altKey?: boolean;
+	metaKey?: boolean;
+}
+export type KeyOptions = BaseKeyOptions & ({
+	eventType?: "keydown" | "keypress";
+	preventRepeat?: boolean;
+} | {
+	eventType: "keyup";
+	preventRepeat?: never;
+});
+export type UseKeyReturn = void;
+export declare function useKey(key: string, handler: (e: KeyboardEvent) => void, { enabled, preventDefault, stopPropagation, eventType, preventRepeat, ignoreWhenFocusedInInputs, ctrlKey, shiftKey, altKey, metaKey, target, }?: KeyOptions): UseKeyReturn;
+
+export {};

package/dist/events.js

@@ -0,0 +1,2 @@
+import { t as e } from "./events2.js";
+export { e as useKey };

package/dist/events2.js

@@ -0,0 +1,54 @@
+import { useEffect as e, useLayoutEffect as t, useRef as n } from "react";
+//#region src/events/useKey/constants.ts
+var r = [
+	"keydown",
+	"keyup",
+	"keypress"
+];
+//#endregion
+//#region src/events/useKey/useKey.ts
+function i(i, a, { enabled: o = !0, preventDefault: s = !0, stopPropagation: c = !0, eventType: l = "keydown", preventRepeat: u = !1, ignoreWhenFocusedInInputs: d = !0, ctrlKey: f = !1, shiftKey: p = !1, altKey: m = !1, metaKey: h = !1, target: g = window } = {}) {
+	let _ = n(a), v = n(o), y = n(!1);
+	t(() => {
+		_.current = a;
+	}, [a]), e(() => {
+		v.current = o;
+	}, [o]), e(() => {
+		let e = g && "current" in g ? g.current : g;
+		if (!e) return;
+		let t = i.toLowerCase(), n = r.includes(l) ? l : "keydown", a = u && n !== "keyup";
+		function o() {
+			y.current = !1;
+		}
+		function b(e) {
+			if (!(e instanceof KeyboardEvent)) return;
+			let n = e.key.toLowerCase();
+			(n === t || f && n === "control" || p && n === "shift" || m && n === "alt" || h && n === "meta") && (y.current = !1);
+		}
+		function x(e) {
+			if (!(e instanceof KeyboardEvent) || !v.current) return;
+			let n = e.target;
+			if (!(d && n instanceof HTMLElement && (n instanceof HTMLInputElement || n instanceof HTMLTextAreaElement || n instanceof HTMLSelectElement || n.isContentEditable)) && e.ctrlKey === f && e.shiftKey === p && e.altKey === m && e.metaKey === h && t === e.key.toLowerCase()) {
+				if (a && y.current) return;
+				y.current = !0, _.current(e), s && e.preventDefault(), c && e.stopPropagation();
+			}
+		}
+		return e.addEventListener(n, x), a && (e.addEventListener("keyup", b), window.addEventListener("blur", o)), () => {
+			e.removeEventListener(n, x), a && (e.removeEventListener("keyup", b), window.removeEventListener("blur", o));
+		};
+	}, [
+		i,
+		s,
+		c,
+		l,
+		u,
+		d,
+		f,
+		p,
+		m,
+		h,
+		g
+	]);
+}
+//#endregion
+export { i as t };

package/dist/index.d.ts

@@ -3,22 +3,57 @@
 import React$1 from 'react';
 import { CSSProperties, RefObject } from 'react';
 
-export interface FuzzyHighlighterProps {
-	text: string;
-	query: string;
-	className?: string;
-	caseSensitive?: boolean;
+declare const validKeyEventTypes: readonly [
+	"keydown",
+	"keyup",
+	"keypress"
+];
+export type KeyEventType = (typeof validKeyEventTypes)[number];
+export interface BaseKeyOptions {
+	enabled?: boolean;
+	target?: React$1.RefObject<HTMLElement | null> | Window;
+	preventDefault?: boolean;
+	stopPropagation?: boolean;
+	ignoreWhenFocusedInInputs?: boolean;
+	ctrlKey?: boolean;
+	shiftKey?: boolean;
+	altKey?: boolean;
+	metaKey?: boolean;
 }
-export declare function FuzzyHighlighter({ text, query, className, caseSensitive, }: FuzzyHighlighterProps): React$1.JSX.Element;
-export interface ModalLayoutProps {
-	modalId: string;
-	children: React$1.ReactNode;
-	wrapperClassName?: string;
-	wrapperStyle?: React$1.CSSProperties;
-	containerClassName?: string;
-	containerStyle?: React$1.CSSProperties;
+export type KeyOptions = BaseKeyOptions & ({
+	eventType?: "keydown" | "keypress";
+	preventRepeat?: boolean;
+} | {
+	eventType: "keyup";
+	preventRepeat?: never;
+});
+export type UseKeyReturn = void;
+export declare function useKey(key: string, handler: (e: KeyboardEvent) => void, { enabled, preventDefault, stopPropagation, eventType, preventRepeat, ignoreWhenFocusedInInputs, ctrlKey, shiftKey, altKey, metaKey, target, }?: KeyOptions): UseKeyReturn;
+export interface DebounceOptions {
+	maxWait?: number;
+	leading?: boolean;
+	trailing?: boolean;
 }
-export declare function ModalLayout({ modalId, children, wrapperClassName, wrapperStyle, containerClassName, containerStyle, }: ModalLayoutProps): import("react").ReactPortal | null;
+export interface UseDebounceReturn<Args extends any[]> {
+	debouncedFunc: (...args: Args) => void;
+	cancel: () => void;
+	flush: () => void;
+	isPending: boolean;
+}
+export declare function useDebounce<Args extends any[]>(func: (...args: Args) => void, delay: number, options?: DebounceOptions): UseDebounceReturn<Args>;
+export type UseDebouncedValueReturn<T> = T;
+export declare function useDebouncedValue<T>(value: T, delay: number, options?: DebounceOptions): UseDebouncedValueReturn<T>;
+export interface ThrottleOptions {
+	leading?: boolean;
+	trailing?: boolean;
+}
+export interface UseThrottleReturn<Args extends any[]> {
+	throttledFunc: (...args: Args) => void;
+	cancel: () => void;
+	flush: () => void;
+	isPending: boolean;
+}
+export declare function useThrottle<Args extends any[]>(func: (...args: Args) => void, delay: number, options?: ThrottleOptions): UseThrottleReturn<Args>;
 export type FilterType = "text" | "number" | "boolean" | "date" | "select" | "multiselect" | "custom";
 export type TextOperator = "contains" | "equals" | "startsWith" | "endsWith" | "notContains";
 export type NumberOperator = "equals" | "greaterThan" | "lessThan" | "greaterThanOrEqual" | "lessThanOrEqual" | "between";
@@ -141,24 +176,6 @@ export declare function useGrouping<T = unknown>({ items, initialGroupBy, }: {
 	items: T[];
 	initialGroupBy?: string;
 }): UseGroupingReturn<T>;
-export interface UsePaginationReturn<T> {
-	pageItems: T[];
-	pageSize: number;
-	pageIndex: number;
-	totalPages: number;
-	canPrevious: boolean;
-	canNext: boolean;
-	nextPage: () => void;
-	previousPage: () => void;
-	goToFirstPage: () => void;
-	goToLastPage: () => void;
-	goToPage: (newPageIndex: number) => void;
-	changePageSize: (newPageSize: number) => void;
-	resetPageIndex: () => void;
-	resetPageSize: () => void;
-	resetPagination: () => void;
-}
-export declare function usePagination<T>(data: T[], initialPageSize: number, initialPageIndex?: number): UsePaginationReturn<T>;
 export type SelectionId = string | number;
 export interface UseMultipleSelectionReturn<T> {
 	selectedIds: SelectionId[];
@@ -184,17 +201,6 @@ export declare function useMultipleSelection<T = unknown>({ items, field, initia
 	field?: string;
 	initialSelectedIds?: SelectionId[];
 }): UseMultipleSelectionReturn<T>;
-type SelectionId$1 = string | number;
-export interface UseSingleSelectionReturn {
-	selectedId: SelectionId$1 | undefined;
-	hasSelection: boolean;
-	select: (id: SelectionId$1) => void;
-	deselect: () => void;
-	toggle: (id: SelectionId$1) => void;
-	isSelected: (id: SelectionId$1) => boolean;
-	resetSelection: () => void;
-}
-export declare function useSingleSelection(initialSelectedId?: SelectionId$1): UseSingleSelectionReturn;
 export interface UseOrderReturn<T> {
 	orderedItems: T[];
 	moveUp: (index: number) => void;
@@ -209,30 +215,35 @@ export interface UseOrderReturn<T> {
 	replaceOrder: (newOrderedItems: T[]) => void;
 }
 export declare function useOrder<T>(initialItems: T[]): UseOrderReturn<T>;
-export type PinId = string | number;
-export interface UsePinReturn<T> {
-	pinnedIds: PinId[];
-	pinnedItems: T[];
-	unpinnedItems: T[];
-	pinnedCount: number;
-	hasPins: boolean;
-	isAtMaxLimit: boolean;
-	pin: (itemOrId: PinId | T) => void;
-	unpin: (itemOrId: PinId | T) => void;
-	togglePin: (itemOrId: PinId | T) => void;
-	isPinned: (itemOrId: PinId | T) => boolean;
-	clearPins: () => void;
-	resetPins: () => void;
-	replacePins: (newPinnedItems: PinId[] | T[]) => void;
-	pinMultiple: (newItems: PinId[] | T[]) => void;
-	unpinMultiple: (itemsToRemove: PinId[] | T[]) => void;
+export interface UsePaginationReturn<T> {
+	pageItems: T[];
+	pageSize: number;
+	pageIndex: number;
+	totalPages: number;
+	canPrevious: boolean;
+	canNext: boolean;
+	nextPage: () => void;
+	previousPage: () => void;
+	goToFirstPage: () => void;
+	goToLastPage: () => void;
+	goToPage: (newPageIndex: number) => void;
+	changePageSize: (newPageSize: number) => void;
+	resetPageIndex: () => void;
+	resetPageSize: () => void;
+	resetPagination: () => void;
 }
-export declare function usePin<T = unknown>({ items, field, initialPinnedIds, maxPins, }: {
-	items: T[];
-	field?: string;
-	initialPinnedIds?: PinId[];
-	maxPins?: number;
-}): UsePinReturn<T>;
+export declare function usePagination<T>(data: T[], initialPageSize: number, initialPageIndex?: number): UsePaginationReturn<T>;
+type SelectionId$1 = string | number;
+export interface UseSingleSelectionReturn {
+	selectedId: SelectionId$1 | undefined;
+	hasSelection: boolean;
+	select: (id: SelectionId$1) => void;
+	deselect: () => void;
+	toggle: (id: SelectionId$1) => void;
+	isSelected: (id: SelectionId$1) => boolean;
+	resetSelection: () => void;
+}
+export declare function useSingleSelection(initialSelectedId?: SelectionId$1): UseSingleSelectionReturn;
 export type SortType = "numeric" | "alphabetical" | "alphanumeric" | "boolean" | "date" | "basic" | "custom";
 export interface BaseSortOptions {
 	desc?: boolean;
@@ -274,6 +285,41 @@ export interface UseSortReturn<T> {
 	getSortIndex: (id: string) => number | undefined;
 }
 export declare function useSort<T>(data: T[], initialSorts?: SortState): UseSortReturn<T>;
+export interface FuzzyHighlighterProps {
+	text: string;
+	query: string;
+	className?: string;
+	caseSensitive?: boolean;
+}
+export declare function FuzzyHighlighter({ text, query, className, caseSensitive, }: FuzzyHighlighterProps): React$1.JSX.Element;
+export interface ModalLayoutProps {
+	modalId: string;
+	children: React$1.ReactNode;
+	wrapperClassName?: string;
+	wrapperStyle?: React$1.CSSProperties;
+	containerClassName?: string;
+	containerStyle?: React$1.CSSProperties;
+}
+export declare function ModalLayout({ modalId, children, wrapperClassName, wrapperStyle, containerClassName, containerStyle, }: ModalLayoutProps): import("react").ReactPortal | null;
+export type ExpansionId = string | number;
+export interface UseExpansionReturn<T> {
+	expandedIds: ExpansionId[];
+	expandedItems: T[];
+	isExpanded: (itemOrId: ExpansionId | T) => boolean;
+	expand: (itemOrId: ExpansionId | T) => void;
+	collapse: (itemOrId: ExpansionId | T) => void;
+	toggle: (itemOrId: ExpansionId | T) => void;
+	expandAll: () => void;
+	collapseAll: () => void;
+	resetExpansion: () => void;
+	replaceExpansion: (newExpandedItems: ExpansionId[] | T[]) => void;
+}
+export declare function useExpansion<T = unknown>({ items, field, initialExpandedIds, multiple, }?: {
+	items?: T[];
+	field?: string;
+	initialExpandedIds?: ExpansionId[];
+	multiple?: boolean;
+}): UseExpansionReturn<T>;
 export interface UseModalStateReturn<TData> {
 	isOpen: boolean;
 	id: string | null;
@@ -288,6 +334,30 @@ export type UseModalReturn<TData> = UseModalStateReturn<TData> & UseModalActions
 export declare function useModalState<TData = unknown>(): UseModalStateReturn<TData>;
 export declare function useModalActions(): UseModalActionsReturn;
 export declare function useModal<TData = unknown>(): UseModalReturn<TData>;
+export type PinId = string | number;
+export interface UsePinReturn<T> {
+	pinnedIds: PinId[];
+	pinnedItems: T[];
+	unpinnedItems: T[];
+	pinnedCount: number;
+	hasPins: boolean;
+	isAtMaxLimit: boolean;
+	pin: (itemOrId: PinId | T) => void;
+	unpin: (itemOrId: PinId | T) => void;
+	togglePin: (itemOrId: PinId | T) => void;
+	isPinned: (itemOrId: PinId | T) => boolean;
+	clearPins: () => void;
+	resetPins: () => void;
+	replacePins: (newPinnedItems: PinId[] | T[]) => void;
+	pinMultiple: (newItems: PinId[] | T[]) => void;
+	unpinMultiple: (itemsToRemove: PinId[] | T[]) => void;
+}
+export declare function usePin<T = unknown>({ items, field, initialPinnedIds, maxPins, }: {
+	items: T[];
+	field?: string;
+	initialPinnedIds?: PinId[];
+	maxPins?: number;
+}): UsePinReturn<T>;
 export type VisibilityId = number | string;
 export interface UseVisibilityReturn<T> {
 	visibleIds: VisibilityId[];
@@ -301,63 +371,12 @@ export interface UseVisibilityReturn<T> {
 	showAll: (itemsArray?: VisibilityId[] | T[]) => void;
 	hideAll: (itemsArray?: VisibilityId[] | T[]) => void;
 	resetVisibility: () => void;
-	replaceVisibility: (newItems: VisibilityId[] | T[]) => void;
+	replaceVisibility: (newVisibleItems: VisibilityId[] | T[]) => void;
 }
 export declare function useVisibility<T = unknown>({ items, field, initialVisibleIds, }: {
 	items: T[];
 	field?: string;
 	initialVisibleIds?: VisibilityId[];
 }): UseVisibilityReturn<T>;
-export interface DebounceOptions {
-	maxWait?: number;
-	leading?: boolean;
-	trailing?: boolean;
-}
-export interface UseDebounceReturn<Args extends any[]> {
-	debouncedFunc: (...args: Args) => void;
-	cancel: () => void;
-	flush: () => void;
-	isPending: boolean;
-}
-export declare function useDebounce<Args extends any[]>(func: (...args: Args) => void, delay: number, options?: DebounceOptions): UseDebounceReturn<Args>;
-export type UseDebouncedValueReturn<T> = T;
-export declare function useDebouncedValue<T>(value: T, delay: number, options?: DebounceOptions): UseDebouncedValueReturn<T>;
-export interface ThrottleOptions {
-	leading?: boolean;
-	trailing?: boolean;
-}
-export interface UseThrottleReturn<Args extends any[]> {
-	throttledFunc: (...args: Args) => void;
-	cancel: () => void;
-	flush: () => void;
-	isPending: boolean;
-}
-export declare function useThrottle<Args extends any[]>(func: (...args: Args) => void, delay: number, options?: ThrottleOptions): UseThrottleReturn<Args>;
-declare const validKeyEventTypes: readonly [
-	"keydown",
-	"keyup",
-	"keypress"
-];
-export type KeyEventType = (typeof validKeyEventTypes)[number];
-export interface BaseKeyOptions {
-	enabled?: boolean;
-	target?: React$1.RefObject<HTMLElement | null> | Window;
-	preventDefault?: boolean;
-	stopPropagation?: boolean;
-	ignoreWhenFocusedInInputs?: boolean;
-	ctrlKey?: boolean;
-	shiftKey?: boolean;
-	altKey?: boolean;
-	metaKey?: boolean;
-}
-export type KeyOptions = BaseKeyOptions & ({
-	eventType?: "keydown" | "keypress";
-	preventRepeat?: boolean;
-} | {
-	eventType: "keyup";
-	preventRepeat?: never;
-});
-export type UseKeyReturn = void;
-export declare function useKey(key: string, handler: (e: KeyboardEvent) => void, { enabled, preventDefault, stopPropagation, eventType, preventRepeat, ignoreWhenFocusedInInputs, ctrlKey, shiftKey, altKey, metaKey, target, }?: KeyOptions): UseKeyReturn;
 
 export {};