@himanshu-sorathiya/react-kit 1.0.14 → 1.0.17

package/dist/index.d.ts

@@ -1,35 +1,24 @@
 // Generated by dts-bundle-generator v9.5.1
 
+import React$1 from 'react';
 import { CSSProperties, RefObject } from 'react';
 
+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.ReactNode;
+	children: React$1.ReactNode;
 	wrapperClassName?: string;
-	wrapperStyle?: CSSProperties;
+	wrapperStyle?: React$1.CSSProperties;
 	containerClassName?: string;
-	containerStyle?: CSSProperties;
+	containerStyle?: React$1.CSSProperties;
 }
 export declare function ModalLayout({ modalId, children, wrapperClassName, wrapperStyle, containerClassName, containerStyle, }: ModalLayoutProps): import("react").ReactPortal | null;
-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 interface DebouncedValueOptions {
-	maxWait?: number;
-	leading?: boolean;
-	trailing?: boolean;
-}
-export type UseDebouncedValueReturn<T> = T;
-export declare function useDebouncedValue<T>(value: T, delay: number, options?: DebouncedValueOptions): UseDebouncedValueReturn<T>;
 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";
@@ -133,69 +122,49 @@ export type UseFuzzySearchFields<T> = {
 }[];
 export type UseFuzzySearchReturn<T> = T[];
 export declare function useFuzzySearch<T>(data: T[], query: string, fields: UseFuzzySearchFields<T>, options?: FuzzySearchOptions): UseFuzzySearchReturn<T>;
-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 interface UseModalStateReturn<TData> {
-	isOpen: boolean;
-	id: string | null;
-	data: TData | undefined;
+export interface Group<T> {
+	key: string;
+	items: T[];
 }
-export interface UseModalActionsReturn {
-	openModal: <T = unknown>(id: string, data?: T) => void;
-	closeModal: () => void;
-	clearModal: () => void;
+export interface UseGroupingReturn<T> {
+	groupedRecord: Record<string, T[]>;
+	groupedArray: Group<T>[];
+	groupKeys: string[];
+	totalGroups: number;
+	activeGroupBy: string | undefined;
+	changeGroupBy: (newField: string) => void;
+	clearGrouping: () => void;
+	resetGrouping: () => void;
+	getGroupItems: (groupKey: string) => T[];
 }
-export type UseModalReturn<TData> = UseModalStateReturn<TData> & UseModalActionsReturn;
-export declare function useModalState<TData = unknown>(): UseModalStateReturn<TData>;
-export declare function useModalActions(): UseModalActionsReturn;
-export declare function useModal<TData = unknown>(): UseModalReturn<TData>;
+export declare function useGrouping<T = unknown>({ items, initialGroupBy, }: {
+	items: T[];
+	initialGroupBy?: string;
+}): UseGroupingReturn<T>;
+export type SelectionId = string | number;
 export interface UseMultipleSelectionReturn<T> {
-	selectedIds: (string | number)[];
+	selectedIds: SelectionId[];
 	selectedCount: number;
 	selectedItems: T[];
 	isEmpty: boolean;
-	select: (item: string | number | T) => void;
-	deselect: (item: string | number | T) => void;
-	toggle: (item: string | number | T) => void;
-	isSelected: (item: string | number | T) => boolean;
-	replaceSelection: (newSelectedItems: (string | number)[] | T[]) => void;
+	select: (item: SelectionId | T) => void;
+	deselect: (item: SelectionId | T) => void;
+	toggle: (item: SelectionId | T) => void;
+	isSelected: (item: SelectionId | T) => boolean;
 	resetSelection: () => void;
+	replaceSelection: (newSelectedItems: SelectionId[] | T[]) => void;
 	selectAll: () => void;
 	deselectAll: () => void;
 	toggleAll: () => void;
 	invertSelection: () => void;
-	selectMultiple: (newItems: (string | number)[] | T[]) => void;
-	deselectMultiple: (itemsToRemove: (string | number)[] | T[]) => void;
-	retainOnly: (itemsToRetain: (string | number)[] | T[]) => void;
+	selectMultiple: (newItems: SelectionId[] | T[]) => void;
+	deselectMultiple: (itemsToRemove: SelectionId[] | T[]) => void;
+	retainOnly: (itemsToRetain: SelectionId[] | T[]) => void;
 }
 export declare function useMultipleSelection<T = unknown>({ items, field, initialSelectedIds, }: {
 	items: T[];
 	field?: string;
-	initialSelectedIds?: (number | string)[];
+	initialSelectedIds?: SelectionId[];
 }): UseMultipleSelectionReturn<T>;
 export interface UseOrderReturn<T> {
 	orderedItems: T[];
@@ -207,8 +176,8 @@ export interface UseOrderReturn<T> {
 	moveToBottom: (index: number) => void;
 	move: (fromIndex: number, toIndex: number) => void;
 	swap: (indexA: number, indexB: number) => void;
-	replaceOrder: (newOrderedItems: T[]) => void;
 	resetOrder: () => void;
+	replaceOrder: (newOrderedItems: T[]) => void;
 }
 export declare function useOrder<T>(initialItems: T[]): UseOrderReturn<T>;
 export interface UsePaginationReturn<T> {
@@ -229,16 +198,17 @@ export interface UsePaginationReturn<T> {
 	resetPagination: () => void;
 }
 export declare function usePagination<T>(data: T[], initialPageSize: number, initialPageIndex?: number): UsePaginationReturn<T>;
+type SelectionId$1 = string | number;
 export interface UseSingleSelectionReturn {
-	selectedId: string | number | undefined;
+	selectedId: SelectionId$1 | undefined;
 	hasSelection: boolean;
-	select: (id: string | number) => void;
+	select: (id: SelectionId$1) => void;
 	deselect: () => void;
-	toggle: (id: string | number) => void;
-	isSelected: (id: string | number) => boolean;
+	toggle: (id: SelectionId$1) => void;
+	isSelected: (id: SelectionId$1) => boolean;
 	resetSelection: () => void;
 }
-export declare function useSingleSelection(initialSelectedId?: number | string): UseSingleSelectionReturn;
+export declare function useSingleSelection(initialSelectedId?: SelectionId$1): UseSingleSelectionReturn;
 export type SortType = "numeric" | "alphabetical" | "alphanumeric" | "boolean" | "date" | "basic" | "custom";
 export interface BaseSortOptions {
 	desc?: boolean;
@@ -280,6 +250,97 @@ export interface UseSortReturn<T> {
 	getSortIndex: (id: string) => number | undefined;
 }
 export declare function useSort<T>(data: T[], initialSorts?: SortState): UseSortReturn<T>;
+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;
+	data: TData | undefined;
+}
+export interface UseModalActionsReturn {
+	openModal: <T = unknown>(id: string, data?: T) => void;
+	closeModal: () => void;
+	clearModal: () => void;
+}
+export type UseModalReturn<TData> = UseModalStateReturn<TData> & UseModalActionsReturn;
+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[];
+	visibleItems: T[];
+	hiddenItems: T[];
+	visibleCount: number;
+	isVisible: (itemOrId: VisibilityId | T) => boolean;
+	show: (itemOrId: VisibilityId | T) => void;
+	hide: (itemOrId: VisibilityId | T) => void;
+	toggleVisibility: (itemOrId: VisibilityId | T) => void;
+	showAll: (itemsArray?: VisibilityId[] | T[]) => void;
+	hideAll: (itemsArray?: VisibilityId[] | T[]) => void;
+	resetVisibility: () => void;
+	replaceVisibility: (newItems: 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;
@@ -291,5 +352,31 @@ export interface UseThrottleReturn<Args extends any[]> {
 	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 {};