build: release 1.3.0

Author: fengyuanchen

CHANGELOG.md

@@ -1,7 +1,8 @@
 # Changelog
 
-## next
+## 1.3.0 (Oct 25, 2018)
 
+- Add a new option: `className` (#209).
 - Fix wrong click action when the target image is ignored by the `filter` option (#211)
 
 ## 1.2.1 (Oct 20, 2018)

README.md

@@ -128,21 +128,12 @@ var viewer = new Viewer(document.getElementById('images'));
 You may set viewer options with `new Viewer(image, options)`.
 If you want to change the global default options, You may use `Viewer.setDefaults(options)`.
 
-### initialViewIndex
-
-- Type: `Number`
-- Default: `0`
-
-Define the initial index of image for viewing.
-
-> Also used as the default parameter value of the `view` method.
-
-### inline
+### backdrop
 
-- Type: `Boolean`
-- Default: `false`
+- Type: `Boolean` or `String`
+- Default: `true`
 
-Enable inline mode.
+Enable a modal backdrop, specify `static` for a backdrop which doesn't close the modal on click.
 
 ### button
 
@@ -227,56 +218,71 @@ toolbar: {
 }
 ```
 
-### tooltip
+### className
 
-- Type: `Boolean`
-- Default: `true`
+- Type: `String`
+- Default: `''`
 
-Show the tooltip with image ratio (percentage) when zoom in or zoom out.
+Custom class name(s) to add to the viewer's root element.
 
-### movable
+### container
 
-- Type: `Boolean`
-- Default: `true`
+- Type: `Element` or `String`
+- Default: `'body'`
+- An element or a valid selector for [Document.querySelector](https://developer.mozilla.org/en-US/docs/Web/API/Document/querySelector)
 
-Enable to move the image.
+The container to put the viewer in modal mode.
 
-### zoomable
+> Only available when the `inline` option is set to `false`.
 
-- Type: `Boolean`
-- Default: `true`
+### filter
 
-Enable to zoom the image.
+- Type: `Function`
+- Default: `null`
 
-### rotatable
+Filter the images for viewing (should return `true` if the image is viewable).
 
-- Type: `Boolean`
-- Default: `true`
+For example:
 
-Enable to rotate the image.
+```js
+new Viewer(images, {
+  filter(image) {
+    return image.complete;
+  },
+});
+```
 
-### scalable
+### fullscreen
 
 - Type: `Boolean`
 - Default: `true`
 
-Enable to scale the image.
+Enable to request full screen when play.
 
-### transition
+> Requires the browser supports [Full Screen API](http://caniuse.com/fullscreen).
 
-- Type: `Boolean`
-- Default: `true`
+### initialViewIndex
 
-Enable CSS3 Transition for some special elements.
+- Type: `Number`
+- Default: `0`
 
-### fullscreen
+Define the initial index of image for viewing.
+
+> Also used as the default parameter value of the `view` method.
+
+### inline
 
 - Type: `Boolean`
-- Default: `true`
+- Default: `false`
 
-Enable to request full screen when play.
+Enable inline mode.
 
-> Requires the browser supports [Full Screen API](http://caniuse.com/fullscreen).
+### interval
+
+- Type: `Number`
+- Default: `5000`
+
+The amount of time to delay between automatically cycling an image when playing.
 
 ### keyboard
 
@@ -285,13 +291,6 @@ Enable to request full screen when play.
 
 Enable keyboard support.
 
-### backdrop
-
-- Type: `Boolean` or `String`
-- Default: `true`
-
-Enable a modal backdrop, specify `static` for a backdrop which doesn't close the modal on click.
-
 ### loading
 
 - Type: `Boolean`
@@ -308,13 +307,6 @@ Indicate if enable loop viewing or not.
 
 > If the current image is the last one, then the next one to view is the first one, and vice versa.
 
-### interval
-
-- Type: `Number`
-- Default: `5000`
-
-The amount of time to delay between automatically cycling an image when playing.
-
 ### minWidth
 
 - Type: `Number`
@@ -333,26 +325,58 @@ Define the minimum height of the viewer.
 
 > Only available in inline mode (set the `inline` option to `true`).
 
-### zoomRatio
+### movable
 
-- Type: `Number`
-- Default: `0.1`
+- Type: `Boolean`
+- Default: `true`
 
-Define the ratio when zoom the image by wheeling mouse.
+Enable to move the image.
 
-### minZoomRatio
+### zoomable
 
-- Type: `Number`
-- Default: `0.01`
+- Type: `Boolean`
+- Default: `true`
 
-Define the min ratio of the image when zoom out.
+Enable to zoom the image.
 
-### maxZoomRatio
+### rotatable
 
-- Type: `Number`
-- Default: `100`
+- Type: `Boolean`
+- Default: `true`
 
-Define the max ratio of the image when zoom in.
+Enable to rotate the image.
+
+### scalable
+
+- Type: `Boolean`
+- Default: `true`
+
+Enable to scale the image.
+
+### toggleOnDblclick
+
+- Type: `Boolean`
+- Default: `true`
+
+Indicate if toggle the image size between its natural size and initial size when double click on the image or not.
+
+In other words, call the [`toggle`](#toggle) method automatically when double click on the image.
+
+> Requires [`dblclick`](https://developer.mozilla.org/en-US/docs/Web/Events/dblclick) event support.
+
+### tooltip
+
+- Type: `Boolean`
+- Default: `true`
+
+Show the tooltip with image ratio (percentage) when zoom in or zoom out.
+
+### transition
+
+- Type: `Boolean`
+- Default: `true`
+
+Enable CSS3 Transition for some special elements.
 
 ### zIndex
 
@@ -368,6 +392,27 @@ Define the CSS `z-index` value of viewer in modal mode.
 
 Define the CSS `z-index` value of viewer in inline mode.
 
+### zoomRatio
+
+- Type: `Number`
+- Default: `0.1`
+
+Define the ratio when zoom the image by wheeling mouse.
+
+### minZoomRatio
+
+- Type: `Number`
+- Default: `0.01`
+
+Define the min ratio of the image when zoom out.
+
+### maxZoomRatio
+
+- Type: `Number`
+- Default: `100`
+
+Define the max ratio of the image when zoom in.
+
 ### url
 
 - Type: `String` or `Function`
@@ -392,51 +437,6 @@ new Viewer(image, {
 });
 ```
 
-### container
-
-- Type: `Element` or `String`
-- Default: `'body'`
-- An element or a valid selector for [Document.querySelector](https://developer.mozilla.org/en-US/docs/Web/API/Document/querySelector)
-
-The container to put the viewer in modal mode.
-
-> Only available when the `inline` option is set to `false`.
-
-### className
-
-- Type: `String`
-- Default: `''`
-
-Custom class name(s) to add to the viewer's root element.
-
-### filter
-
-- Type: `Function`
-- Default: `null`
-
-Filter the images for viewing (should return `true` if the image is viewable).
-
-For example:
-
-```js
-new Viewer(images, {
-  filter(image) {
-    return image.complete;
-  },
-});
-```
-
-### toggleOnDblclick
-
-- Type: `Boolean`
-- Default: `true`
-
-Indicate if toggle the image size between its natural size and initial size when double click on the image or not.
-
-In other words, call the [`toggle`](#toggle) method automatically when double click on the image.
-
-> Requires [`dblclick`](https://developer.mozilla.org/en-US/docs/Web/Events/dblclick) event support.
-
 ### ready
 
 - Type: `Function`