# modalfy

{% hint style="info" %}
Function that exposes Modalfy's API outside of React's context. The object returned by `modalfy()`is covered in [**`ModalProp`**](/react-native-modalfy/api/types/modalprop.md).
{% endhint %}

{% hint style="danger" %} <mark style="color:red;">**Note: Do not use if you're inside a React component.**</mark> <mark style="color:red;"></mark><mark style="color:red;">Please consider</mark> [<mark style="color:red;">**`useModal()`**</mark>](/react-native-modalfy/api/usemodal.md) <mark style="color:red;">or</mark> [<mark style="color:red;">**`withModal()`**</mark>](/react-native-modalfy/api/withmodal.md) <mark style="color:red;">instead.</mark>
{% endhint %}

{% tabs %}
{% tab title="TypeScript" %}

```typescript
const modalfy = <
  P extends ModalfyParamsm,
  M extends keyof P
>(): UsableModalProp<P> => {
  const context: UsableModalProp<P> = React.useContext(ModalContext)
  return {
    closeAllModals: (callback?: () => void) => {
      ModalState.queueClosingAction({ action: 'closeAllModals', callback })
    },

    closeModals: (modalName: M, callback?: () => void) =>
      ModalState.queueClosingAction({
        action: 'closeModals',
        modalName,
        callback,
      }),
      
    closeModal: (modalName?: M, callback?: () => void) => {
      ModalState.queueClosingAction({
        action: 'closeModal',
        modalName,
        callback,
      })
    },

    currentModal: ModalState.getState<P>()?.currentModal,

    openModal: (modalName: M, params?: P[M], callback?: () => void) =>
      ModalState.openModal(modalName, params, true, callback),
  }
}
```

{% endtab %}
{% endtabs %}

{% embed url="<https://github.com/colorfy-software/react-native-modalfy/blob/main/src/lib/ModalState.ts#L314-L398>" %}

{% hint style="info" %}
If you're using TypeScript and have [your params types](/react-native-modalfy/guides/typing.md#modalprop), you can get some nice autocomplete by utilizing `modalfy()`like this:

```typescript
import { ModalStackParamsList } from 'App'
// ...
const { openModal } = modalfy<ModalStackParamsList>()
```

{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://colorfy-software.gitbook.io/react-native-modalfy/api/modalfy.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.