@axinom/mosaic-ui/src/hooks/models.ts

UI components for building Axinom Mosaic applications

import { HistoryLocation } from './useReactRouterPause/useReactRouterPause';
export type ValueOrOnDemand =
  | string
  | number
  | (() => Promise<string | number>);

type PushOrReplace = (
  pathOrLocation: string,
  state: {
    [key: string]: unknown;
  },
) => void;

export interface NavigationAPI {
  isPaused: () => boolean;
  pausedLocation: () => HistoryLocation | null;
  pause: () => void;
  resume: () => void;
  cancel: () => void;
  push: PushOrReplace;
  replace: PushOrReplace;
}