Skip to content
On this page

Interface: NModalWrapperContext

Properties

modalFunc

modalFunc: (props: NModalFuncProps) => { destroy: () => void }

Type declaration

(props): Object

Parameters
NameType
propsNModalFuncProps
Returns

Object

NameType
destroy() => void

Defined in

dist/src/components/n-modal/modal-types.d.ts:12


showModal

showModal: (modalComponent: VNode<RendererNode, RendererElement, { [key: string]: any; }>, props?: Record<string, any>, modalProps?: Omit<Partial<ExtractPropTypes<{ afterClose: PropType<() => void> ; bodyStyle: { default: CSSProperties ; type: PropType<CSSProperties> } ; cancelButtonProps: PropType<Partial<ExtractPropTypes<{ block: { default: any ; type: BooleanConstructor } ; danger: { default: any ; type: BooleanConstructor } ; disabled: { default: any ; type: BooleanConstructor } ; ghost: { default: any ; type: BooleanConstructor } ; href: StringConstructor ; htmlType: { default: string ; type: PropType<ButtonHTMLType> } ; icon: VueTypeValidableDef<any> ; loading: { default: () => boolean | { delay?: number } ; type: PropType<boolean | { delay?: number }> } ; onClick: { type: PropType<(event: MouseEvent) => void> } ; onMousedown: { type: PropType<(event: MouseEvent) => void> } ; prefixCls: StringConstructor ; shape: { type: PropType<ButtonShape> } ; size: { type: PropType<SizeType> } ; target: StringConstructor ; title: StringConstructor ; type: PropType<ButtonType> }>>> ; cancelText: VueTypeValidableDef<any> ; centered: { default: any ; type: BooleanConstructor } ; closable: { default: any ; type: BooleanConstructor } ; closeIcon: VueTypeValidableDef<any> ; confirmLoading: { default: any ; type: BooleanConstructor } ; destroyOnClose: { default: any ; type: BooleanConstructor } ; focusTriggerAfterClose: { default: any ; type: BooleanConstructor } ; footer: VueTypeValidableDef<any> ; forceRender: { default: any ; type: BooleanConstructor } ; getContainer: { default: any ; type: PropType<string | false | HTMLElement | getContainerFunc> } ; icon: VueTypeValidableDef<any> ; keyboard: { default: any ; type: BooleanConstructor } ; mask: { default: any ; type: BooleanConstructor } ; maskClosable: { default: any ; type: BooleanConstructor } ; maskStyle: { default: CSSProperties ; type: PropType<CSSProperties> } ; maskTransitionName: StringConstructor ; modalRender: PropType<(arg: { originVNode: VueNode }) => VueNode> ; okButtonProps: PropType<Partial<ExtractPropTypes<{ block: { default: any ; type: BooleanConstructor } ; danger: { default: any ; type: BooleanConstructor } ; disabled: { default: any ; type: BooleanConstructor } ; ghost: { default: any ; type: BooleanConstructor } ; href: StringConstructor ; htmlType: { default: string ; type: PropType<ButtonHTMLType> } ; icon: VueTypeValidableDef<any> ; loading: { default: () => boolean | { delay?: number } ; type: PropType<boolean | { delay?: number }> } ; onClick: { type: PropType<(event: MouseEvent) => void> } ; onMousedown: { type: PropType<(event: MouseEvent) => void> } ; prefixCls: StringConstructor ; shape: { type: PropType<ButtonShape> } ; size: { type: PropType<SizeType> } ; target: StringConstructor ; title: StringConstructor ; type: PropType<ButtonType> }>>> ; okText: VueTypeValidableDef<any> ; okType: PropType<LegacyButtonType> ; onCancel: PropType<(e: MouseEvent) => void> ; onChange: PropType<(visible: boolean) => void> ; onOk: PropType<(e: MouseEvent) => void> ; onUpdate:visible: PropType<(visible: boolean) => void> ; prefixCls: StringConstructor ; title: VueTypeValidableDef<any> ; transitionName: StringConstructor ; visible: { default: any ; type: BooleanConstructor } ; width: (StringConstructor | NumberConstructor)[] ; wrapClassName: StringConstructor ; wrapProps: ObjectConstructor ; zIndex: NumberConstructor }>>, "visible" | "onUpdate:visible"> & Partial<NModalProps>) => { destroy: () => void }

Type declaration

(modalComponent, props?, modalProps?): Object

Parameters
NameType
modalComponentVNode<RendererNode, RendererElement, { [key: string]: any; }>
props?Record<string, any>
modalProps?Omit<Partial<ExtractPropTypes<{ afterClose: PropType<() => void> ; bodyStyle: { default: CSSProperties ; type: PropType<CSSProperties> } ; cancelButtonProps: PropType<Partial<ExtractPropTypes<{ block: { default: any ; type: BooleanConstructor } ; danger: { default: any ; type: BooleanConstructor } ; disabled: { default: any ; type: BooleanConstructor } ; ghost: { default: any ; type: BooleanConstructor } ; href: StringConstructor ; htmlType: { default: string ; type: PropType<ButtonHTMLType> } ; icon: VueTypeValidableDef<any> ; loading: { default: () => boolean | { delay?: number } ; type: PropType<boolean | { delay?: number }> } ; onClick: { type: PropType<(event: MouseEvent) => void> } ; onMousedown: { type: PropType<(event: MouseEvent) => void> } ; prefixCls: StringConstructor ; shape: { type: PropType<ButtonShape> } ; size: { type: PropType<SizeType> } ; target: StringConstructor ; title: StringConstructor ; type: PropType<ButtonType> }>>> ; cancelText: VueTypeValidableDef<any> ; centered: { default: any ; type: BooleanConstructor } ; closable: { default: any ; type: BooleanConstructor } ; closeIcon: VueTypeValidableDef<any> ; confirmLoading: { default: any ; type: BooleanConstructor } ; destroyOnClose: { default: any ; type: BooleanConstructor } ; focusTriggerAfterClose: { default: any ; type: BooleanConstructor } ; footer: VueTypeValidableDef<any> ; forceRender: { default: any ; type: BooleanConstructor } ; getContainer: { default: any ; type: PropType<string | false | HTMLElement | getContainerFunc> } ; icon: VueTypeValidableDef<any> ; keyboard: { default: any ; type: BooleanConstructor } ; mask: { default: any ; type: BooleanConstructor } ; maskClosable: { default: any ; type: BooleanConstructor } ; maskStyle: { default: CSSProperties ; type: PropType<CSSProperties> } ; maskTransitionName: StringConstructor ; modalRender: PropType<(arg: { originVNode: VueNode }) => VueNode> ; okButtonProps: PropType<Partial<ExtractPropTypes<{ block: { default: any ; type: BooleanConstructor } ; danger: { default: any ; type: BooleanConstructor } ; disabled: { default: any ; type: BooleanConstructor } ; ghost: { default: any ; type: BooleanConstructor } ; href: StringConstructor ; htmlType: { default: string ; type: PropType<ButtonHTMLType> } ; icon: VueTypeValidableDef<any> ; loading: { default: () => boolean | { delay?: number } ; type: PropType<boolean | { delay?: number }> } ; onClick: { type: PropType<(event: MouseEvent) => void> } ; onMousedown: { type: PropType<(event: MouseEvent) => void> } ; prefixCls: StringConstructor ; shape: { type: PropType<ButtonShape> } ; size: { type: PropType<SizeType> } ; target: StringConstructor ; title: StringConstructor ; type: PropType<ButtonType> }>>> ; okText: VueTypeValidableDef<any> ; okType: PropType<LegacyButtonType> ; onCancel: PropType<(e: MouseEvent) => void> ; onChange: PropType<(visible: boolean) => void> ; onOk: PropType<(e: MouseEvent) => void> ; onUpdate:visible: PropType<(visible: boolean) => void> ; prefixCls: StringConstructor ; title: VueTypeValidableDef<any> ; transitionName: StringConstructor ; visible: { default: any ; type: BooleanConstructor } ; width: (StringConstructor | NumberConstructor)[] ; wrapClassName: StringConstructor ; wrapProps: ObjectConstructor ; zIndex: NumberConstructor }>>, "visible" | "onUpdate:visible"> & Partial<NModalProps>
Returns

Object

NameType
destroy() => void

Defined in

dist/src/components/n-modal/modal-types.d.ts:15