8.7 released—WinterCG Compliance Part 1
Learn more
ShowModalOptions
interface ShowModalOptions {
  android: {
  cancelable?: boolean
};
  animated: boolean;
  cancelable: boolean;
  closeCallback: (...args: any[]) => void;
  context: any;
  fullscreen: boolean;
  ios: {
  height?: number
  presentationStyle?: any
};
  stretched: boolean;
  transition: ModalTransitionType;
}

Summary

Properties

android

android?: {
  cancelable?: boolean
}

animated

animated?: boolean
An optional parameter specifying whether to show the modal view with animation.

cancelable

cancelable?: boolean
An optional parameter specifying whether the modal view can be dismissed when not in full-screen mode.

closeCallback

closeCallback: (...args: any[]) => void

context

context: any
Any context you want to pass to the modally shown view. This same context will be available in the arguments of the shownModally event handler.

fullscreen

fullscreen?: boolean
An optional parameter specifying whether to show the modal view in full-screen mode.

ios

ios?: {
  height?: number
  presentationStyle?: any
}
An optional parameter that specify options specific to iOS as an object.

stretched

stretched?: boolean
An optional parameter specifying whether to stretch the modal view when not in full-screen mode.

transition

transition?: ModalTransitionType
An optional custom transition effect