responsiveObserver.d.ts 976 B

123456789101112131415161718192021
  1. export type Breakpoint = 'xxl' | 'xl' | 'lg' | 'md' | 'sm' | 'xs';
  2. export type BreakpointMap = Record<Breakpoint, string>;
  3. export type ScreenMap = Partial<Record<Breakpoint, boolean>>;
  4. export type ScreenSizeMap = Partial<Record<Breakpoint, number>>;
  5. export declare const responsiveArray: Breakpoint[];
  6. type SubscribeFunc = (screens: ScreenMap) => void;
  7. export declare const matchScreen: (screens: ScreenMap, screenSizes?: ScreenSizeMap) => number | undefined;
  8. interface ResponsiveObserverType {
  9. responsiveMap: BreakpointMap;
  10. dispatch: (map: ScreenMap) => boolean;
  11. subscribe: (func: SubscribeFunc) => number;
  12. unsubscribe: (token: number) => void;
  13. register: () => void;
  14. unregister: () => void;
  15. matchHandlers: Record<PropertyKey, {
  16. mql: MediaQueryList;
  17. listener: (this: MediaQueryList, ev: MediaQueryListEvent) => void;
  18. }>;
  19. }
  20. declare const useResponsiveObserver: () => ResponsiveObserverType;
  21. export default useResponsiveObserver;