View Categories

Settings

7 min read

These settings will be applicable from Version 2.1

Source Settings: #

Book Source Type

DearFlip Accepts two type of Source. PDF and Images. We recommend using PDF over images. PDFs are easier to manage and design using a PDF editor. Images needs to be added individually and take more time.

PDF File & Thumbnail Image

This field accepts the PDF file link. It can be selected using WordPress Media Upload box. Or a URL can be directly added. Recommended is WordPress Media Upload Dialog box.

Tips: PDF files from external source needs to have proper CORS permissions to use in your site.

PDF Thumbnail Image

You can add a thumbnail image to the PDF file selected. This thumb will be used when you used “thumb” type lightbox.
Since version 2.1 Full edition, thumbs can be autogenerated when PDF file is selected

General Settings: #

Viewer Type

Dearflip supports 3 viewer type modes. Available Options are Vertical Reader, Flipbook, Slider. Default mode is flipbook.
Can be set globally, overridden by individual settings or shortcode option viewertype.

Mobile Viewer Type

Sets the type of viewer for mobile devices. Available options are Same as Viewer Type, Vertical Reader, Flipbook, Slider.

Page Size/Zoom #

Page Render Size

The maximum size of page that can be rendered or zoomed to. We recommend a maximum of 3200px. Higher values use more memory exponentially and can crash devices with low memory.

Zoom Ratio:

The multiplier for page zoom. It cannot zoom beyond the maximum Page Render size.

Page Links #

These settings are for the links inside the PDF flipbook pages or the hotspots added to image flipbooks.

Link Color

The links in flipbooks can be highlighted with specific color. The default color is yellow

Link Color Opacity :

Controls the transparency of the link. By default the value is 0.4. To totally hide the links you can set the value to 0

Link Color Hover:

Controls the color of link when they are hovered.

Link Color Hover Opacity:

Controls the transparency of the link when they are hovered.

Tips: If you do not like to have links having color and want them to be only highlighted on hover, you can set the Link Color Opacity to 0.

Layout Settings #

Padding Top

Padding Bottom

Padding Left

Padding Right

Paddings can be used to add space between flipbook and the container where flipbook is added.

Negative values for padding are possible, will created a zoomed effect.

Container Height

The height of flipbook container can be set. This applies for embedded mode only. Can be passed using shortcode too.
Possible values are:

  • Default: auto Recommended
  • Numeric: 500 or 1000
  • Pixel Numbers: 500px or 100px
  • Percentage: 50% or 80% (when using percentage, parent element should have fixed/calculated height else it results to 0)
  • Viewport Height: 100vh or 80vh (100vh results to full browser viewport height)

Calculated values are possible.
Like calc( 100vh - 80px) this makes the height of flipbook to consider the sticky header height of you page. or when the flipbook is in top position you can subtract the height of the header. More on calc() function

Overlay SideMenu

When set to true, the sidemenus(Outline, search, thumbnails) will open on top of flipbook; without resizing/shifting the flipbook.

Background Color

Background color for the flipbook container. Accepts Hexadecimal value

  • Color Names: yellow , red
  • Hexadecimal Value: #ff0000
  • Transparent: transparent or rgba(0,0,0,0)

To create a transparent background use transparent or rgba(0,0,0,0)

Background Image

Background image for the flipbook container.

Controls #

Auto Enable Sound

Sound is played when flipbook pages flip. This can be disabled or enable.

Enable PDF Download

This shows/hides the download button for PDF file. Only applies if the Book source if PDF.

This shows/hides the search button for PDF file. Only applies if the Book source if PDF.

Enable PDF Print

This shows/hides the print button for PDF file. Only applies if the Book source if PDF.

Controls Position

Controls bar can be set to top, bottom or hidden.

The controls size is subtracted from the flipbook height. Can be offset using bottom padding too.

Controls Floating

Sets the controls bar to use a floating layout.

More Controls – CASE SENSITIVE

Hide Controls – CASE SENSITIVE

Hide Share Controls – CASE SENSITIVE

Flipbook Settings #

3D or 2D

Determines the display mode of Flipbook. The default mode is 3D. in browsers that do not support 3D mode, it will fallback to 2D mode.

Possible values are 3D mode, 2D mode and Hybrid 3D

Hard Pages

When set to true, all pages will be forced to hard page like structure – they will no longer be foldable.

Flip Duration

Determines the duration to flip a page. Default is 800ms.

Page Mode

By default flipbook displays two pages – side by side. That is Double page mode, default value. You can choose Single page mode if you want to focus on one page at a time.

If set to Auto, desktop will use Double page mode and mobiles will use single page mode.

Single Page Mode

When in single page mode, you can further choose to display just one page(Booklet mode) or focus on a page in flipbook(Normal Zoom).

Direction

Some PDFs are RTL(Right o Left) in such cases, you can choose RTL mode.

3D Settings #

Has Spiral in 3D Book

Spiral flipbook mode will be used if set to true.

Spiral mode doesn’t work in 2D or in Hybrid 3D mode.

3D Spiral color

Sets the color of spiral in a spiral 3D flipbook.

Enable 3D Cover

When set to one, a hard cover page will be use for front and back of the 3D flipbook.

3D Book Cover Color

Sets the color of 3D cover

3D Book Pages Color

Sets the default color of 3D pages. By default its white.

3D Paper Flexibility

Determines the flexibility of a 3D page. Bigger value denotes a much flexible page.

Setting the value to 0 will create a flat flipbook when in resting position

3D Flipbook Up Tilt

Beta feature- Tilts the 3D flipbook backwards.

3D Flipbook Rotate

Beta feature- Rotates the 3D flipbook left or right by the given angle. Positive values rotate to right, negative values rotate to left.

Misc #

Enable AutoPlay

Autoplay Duration

Enable AutoPlay Automatically

Mid Shadow darkness for 2D Flipbook

Enable Zoom on Scroll

Outline #

Auto Enable Outline

When set to TRUE, outline panel will be auto opened(displayed) when the flipbook loads.

Auto Enable Thumbnail

When set to TRUE, thumbnails panel will be auto opened(displayed) when the flipbook loads.

Overwrite PDF Outline

There are cases when the outlines embedded in the PDF is not what you want to display. In that case you can create your custom outline using the outline builder of DearFlip and overwrite the PDF inbuilt outline.

When set to TRUE , PDF outline will be discarded.
When Set to FALSE, custom outline will be displayed below PDF outline

Popup/Lightbox #

Button ClassNames

Popup Target

Thumb Popup #

PopUp Thumbnail Default

Thumb Popup Display

Thumb Popup Play icon

Thumb Popup Play Icon Background Color

Thumb Popup Play Icon Color

LightBox Settings #

Popup Background Color

Popup Background Opacity

Book Shelf Settings #

Book Shelf Custom Image

PDF Settings #

Disable Partial Loading –

PDF Partial Loading Chunk Size

PDF.js Version

Advanced Settings #

Share Prefix –

Share: Use post slugs –

Enable Analytics –

Posts/Shortcode #

Enable dFlip Post Pages –

Single Post Lightbox –

Post Limit –

Selective Script Loading –

Auto convert PDF links on page to viewers –

Translate Settings #

Use External Translate: When set too true, Dearflip uses external translate plugins for translate. When set to False, Dearflip uses the translate text from the translate fields.

Open Book:

Loading:

Toggle Thumbnails:

Toggle Outline/Bookmark

Previous Page

Next Page

Toggle Fullscreen

Zoom In

Zoom Out

Toggle Help

Single Page Mode

Double Page Mode

Download PDF File

Goto First Page

Goto Last Page

Share

Share: Mail Subject

Share: Mail Message

2 thoughts on “Settings”

  1. Using the free version, will the thumb image not auto generate for the lightbox? Is this only for the Pro version or do I have to create a thumbnail image if I use either version of your DearFlip?

    Reply

Leave a Comment