@micromag/core 0.4.69 → 0.4.74

package/es/hooks.d.ts

@@ -1,9 +1,9 @@
 import * as react from 'react';
 import * as _react_spring_core from '@react-spring/core';
 import * as _use_gesture_react_dist_declarations_src_types from '@use-gesture/react/dist/declarations/src/types';
+export { useIntersectionObserver, useResizeObserver } from '@folklore/hooks';
 
-declare function useActivityDetector({ element: providedElement, disabled, timeout: timeoutDelay }?: {
-    element?: any;
+declare function useActivityDetector({ disabled, timeout: timeoutDelay }?: {
     disabled?: boolean;
     timeout?: number;
 }): {
@@ -43,10 +43,10 @@ declare function useDragProgress({ progress: wantedProgress, onTap, disabled, dr
     direction: number;
 };
 
-declare const useForm: ({ fields: providedFields, injectInFields, ...opts }?: {
+declare function useForm({ fields: providedFields, injectInFields, ...opts }?: {
     fields?: any[];
     injectInFields?: boolean;
-}) => {
+}): {
     fields: any[];
     status: any;
     response: unknown;
@@ -77,7 +77,8 @@ declare const useFormTransition: (initialPaths?: any, initialStyles?: {}) => {
     timeout: number;
 };
 
-declare const useFullscreen: (element: any) => {
+declare const useFullscreen: () => {
+    ref: react.RefObject<any>;
     toggle: () => void;
     fullscreen: () => void;
     unFullscreen: () => void;
@@ -85,12 +86,14 @@ declare const useFullscreen: (element: any) => {
     enabled: any;
 };
 
-declare const useIsVisible: ({ rootMargin, persist, disabled }?: {
+interface UseIsVisibleOptions {
+    rootMargin?: string;
     persist?: boolean;
     disabled?: boolean;
-}) => {
-    ref: react.RefObject<any>;
-    visible: any;
+}
+declare const useIsVisible: ({ rootMargin, persist, disabled, }?: UseIsVisibleOptions) => {
+    ref: react.RefObject<HTMLElement>;
+    visible: boolean;
 };
 
 declare const useLoadedFonts: (fonts: any) => {
@@ -118,60 +121,31 @@ declare const useLongPress: ({ onLongPress, onLongPressStart, onLongPressEnd, on
     triggered: boolean;
 };
 
-declare const useMediaApi: ({ url, onTimeUpdate, onProgressStep, onDurationChange, onVolumeChange, onPlay, onPause, onEnded, onSeeked, onSuspend, onLoadStart, onCanPlayThough, onCanPlay, onLoadedData, onLoadedMetadata, }?: {
-    url?: any;
-    onTimeUpdate?: any;
-    onProgressStep?: any;
-    onDurationChange?: any;
-    onVolumeChange?: any;
-    onPlay?: any;
-    onPause?: any;
-    onEnded?: any;
-    onSeeked?: any;
-    onSuspend?: any;
-    onLoadStart?: any;
-    onCanPlayThough?: any;
-    onCanPlay?: any;
-    onLoadedData?: any;
-    onLoadedMetadata?: any;
-}) => {
-    ref: react.RefObject<any>;
-    play: () => void;
-    pause: () => void;
-    stop: () => void;
-    seek: (time: any) => void;
-    currentTime: any;
-    duration: any;
-    playing: boolean;
-    paused: boolean;
-    ready: boolean;
-    dataReady: boolean;
-    suspended: boolean;
-};
+type MediaElement = HTMLVideoElement | HTMLAudioElement | HTMLMediaElement;
 
-declare const useMediaBuffering: (mediaElement?: any, interval?: number) => {
+declare const useMediaBuffering: (media?: MediaElement | null) => {
     buffering: boolean;
 };
 
-declare const useMediaState: (mediaElement?: HTMLMediaElement | null, { playing: wantedPlaying, muted: wantedMuted }?: {
+declare function useMediaState(media?: MediaElement | null, { playing: wantedPlaying, muted: wantedMuted }?: {
     playing?: boolean;
     muted?: boolean;
-}) => {
+}): {
     playing: boolean;
     muted: boolean;
     buffering: boolean;
 };
 
-declare function useMediaCurrentTime(element: any, { id, disabled, updateInterval, onUpdate: customOnUpdate }?: {
+declare function useMediaCurrentTime(media: MediaElement | null, { id, disabled, updateInterval, onUpdate: customOnUpdate }?: {
     id?: any;
     disabled?: boolean;
     updateInterval?: number;
     onUpdate?: any;
 }): number;
 
-declare function useMediaDuration(element: any, { id }?: {
+declare function useMediaDuration(media: MediaElement | null, { id }?: {
     id?: any;
-}): any;
+}): number;
 
 declare function useMediaLoad(element: any, { preload, shouldLoad }?: {
     preload?: string;
@@ -180,7 +154,7 @@ declare function useMediaLoad(element: any, { preload, shouldLoad }?: {
 
 declare function useMediaProgress(media?: any, options?: any): number;
 
-declare function useMediaReady(element: HTMLMediaElement | null, { id }?: {
+declare function useMediaReady(media: MediaElement | null, { id }?: {
     id?: string | null;
 }): boolean;
 
@@ -221,36 +195,16 @@ declare const useMediasParser: () => {
     parser: MediasParser;
 };
 
-declare function useMediaThumbnail(media: any, file?: any): any;
-
 declare function useMediaWaveform(media: any, { fake, reduceBufferFactor }?: {
     fake?: boolean;
     reduceBufferFactor?: number;
 }): any;
 
-declare const getObserver: (Observer: any, options?: {}) => any;
-declare const useObserver: (Observer: any, opts?: any, initialEntry?: any) => {
-    ref: react.RefObject<any>;
-    entry: any;
-};
-declare const useIntersectionObserver: ({ root, rootMargin, threshold, disabled, }?: {
-    root?: any;
-    rootMargin?: string;
-    threshold?: number[];
-    disabled?: boolean;
-}) => {
-    ref: react.RefObject<any>;
-    entry: any;
-};
-declare const useResizeObserver: (options?: any) => {
-    ref: react.RefObject<any>;
-    entry: any;
-};
-declare const useDimensionObserver: (...args: any[]) => {
-    entry: any;
+declare function useDimensionObserver(opts?: {}): {
+    entry: ResizeObserverEntry;
     width: any;
     height: any;
-    ref: react.RefObject<any>;
+    ref: react.RefObject<HTMLElement>;
 };
 
 declare const useParsedStory: (story: any, { disabled, withTheme, withMedias, withFonts, withMigrations, }?: {
@@ -270,15 +224,17 @@ declare function usePlaceholderStyle(selector: string, placeholderStyle: {
     textAlign?: string | null;
 }): string | null;
 
-declare function useProgressSteps({ disabled, currentTime, duration, onStep, steps, }?: {
+declare function useProgressSteps({ disabled, currentTime, duration, onStep, steps, }: {
     disabled?: boolean;
+    currentTime: any;
+    duration: any;
     onStep?: any;
     steps?: number[];
 }): void;
 
 declare const useDevicePixelRatio: () => number;
 declare const useScreenSizeFromElement: (options?: any) => {
-    ref: react.RefObject<any>;
+    ref: react.RefObject<HTMLElement>;
     fullWidth: any;
     fullHeight: any;
     screenSize: {
@@ -336,10 +292,10 @@ declare const useThemeParser: () => (story: any) => any;
 
 declare const useTrackScreenView: () => (screen?: any, index?: any) => void;
 declare const useTrackScreenEvent: (type?: any) => (action?: any, label?: any, opts?: any) => void;
-declare const useTrackScreenMedia: (type?: any) => (media?: any, action?: any, opts?: any) => void;
+declare const useTrackScreenMedia: (type?: string | null) => (media?: any, action?: any, opts?: any) => void;
 declare const useTrackEvent: () => (category?: any, action?: any, label?: any, opts?: any) => void;
 declare const useTrackMedia: (type?: any) => (media?: any, action?: any, opts?: any) => void;
 
 declare const useWindowEvent: (event: any, callback: any, enabled?: boolean) => void;
 
-export { getObserver, useActivityDetector, useAnimationFrame, useDebounced as useDebounce, useDevicePixelRatio, useDimensionObserver, useDocumentEvent, useDragProgress, useForm, useFormTransition, useFormattedDate, useFormattedTime, useFullscreen, useIntersectionObserver, useIsVisible, useLoadedFonts, useLongPress, useMediaApi, useMediaBuffering, useMediaCurrentTime, useMediaDuration, useMediaLoad, useMediaProgress, useMediaReady, useMediaState, useMediaThumbnail, useMediaTimestampOffset, useMediaWaveform, useMediasParser, useObserver, useParsedStory, usePlaceholderStyle, useProgressSteps, useResizeObserver, useScreenSizeFromElement, useScreenSizeFromWindow, useSpringValue, useSupportsWebp, useSwipe, useThemeParser, useTrackEvent, useTrackMedia, useTrackScreenEvent, useTrackScreenMedia, useTrackScreenView, useWindowEvent };
+export { useActivityDetector, useAnimationFrame, useDebounced as useDebounce, useDevicePixelRatio, useDimensionObserver, useDocumentEvent, useDragProgress, useForm, useFormTransition, useFormattedDate, useFormattedTime, useFullscreen, useIsVisible, useLoadedFonts, useLongPress, useMediaBuffering, useMediaCurrentTime, useMediaDuration, useMediaLoad, useMediaProgress, useMediaReady, useMediaState, useMediaTimestampOffset, useMediaWaveform, useMediasParser, useParsedStory, usePlaceholderStyle, useProgressSteps, useScreenSizeFromElement, useScreenSizeFromWindow, useSpringValue, useSupportsWebp, useSwipe, useThemeParser, useTrackEvent, useTrackMedia, useTrackScreenEvent, useTrackScreenMedia, useTrackScreenView, useWindowEvent };