> For the complete documentation index, see [llms.txt](https://colorfy-software.gitbook.io/react-native-modalfy/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://colorfy-software.gitbook.io/react-native-modalfy/2.x/api/modalfy.md).

# modalfy

{% hint style="info" %}
Function that exposes Modalfy's API outside of React's context.
{% endhint %}

{% hint style="danger" %}
**Notes:** 

* **Do not use if you're inside a React component.** \
  Please consider [**useModal()**](/react-native-modalfy/2.x/api/usemodal.md) or [**withModal()**](/react-native-modalfy/2.x/api/withmodal.md) instead.
* You can't pass a `modalName` to `closeModal()` to close a modal that's not the currently displayed one. This is due to a current API limitation especially in the case where you'd have several modals with the same name opened, as Modalfy can't safely determine which one you wanted to close.
  {% endhint %}

{% hint style="success" %}
The object returned by `modalfy()`is covered in [**ModalProp**](/react-native-modalfy/2.x/api/types/modalprop.md).
{% endhint %}

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

```javascript
const modalfy = <
  P extends ModalfyParamsm,
  M extends keyof P
>(): UsableModalProp<P> => {
  const context: UsableModalProp<P> = React.useContext(ModalContext)
  return {
    closeAllModals: ModalState.closeAllModals,

    closeModal: () => ModalState.closeModal(),

    closeModals: (modalName: M) => ModalState.closeModals(modalName),

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

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

{% endtab %}
{% endtabs %}

{% embed url="<https://github.com/colorfy-software/react-native-modalfy/blob/master/lib/ModalState.ts#L253>" %}
Types have been simplified for the sake of clarity. Refer to the exact definitions here.
{% endembed %}

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

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

{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.