BookOptions
BookOptions =
object
Defined in: core/src/options.ts:52
Properties
Section titled “Properties”autoSize?
Section titled “autoSize?”
readonlyoptionalautoSize?:boolean
Defined in: core/src/options.ts:78
Size the container to the book (aspect ratio and max width).
Default
Section titled “Default”trueclick?
Section titled “click?”
readonlyoptionalclick?:ClickMode
Defined in: core/src/options.ts:80
Default
Section titled “Default”"anywhere"cover?
Section titled “cover?”
readonlyoptionalcover?:boolean
Defined in: core/src/options.ts:66
Show the first and last pages alone, as hard covers.
Default
Section titled “Default”false
readonlyoptionaldrag?:boolean
Defined in: core/src/options.ts:82
Let the pointer drag a corner.
Default
Section titled “Default”trueeasing?
Section titled “easing?”
readonlyoptionaleasing?: (t) =>number
Defined in: core/src/options.ts:72
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:70
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:56
Base page height in CSS pixels.
hoverCorners?
Section titled “hoverCorners?”
readonlyoptionalhoverCorners?:boolean
Defined in: core/src/options.ts:88
Lift a corner when the mouse hovers over it.
Default
Section titled “Default”trueignoreDragOn?
Section titled “ignoreDragOn?”
readonlyoptionalignoreDragOn?:string|false
Defined in: core/src/options.ts:94
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:64
Default
Section titled “Default”"auto"maxWidth?
Section titled “maxWidth?”
readonlyoptionalmaxWidth?:number
Defined in: core/src/options.ts:62
Widest single page in stretch mode.
Default
Section titled “Default”2000minWidth?
Section titled “minWidth?”
readonlyoptionalminWidth?:number
Defined in: core/src/options.ts:60
Narrowest single page in stretch mode; below twice this the book goes portrait.
Default
Section titled “Default”100pages?
Section titled “pages?”
readonlyoptionalpages?:Iterable<HTMLElement>
Defined in: core/src/options.ts:96
Page elements.
Default
Section titled “Default”the container's childrenshadowOpacity?
Section titled “shadowOpacity?”
readonlyoptionalshadowOpacity?:number
Defined in: core/src/options.ts:76
0 hides shadows, 1 is full strength.
Default
Section titled “Default”1shadows?
Section titled “shadows?”
readonlyoptionalshadows?:boolean
Defined in: core/src/options.ts:74
Default
Section titled “Default”true
readonlyoptionalsize?:SizeMode
Defined in: core/src/options.ts:58
Default
Section titled “Default”"fixed"startPage?
Section titled “startPage?”
readonlyoptionalstartPage?:number
Defined in: core/src/options.ts:68
Zero-based page to open on.
Default
Section titled “Default”0swipe?
Section titled “swipe?”
readonlyoptionalswipe?:boolean
Defined in: core/src/options.ts:84
Turn the page on a quick horizontal swipe.
Default
Section titled “Default”trueswipeDistance?
Section titled “swipeDistance?”
readonlyoptionalswipeDistance?:number
Defined in: core/src/options.ts:86
Minimum swipe travel in CSS pixels.
Default
Section titled “Default”30
readonlywidth:number
Defined in: core/src/options.ts:54
Base page width in CSS pixels. With size: "stretch" only the width:height ratio matters.