BookOptions
BookOptions =
object
Defined in: core/src/options.ts:79
Properties
Section titled “Properties”autoSize?
Section titled “autoSize?”
readonlyoptionalautoSize?:boolean
Defined in: core/src/options.ts:107
Size the container to the book (aspect ratio and max width).
Default
Section titled “Default”truebinding?
Section titled “binding?”
readonlyoptionalbinding?:Binding
Defined in: core/src/options.ts:93
Default
Section titled “Default”"left"click?
Section titled “click?”
readonlyoptionalclick?:ClickMode
Defined in: core/src/options.ts:109
Default
Section titled “Default”"edges"cover?
Section titled “cover?”
readonlyoptionalcover?:boolean
Defined in: core/src/options.ts:95
Show the first and last pages alone, as hard covers.
Default
Section titled “Default”false
readonlyoptionaldrag?:boolean
Defined in: core/src/options.ts:111
Let the pointer drag a page’s edge. The fold follows the pointer’s travel: pulled straight in it furls the whole edge, pulled from a corner it folds across.
Default
Section titled “Default”trueeasing?
Section titled “easing?”
readonlyoptionaleasing?: (t) =>number
Defined in: core/src/options.ts:101
Easing for the corner’s path, t in 0..1.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”number
Default
Section titled “Default”linearflipDuration?
Section titled “flipDuration?”
readonlyoptionalflipDuration?:number
Defined in: core/src/options.ts:99
Duration of a full flip in milliseconds. Shorter flips take proportionally less.
Default
Section titled “Default”1000height
Section titled “height”
readonlyheight:number
Defined in: core/src/options.ts:83
Base page height in CSS pixels.
hover?
Section titled “hover?”
readonlyoptionalhover?:boolean
Defined in: core/src/options.ts:117
Show where a page can be taken hold of when the mouse hovers there: the edge furls, leaning toward the pointer, and in a single-page book the page that turns back uncurls a strip over the spine.
Default
Section titled “Default”trueignoreDragOn?
Section titled “ignoreDragOn?”
readonlyoptionalignoreDragOn?:string|false
Defined in: core/src/options.ts:123
Pointer events starting on an element matching this selector never start a flip.
false turns this off.
Default
Section titled “Default”"a, button, input, textarea, select, [data-opf-no-flip]"layout?
Section titled “layout?”
readonlyoptionallayout?:Layout
Defined in: core/src/options.ts:91
Default
Section titled “Default”"auto"maxWidth?
Section titled “maxWidth?”
readonlyoptionalmaxWidth?:number
Defined in: core/src/options.ts:89
Widest single page in stretch mode.
Default
Section titled “Default”2000minWidth?
Section titled “minWidth?”
readonlyoptionalminWidth?:number
Defined in: core/src/options.ts:87
Narrowest single page in stretch mode. A container narrower than two of these across the spine goes portrait.
Default
Section titled “Default”100pages?
Section titled “pages?”
readonlyoptionalpages?:Iterable<HTMLElement>
Defined in: core/src/options.ts:125
Page elements.
Default
Section titled “Default”the container's childrenshadowOpacity?
Section titled “shadowOpacity?”
readonlyoptionalshadowOpacity?:number
Defined in: core/src/options.ts:105
0 hides shadows, 1 is full strength (the original’s look).
Default
Section titled “Default”0.35shadows?
Section titled “shadows?”
readonlyoptionalshadows?:boolean
Defined in: core/src/options.ts:103
Default
Section titled “Default”true
readonlyoptionalsize?:SizeMode
Defined in: core/src/options.ts:85
Default
Section titled “Default”"fixed"startPage?
Section titled “startPage?”
readonlyoptionalstartPage?:number
Defined in: core/src/options.ts:97
Zero-based page to open on.
Default
Section titled “Default”0swipe?
Section titled “swipe?”
readonlyoptionalswipe?:boolean
Defined in: core/src/options.ts:113
Turn the page on a quick touch or pen swipe across the pages (horizontal for a left- or right-bound book, vertical otherwise), from anywhere on it.
Default
Section titled “Default”trueswipeDistance?
Section titled “swipeDistance?”
readonlyoptionalswipeDistance?:number
Defined in: core/src/options.ts:115
Minimum swipe travel in CSS pixels.
Default
Section titled “Default”30
readonlywidth:number
Defined in: core/src/options.ts:81
Base page width in CSS pixels. With size: "stretch" only the width:height ratio matters.