@ebay/nice-modal-react

Type declaration

• ModalDef: FC<Record<string, unknown>>

• Provider: FC<Record<string, unknown>>

• antdDrawer: (modal: NiceModalHandler<Record<string, unknown>>) => { visible: boolean; afterVisibleChange: any; onClose: any }

  • • (modal: NiceModalHandler<Record<string, unknown>>): { visible: boolean; afterVisibleChange: any; onClose: any }

    • Parameters

      • modal: NiceModalHandler<Record<string, unknown>>

      Returns { visible: boolean; afterVisibleChange: any; onClose: any }

      • visible: boolean

      • afterVisibleChange: function

        • afterVisibleChange(visible: boolean): void

        • Parameters

          • visible: boolean

          Returns void

      • onClose: function

        • onClose(): void

        • Returns void

• antdModal: (modal: NiceModalHandler<Record<string, unknown>>) => { visible: boolean; afterClose: any; onCancel: any; onOk: any }

  • • (modal: NiceModalHandler<Record<string, unknown>>): { visible: boolean; afterClose: any; onCancel: any; onOk: any }

    • Parameters

      • modal: NiceModalHandler<Record<string, unknown>>

      Returns { visible: boolean; afterClose: any; onCancel: any; onOk: any }

      • visible: boolean

      • afterClose: function

        • afterClose(): void

        • Returns void

      • onCancel: function

        • onCancel(): void

        • Returns void

      • onOk: function

        • onOk(): void

        • Returns void

• bootstrapDialog: (modal: NiceModalHandler<Record<string, unknown>>) => { show: boolean; onExited: any; onHide: any }

  • • (modal: NiceModalHandler<Record<string, unknown>>): { show: boolean; onExited: any; onHide: any }

    • Parameters

      • modal: NiceModalHandler<Record<string, unknown>>

      Returns { show: boolean; onExited: any; onHide: any }

      • show: boolean

      • onExited: function

        • onExited(): void

        • Returns void

      • onHide: function

        • onHide(): void

        • Returns void

• create: <P>(Comp: ComponentType<P>) => FC<P & NiceModalHocProps>

  • • <P>(Comp: ComponentType<P>): FC<P & NiceModalHocProps>

    • Type parameters

      • P: Record<string, unknown>

      Parameters

      • Comp: ComponentType<P>

      Returns FC<P & NiceModalHocProps>

• hide: (modal: string | FC<any>) => Promise<unknown>

  • • (modal: string | FC<any>): Promise<unknown>

    • Parameters

      • modal: string | FC<any>

      Returns Promise<unknown>

• muiDialog: (modal: NiceModalHandler<Record<string, unknown>>) => { open: boolean; onClose: any; onExited: any }

  • • (modal: NiceModalHandler<Record<string, unknown>>): { open: boolean; onClose: any; onExited: any }

    • Parameters

      • modal: NiceModalHandler<Record<string, unknown>>

      Returns { open: boolean; onClose: any; onExited: any }

      • open: boolean

      • onClose: function

        • onClose(): void

        • Returns void

      • onExited: function

        • onExited(): void

        • Returns void

• reducer: (state?: NiceModalStore, action: NiceModalAction) => NiceModalStore

  • • (state?: NiceModalStore, action: NiceModalAction): NiceModalStore

    • Parameters

      • state: NiceModalStore = ...

      • action: NiceModalAction

      Returns NiceModalStore

• register: <T>(id: string, comp: T, props?: NiceModalArgs<T>) => void

  • • <T>(id: string, comp: T, props?: NiceModalArgs<T>): void

    • Type parameters

      • T: FunctionComponent<any, T>

      Parameters

      • id: string

      • comp: T

      • Optional props: NiceModalArgs<T>

      Returns void

• remove: (modalId: string) => void

  • • (modalId: string): void

    • Parameters

      • modalId: string

      Returns void

• show: { <T>(modal: T, args?: NiceModalArgs<T>): Promise<unknown>; <T>(modal: T, args?: Record<string, unknown>): Promise<unknown> }

  • • <T>(modal: T, args?: NiceModalArgs<T>): Promise<unknown>
    • <T>(modal: T, args?: Record<string, unknown>): Promise<unknown>

    • Type parameters

      • T: FunctionComponent<any, T>

      Parameters

      • modal: T

      • Optional args: NiceModalArgs<T>

      Returns Promise<unknown>

    • Type parameters

      • T: string

      Parameters

      • modal: T

      • Optional args: Record<string, unknown>

      Returns Promise<unknown>

• useModal: { (): NiceModalHandler; <T>(modal: T, args?: Record<string, unknown>): NiceModalHandler; <T>(modal: T, args?: NiceModalArgs<T>): NiceModalHandler<NiceModalArgs<T>> }

  • • (): NiceModalHandler
    • <T>(modal: T, args?: Record<string, unknown>): NiceModalHandler
    • <T>(modal: T, args?: NiceModalArgs<T>): NiceModalHandler<NiceModalArgs<T>>

    • Returns NiceModalHandler

    • Type parameters

      • T: string

      Parameters

      • modal: T

      • Optional args: Record<string, unknown>

      Returns NiceModalHandler

    • Type parameters

      • T: FunctionComponent<any, T>

      Parameters

      • modal: T

      • Optional args: NiceModalArgs<T>

      Returns NiceModalHandler<NiceModalArgs<T>>