# Search

## Commands

### `open`

Opens the search aside.

```javascript
instance.search.open();
```

### `close`

Closes the search aside.

```javascript
instance.search.close();
```

### `query`

Opens the search aside and executes a search for the passed query text.

```javascript
instance.search.query({ text: 'YOUR SEARCH QUERY' });
```

## Events

### `onSearch`

This subscription will trigger when a search is performed in the Flipbook.

```
instance.search.onSearch((result) => {
    // YOUR CODE HERE
});
```

The callback contains a value/result with the following properties:

| Property | Type     | Description                                              |
| -------- | -------- | -------------------------------------------------------- |
| query    | `string` | Search query that was used                               |
| results  | `number` | Amount of search results found in Flipbook for the query |


---

# 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://docs.ipaper.io/flipbook-javascript-api/commands-and-events/search.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.