react-navigation-shared-element/src/types.ts

react-native-shared-element bindings for React Navigation

import {
  SharedElementNode,
  SharedElementAnimation,
  SharedElementResize,
  SharedElementAlign,
  SharedElementTransitionProps
} from "react-native-shared-element";

export {
  SharedElementNode,
  SharedElementAnimation,
  SharedElementTransitionProps
};

export type Route = {
  key: string;
  routeName: string;
};

export type NavigationEventName =
  | "willFocus"
  | "didFocus"
  | "willBlur"
  | "didBlur";

export type NavigationState = {
  key: string;
  index: number;
  routes: Route[];
  routeName: string;
  transitions: {
    pushing: string[];
    popping: string[];
  };
  params?: { [key: string]: unknown };
};

export type NavigationProp<RouteName = string, Params = object> = {
  navigate(routeName: RouteName): void;
  goBack(): void;
  goBack(key: string | null): void;
  addListener: (
    event: NavigationEventName,
    callback: () => void
  ) => { remove: () => void };
  isFocused(): boolean;
  state: NavigationState;
  setParams(params: Params): void;
  getParam(): Params;
  dispatch(action: { type: string }): void;
  isFirstRouteInParent(): boolean;
  dangerouslyGetParent(): NavigationProp | undefined;
};

export type SharedElementEventSubscription = {
  remove(): void;
};

export type SharedElementStrictConfig = {
  readonly id: string;
  readonly otherId: string;
  readonly animation: SharedElementAnimation;
  readonly resize?: SharedElementResize;
  readonly align?: SharedElementAlign;
  readonly debug?: boolean;
};

export type SharedElementsStrictConfig = SharedElementStrictConfig[];

export type SharedElementConfig =
  | {
      readonly id: string;
      readonly otherId?: string;
      readonly animation?: SharedElementAnimation;
      readonly resize?: SharedElementResize;
      readonly align?: SharedElementAlign;
      readonly debug?: boolean;
    }
  | string;

export type SharedElementsConfig = SharedElementConfig[];

export type SharedElementAnimatedValue = any;

export type SharedElementsComponentConfig = (
  navigation: NavigationProp,
  otherNavigation: NavigationProp,
  showing: boolean
) => SharedElementsConfig | undefined;

export type SharedElementSceneComponent = React.ComponentType<any> & {
  sharedElements: SharedElementsComponentConfig;
};