# 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 |