UNPKG

@ionic/react

Version:
28 lines (27 loc) 1.13 kB
import type { LoadingOptions, SpinnerTypes } from '@ionic/core/components'; import type { HookOverlayOptions } from './HookOverlayOptions'; /** * A hook for presenting/dismissing an IonLoading component * @returns Returns the present and dismiss methods in an array */ export declare function useIonLoading(): UseIonLoadingResult; export type UseIonLoadingResult = [ { /** * Presents the loading indicator * @param message Optional - Text content to display in the loading indicator, defaults to blank string * @param duration Optional - Number of milliseconds to wait before dismissing the loading indicator * @param spinner Optional - The name of the spinner to display, defaults to "lines" */ (message?: string, duration?: number, spinner?: SpinnerTypes): Promise<void>; /** * Presents the loading indicator * @param options The options to pass to the IonLoading */ (options: LoadingOptions & HookOverlayOptions): Promise<void>; }, /** * Dismisses the loading indicator */ () => Promise<void> ];