viewerjs 1.13.0 → 1.14.0

package/README.md

@@ -24,7 +24,7 @@
 
 ## Features
 
-- Supports 57 [options](#options)
+- Supports 61 [options](#options)
 - Supports 23 [methods](#methods)
 - Supports 17 [events](#events)
 - Supports modal and inline modes
@@ -517,11 +517,13 @@ Enable to zoom the current image by dragging on the touch screen.
 
 ### zoomOnWheel
 
-- Type: `Boolean`
+- Type: `Boolean | String`
 - Default: `true`
 
 Enable to zoom the image by wheeling the mouse.
 
+Set to a modifier key name (`ctrl`, `shift`, `alt`, `meta`), or a combination joined with `+` (e.g. `ctrl+shift`), to only zoom when the given modifier key(s) are held down while wheeling. Otherwise, wheeling falls back to sliding when [`slideOnWheel`](#slideonwheel) is enabled.
+
 ### slideOnTouch
 
 - Type: `Boolean`
@@ -529,6 +531,17 @@ Enable to zoom the image by wheeling the mouse.
 
 Enable to slide to the next or previous image by swiping on the touch screen.
 
+### slideOnWheel
+
+- Type: `Boolean | String`
+- Default: `true`
+
+Enable to slide to the next or previous image by wheeling the mouse.
+
+Set to a modifier key name (`ctrl`, `shift`, `alt`, `meta`), or a combination joined with `+` (e.g. `ctrl+shift`), to only slide when the given modifier key(s) are held down while wheeling.
+
+Takes effect over the navbar, and also over the rest of the viewer when [`zoomOnWheel`](#zoomonwheel) doesn't take effect for that wheel event.
+
 ### toggleOnDblclick
 
 - Type: `Boolean`
@@ -757,6 +770,13 @@ Shortcut of the `zoomed` event.
 
 Shortcut of the `play` event.
 
+### playing
+
+- Type: `Function`
+- Default: `null`
+
+Shortcut of the `playing` event.
+
 ### stop
 
 - Type: `Function`
@@ -1131,7 +1151,8 @@ This event fires when a viewer instance is ready for viewing.
 
 - **event.bubbles**: `true`
 - **event.cancelable**: `true`
-- **event.detail**: `null`
+- **event.detail.originalEvent**:
+  - Type: `Event` or `null`
 
 This event fires when the viewer modal starts to show.
 
@@ -1141,7 +1162,7 @@ This event fires when the viewer modal starts to show.
 
 - **event.bubbles**: `true`
 - **event.cancelable**: `true`
-- **event.detail**: `null`
+- **event.detail**: the same as the `show` event.
 
 This event fires when the viewer modal has shown.
 
@@ -1151,7 +1172,8 @@ This event fires when the viewer modal has shown.
 
 - **event.bubbles**: `true`
 - **event.cancelable**: `true`
-- **event.detail**: `null`
+- **event.detail.originalEvent**:
+  - Type: `Event` or `null`
 
 This event fires when the viewer modal starts to hide.
 
@@ -1161,7 +1183,7 @@ This event fires when the viewer modal starts to hide.
 
 - **event.bubbles**: `true`
 - **event.cancelable**: `false`
-- **event.detail**: `null`
+- **event.detail**: the same as the `hide` event.
 
 This event fires when the viewer modal has hidden.
 
@@ -1180,6 +1202,8 @@ This event fires when the viewer modal has hidden.
 - **event.detail.originalImage**:
   - Type: `HTMLImageElement`
   - The original image.
+- **event.detail.originalEvent**:
+  - Type: `Event` or `null`
 
 This event fires when a viewer starts to show (view) an image.
 
@@ -1231,6 +1255,8 @@ This event fires when a viewer has moved an image.
 - **event.detail.oldDegree**:
   - Type: `Number`
   - The old rotation degrees.
+- **event.detail.originalEvent**:
+  - Type: `Event` or `null`
 
 This event fires when a viewer starts to rotate an image.
 
@@ -1258,6 +1284,8 @@ This event fires when a viewer has rotated an image.
 - **event.detail.oldScaleY**:
   - Type: `Number`
   - The old scaling factor in the vertical direction.
+- **event.detail.originalEvent**:
+  - Type: `Event` or `null`
 
 This event fires when a viewer starts to scale an image.
 
@@ -1297,17 +1325,39 @@ This event fires when a viewer has zoomed (in or out) an image.
 
 - **event.bubbles**: `true`
 - **event.cancelable**: `true`
-- **event.detail**: `null`
+- **event.detail.originalEvent**:
+  - Type: `Event` or `null`
 
 This event fires when the viewer starts to play.
 
 > You can abort the playing process by calling `event.preventDefault()`.
 
+### playing
+
+- **event.bubbles**: `true`
+- **event.cancelable**: `true`
+- **event.detail.index**:
+  - Type: `Number`
+  - The index of the original image.
+- **event.detail.image**:
+  - Type: `HTMLImageElement`
+  - The current image (a clone of the original image).
+- **event.detail.originalImage**:
+  - Type: `HTMLImageElement`
+  - The original image.
+- **event.detail.originalEvent**:
+  - Type: `Event` or `null`
+
+This event fires when a viewer starts to play (cycle) an image.
+
+> You can abort the cycling process by calling `event.preventDefault()`.
+
 ### stop
 
 - **event.bubbles**: `true`
 - **event.cancelable**: `true`
-- **event.detail**: `null`
+- **event.detail.originalEvent**:
+  - Type: `Event` or `null`
 
 This event fires when the viewer starts to stop.