> For the complete documentation index, see [llms.txt](https://real3dflipbook.gitbook.io/jquery/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://real3dflipbook.gitbook.io/jquery/flipbook-options.md).

# Flipbook options

### Table of Contents

Table of Contents for flipbook can be defined in couple of ways. 

First method is with `tableOfContents` array, for example

```javascript
tableOfContents: [
    { 
        title: "Cover", 
        page: "1" 
    },
    { 
        title: "Second page", 
        page: "2" 
    },
    { 
        title: "Last page", 
        page: "4" 
    },
]
```

It can also be defined by setting `title` attribute for pages in `pages` array. Pages that have `title` will show up in Table of Contents

```javascript
pages : [
    {
        src: "...",
        thumb: "...",
        title: "First page"
    },
    {
        src: "...",
        thumb: "...",
        title: "Second page"
    },
    {
        src: "...",
        thumb: "..."
    },
    ...
    {
        src: "...",
        thumb: "...",
        title: "Last page"
    }
]
```

For PDF flipbook, if PDF has outline embedded, flipbook will automatically show the PDF outline as Table of Contents.

### Lightbox

Lightbox allows you to open the flipbook after an element on the page is clicked (image, button or any other element). Enable lightbox with option

```javascript
lightBox: true
```

Creating a flipbook that will open when a button is clicked:

```html
<button id="book1">Read book 1</button>
```

```javascript
const options = {
    pdfUrl: '1.pdf',
    lightBox: true
}

new Flipbook(container, options)
```

Instead of button, any element can be used.

Lightbox flipbook will start to load pages only after the flipbook is opened, so this is very useful if you want to have multiple flipbooks on the same page.

### Deep linking

Deep linking allows you to open a flipbook at a certain page directly with a link.

Enable the deep linking by setting a custom prefix, for example

```javascript
deeplinkingPrefix: 'book1_'
```

Now you can link to page 2 of the flipbook (or any page) by adding #book1\_2 at the end of the page URL

### Google Analytics

By adding UA or GA4 property ID, you will be able to track custom events from flipbook in that property.

```javascript
googleAnalyticsTrackingCode: // Your property ID, starting with "G-" or "UA-"
```

### Mobile

Override any option for mobile, this can be used to slightly adjust or create entirely different flipbook for mobile.&#x20;

Example of different settings for mobile

```javascript
const options = {
    pdfUrl: '1.pdf',
    mobile: {
        viewMode: "swipe",
        singlePageMode: true,
        zoomMin: 1
    }
}
new Flipbook(container, options)
```

### Other options

Many other options are available, the full list is [here](/jquery/default-options.md)&#x20;


---

# 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://real3dflipbook.gitbook.io/jquery/flipbook-options.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.