Merge pull request #52 from rpearce/controlled-uncontrolled

Controlled vs uncontrolled

.babelrc

@@ -1,4 +1,4 @@
 {
-  "presets": ["latest", "react"],
+  "presets": ["env", "react"],
   "plugins": ["transform-object-assign"]
 }

CHANGELOG.md

@@ -0,0 +1,24 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [2.0.0] - 2017-09-21
+### Added
+- Changelog (so meta...)
+- When in controlled mode (`isZoomed` is provided), the `onUnzoom` callback will fire when the component normally would have closed
+
+### Changed
+- Differentiation between controlled & uncontrolled modes (when `isZoomed` is passed vs letting component control itself)
+
+### Deprecated
+- n/a
+
+### Removed
+- Removed preload functionality
+
+### Fixed
+- Support for the component immediately zooming if `isZoomed={true}` is provided on mount

README.md

@@ -63,6 +63,11 @@ Each one of these image props accepts normal `image` props, for example:
 | `style` | object | no | Additional styles to apply to the image |
 | ... | ... | no | ... |
 
+## Controlled vs Uncontrolled Modes
+Similar to how an `<input />` works in React, if the consumer initially chooses to control the `isZoomed` value, then this means the consumer is now responsible for telling the component the value of `isZoomed`. If the consumer instantiates the component with a non-null `isZoomed` value and subsequently does _not_ pass a value for it on updates, then an error will be thrown notifying the consumer that this is a controlled component.
+
+The reverse is true, as well. If the component is instantiated without an `isZoomed` value, then the component will handle its own `isZoomed` state. If a non-null `isZoomed` prop is passed _after_ instantiation, then an error will be thrown notifying the consumer that this component controls its own state.
+
 ## Browser Support
 Currently, this has only been tested on the latest modern browsers. Pull requests are welcome.