@minimalstuff/ui 0.0.17 → 0.0.19

package/dist/index.d.ts

@@ -17,9 +17,12 @@ import { InputHTMLAttributes } from 'react';
 import { JSX as JSX_2 } from 'react';
 import { JSX as JSX_3 } from '@emotion/react/jsx-runtime';
 import { LiHTMLAttributes } from 'react';
+import { MutableRefObject } from 'react';
 import { OptionsOrGroups } from 'react-select';
 import { PropsWithChildren } from 'react';
 import { ReactNode } from 'react';
+import { RefObject } from 'react';
+import { RefType } from 'react-hotkeys-hook/dist/types';
 import { StyledComponent } from '@emotion/styled';
 import { Theme } from '@emotion/react';
 
@@ -119,6 +122,15 @@ theme?: Theme | undefined;
 as?: ElementType<any, keyof JSX_2.IntrinsicElements> | undefined;
 }, DetailedHTMLProps<FormHTMLAttributes<HTMLFormElement>, HTMLFormElement>, {}>;
 
+declare type GlobalHotkeysContext = {
+    globalHotkeysEnabled: boolean;
+    setGlobalHotkeysEnabled: (value: boolean) => void;
+};
+
+declare const GlobalHotkeysContext = createContext<GlobalHotkeysContext>(
+iGlobalHotkeysContextState
+);
+
 declare interface InputProps extends Omit<InputHTMLAttributes<HTMLInputElement>, 'onChange'> {
     label: string;
     name: string;
@@ -135,6 +147,12 @@ declare interface InputProps_2 extends Omit<InputHTMLAttributes<HTMLInputElement
     onChange?: (name: string, value: string) => void;
 }
 
+declare const KEYS = {
+    ARROW_DOWN,
+    ARROW_UP,
+    ESCAPE_KEY,
+};
+
 declare type Medias = {
     [key in ScreenType]: string;
 };
@@ -211,6 +229,11 @@ declare interface SelectorProps extends Omit<InputHTMLAttributes<HTMLInputElemen
     formatOptionLabel?: (data: Option_2, formatOptionLabelMeta: FormatOptionLabelMeta<Option_2>) => ReactNode;
 }
 
+declare type ShortcutOptions = {
+    enabled?: boolean;
+    disableGlobalCheck?: boolean;
+};
+
 declare type SizeType = 'xs' | 's' | 'm' | 'l' | 'xl';
 
 declare type SpeedType = 'fast' | 'normal' | 'slow';
@@ -282,6 +305,27 @@ export declare interface UITheme {
     fontSizes: FontSizes;
 }
 
+/**
+ * This Hook can be used for detecting clicks outside the Opened Menu
+ */
+export declare function useClickOutside(ref: RefObject<HTMLElement>, onClickOutside: () => void): void;
+
+export declare const useGlobalHotkeys: () => GlobalHotkeysContext;
+
+export declare function useShortcut(key: keyof typeof KEYS, cb: () => void, { enabled, disableGlobalCheck }?: ShortcutOptions): MutableRefObject<RefType<HTMLElement>>;
+
+export declare const useThemeSwitcher: () => {
+    isDarkTheme: boolean;
+    toggleDarkTheme: (_value: boolean) => void;
+};
+
+export declare const useToggle: (defaultValue?: boolean) => {
+    isShowing: boolean;
+    toggle: () => void;
+    open: () => void;
+    close: () => void;
+};
+
 export { }