Releasing react-native-kenburns-view 0.0.1

nHiRanZ · Jan 18, 2016 · 1390c45 · 1390c45
commit 1390c45
Show file tree

Hide file tree

Showing 10 changed files with 447 additions and 0 deletions.
diff --git a/.idea/.name b/.idea/.name
diff --git a/.idea/encodings.xml b/.idea/encodings.xml
diff --git a/.idea/jsLibraryMappings.xml b/.idea/jsLibraryMappings.xml
diff --git a/.idea/misc.xml b/.idea/misc.xml
diff --git a/.idea/modules.xml b/.idea/modules.xml
diff --git a/.idea/react-native-kenburns-view.iml b/.idea/react-native-kenburns-view.iml
diff --git a/.idea/workspace.xml b/.idea/workspace.xml
diff --git a/README.md b/README.md
@@ -0,0 +1,31 @@
+# react-native-kenburns-view
+
+[`KenBurns`](https://en.wikipedia.org/wiki/Ken_Burns_effect) Image Effect for React Native. Based on Image Component [`Image` Component](https://facebook.github.io/react-native/docs/image.html).
+Version: 0.0.1
+
+Tested on React Native iOS Apps only. Feedback: [email protected]
+
+## Installation
+
+```bash
+$ npm i react-native-kenburns-view --save
+```
+
+## Usage
+
+```jsx
+<BurnsImage tension={4} friction={50} imageWidth={200} imageHeight={100} sourceUri={{uri: ./images/kenburnsimage.jpg}} placeholderSource={{uri: './images/placeholder.jpg'}}>
+</BurnsImage>
+```
+
+
+## API (props)
+
+| Prop | Description |
+|---|---|
+|**`tension`**| `int` Tension Value. |
+|**`friction`**| `int` Friction Value. |
+|**`imageWidth`**| `int` Image Width. |
+|**`imageHeight`**| `int` Image Height. |
+|**`sourceUri`**| `URI String` Image URL. |
+|**`placeholderSource`**| `URI String` Placeholder Image URL (Possibly a Local Image). |
diff --git a/index.js b/index.js
@@ -0,0 +1,10 @@
+/**
+ * Created by Nimila Hiranya Samarasinghe
+ * Links: https://github.com/nHiRanZ
+ *
+ * Version: 0.0.1
+ *
+ * Description: This reflects the KenBurns effect in a React Native Image
+ */
+
+module.exports = require('./lib/KenBurnsImage');