> For the complete documentation index, see [llms.txt](https://gitbook.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gitbook.com/docs/developers/integrations/guides/open-a-modal-from-a-button.md).

# Open a modal from a button

This guide builds a block with a button that opens a modal. The modal closes when the reader selects **Close**.

### Before you start

You need a local integration project. Follow the [integration quickstart](/docs/developers/integrations/quickstart.md) before continuing.

### Add the component

In your integration entry file, create and register the component:

```typescript
import { createComponent, createIntegration } from '@gitbook/runtime';

const modalTrigger = createComponent({
  componentId: 'modal-example',
  render: async () => (
    <block>
      <button
        label="Open modal"
        onPress={{
          action: '@ui.modal.open',
          componentId: 'modal-content',
          props: {
            message: 'Hello world'
          }
        }}
      />
    </block>
  )
});

const modalContent = createComponent({
  componentId: 'modal-content',
  render: async () => (
    <modal title="Hello world">
      <text>Modal content</text>
      <button
        label="Close"
        onPress={{
          action: '@ui.modal.close',
          returnValue: {}
        }}
      />
    </modal>
  )
});

export default createIntegration({
  components: [modalTrigger, modalContent]
});
```

`@ui.modal.open` renders the component identified by `componentId`. `@ui.modal.close` closes the modal. The close action can return data through `returnValue`.

### Add the block to your manifest

In `gitbook-manifest.yaml`, add the block to the `blocks` list:

```yaml
title: My integration
blocks:
  - id: modal-example
    title: Modal example
```

The manifest block ID must match `componentId`.

### Test the block

1. Start your integration with the development command.
2. Insert **Modal example** from the inline palette.
3. Select **Open modal**, then select **Close**.

The modal opens and closes without leaving the page.

### Next steps

Use the [modal](/docs/developers/integrations/development/contentkit/reference.md#modal) and [button](/docs/developers/integrations/development/contentkit/reference.md#button) references to customize the interface.


---

# 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://gitbook.com/docs/developers/integrations/guides/open-a-modal-from-a-button.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.