Create example, demo and documentation

Author: Nhacsam

README.md

@@ -4,3 +4,43 @@ A ScrollView-like component that:
  - Has a fixed image header
  - Keep the image as a nav bar
  - Works on iOS and Android
+
+## Installation
+
+```
+$ npm install react-native-image-header-scroll-view --save
+```
+
+## Demo
+
+![react-native-image-header-scroll-view demo](./demo.gif)
+
+## Basic Usage 
+
+```jsx
+import HeaderImageScrollView from 'react-native-image-header-scroll-view';
+
+// Inside of a component's render() method:
+render() {
+  return (
+    <HeaderImageScrollView
+      maxHeight={200}
+      minHeight={50}
+      renderHeader={() => (
+        <Image source={require('image.jpg')} style={styles.image} />
+      )}
+    >
+      <View style={{ height: 1000 }}>
+          <Text>Scroll Me!</Text>
+      </View>
+    </HeaderImageScrollView>
+  );
+}
+```
+
+## Other open-source modules by the folks at [BAM](http://github.com/bamlab)
+
+ * [generator-rn-toolbox](https://github.com/bamlab/generator-rn-toolbox)
+ * [react-native-image-resizer](https://github.com/bamlab/react-native-image-resizer)
+ * [react-native-numberpicker-dialog](https://github.com/bamlab/react-native-numberpicker-dialog)
+ * [react-native-animated-picker](https://github.com/bamlab/react-native-animated-picker)

demo.gif

@@ -0,0 +1,3 @@
+{
+"presets": ["react-native"]
+}

exemples/.babelrc

@@ -0,0 +1,6 @@
+
+[android]
+  target = Google Inc.:Google APIs:23
+
+[maven_repositories]
+  central = https://repo1.maven.org/maven2

exemples/.buckconfig

@@ -0,0 +1,44 @@
+[ignore]
+; We fork some components by platform
+.*/*[.]android.js
+
+; Ignore "BUCK" generated dirs
+<PROJECT_ROOT>/\.buckd/
+
+; Ignore unexpected extra "@providesModule"
+.*/node_modules/.*/node_modules/fbjs/.*
+
+; Ignore duplicate module providers
+; For RN Apps installed via npm, "Libraries" folder is inside
+; "node_modules/react-native" but in the source repo it is in the root
+.*/Libraries/react-native/React.js
+.*/Libraries/react-native/ReactNative.js
+
+[include]
+
+[libs]
+node_modules/react-native/Libraries/react-native/react-native-interface.js
+node_modules/react-native/flow
+flow/
+
+[options]
+module.system=haste
+
+experimental.strict_type_args=true
+
+munge_underscores=true
+
+module.name_mapper='^[./a-zA-Z0-9$_-]+\.\(bmp\|gif\|jpg\|jpeg\|png\|psd\|svg\|webp\|m4v\|mov\|mp4\|mpeg\|mpg\|webm\|aac\|aiff\|caf\|m4a\|mp3\|wav\|html\|pdf\)$' -> 'RelativeImageStub'
+
+suppress_type=$FlowIssue
+suppress_type=$FlowFixMe
+suppress_type=$FixMe
+
+suppress_comment=\\(.\\|\n\\)*\\$FlowFixMe\\($\\|[^(]\\|(\\(>=0\\.\\(3[0-6]\\|[1-2][0-9]\\|[0-9]\\).[0-9]\\)? *\\(site=[a-z,_]*react_native[a-z,_]*\\)?)\\)
+suppress_comment=\\(.\\|\n\\)*\\$FlowIssue\\((\\(>=0\\.\\(3[0-6]\\|1[0-9]\\|[1-2][0-9]\\).[0-9]\\)? *\\(site=[a-z,_]*react_native[a-z,_]*\\)?)\\)?:? #[0-9]+
+suppress_comment=\\(.\\|\n\\)*\\$FlowFixedInNextDeploy
+
+unsafe.enable_getters_and_setters=true
+
+[version]
+^0.36.0

exemples/.flowconfig

@@ -0,0 +1 @@
+*.pbxproj -text

exemples/.gitattributes

@@ -0,0 +1,53 @@
+# OSX
+#
+.DS_Store
+
+# Xcode
+#
+build/
+*.pbxuser
+!default.pbxuser
+*.mode1v3
+!default.mode1v3
+*.mode2v3
+!default.mode2v3
+*.perspectivev3
+!default.perspectivev3
+xcuserdata
+*.xccheckout
+*.moved-aside
+DerivedData
+*.hmap
+*.ipa
+*.xcuserstate
+project.xcworkspace
+
+# Android/IntelliJ
+#
+build/
+.idea
+.gradle
+local.properties
+*.iml
+
+# node.js
+#
+node_modules/
+npm-debug.log
+
+# BUCK
+buck-out/
+\.buckd/
+android/app/libs
+*.keystore
+
+# fastlane
+#
+# It is recommended to not store the screenshots in the git repo. Instead, use fastlane to re-generate the
+# screenshots whenever they are needed.
+# For more information about the recommended setup visit:
+# https://github.com/fastlane/fastlane/blob/master/fastlane/docs/Gitignore.md
+
+fastlane/report.xml
+fastlane/Preview.html
+fastlane/screenshots

exemples/.gitignore

@@ -0,0 +1 @@
+{}

exemples/.watchmanconfig

@@ -0,0 +1,92 @@
+import React, { Component } from 'react';
+import {
+  StyleSheet,
+  Text,
+  View,
+  Image,
+  Dimensions,
+  StatusBar
+} from 'react-native';
+
+import HeaderImageScrollView from 'react-native-image-header-scroll-view';
+import tvShowContent from './assets/tvShowContent';
+
+
+const TvShow = () => (
+  <View style={{ flex:1 }}>
+    <StatusBar barStyle="light-content" />
+    <HeaderImageScrollView
+      maxHeight={200}
+      minHeight={50}
+      renderHeader={() => (
+        <Image source={tvShowContent.image} style={styles.image} />
+      )}
+    >
+      <View style={styles.section}>
+        <Text style={styles.title}>
+          <Text style={styles.name}>{tvShowContent.title}</Text>, ({tvShowContent.year})
+        </Text>
+      </View>
+      <View style={styles.section}>
+        <Text style={styles.sectionTitle}>Overview</Text>
+        <Text style={styles.sectionContent}>{tvShowContent.overview}</Text>
+      </View>
+      <View style={styles.section}>
+        <Text style={styles.sectionTitle}>Keywords</Text>
+        <View style={styles.keywords}>
+          {tvShowContent.keywords.map((keyword) => (
+            <View style={styles.keywordContainer} key={keyword}>
+              <Text style={styles.keyword}>{keyword}</Text>
+            </View>
+          ))}
+        </View>
+      </View>
+    </HeaderImageScrollView>
+  </View>
+);
+
+const styles = StyleSheet.create({
+  image: {
+    height: 200,
+    width: Dimensions.get('window').width,
+    alignSelf: 'stretch',
+    resizeMode: 'cover',
+  },
+  title: {
+    fontSize: 20,
+  },
+  name: {
+    fontWeight: 'bold',
+  },
+  section: {
+    padding: 20,
+    borderBottomWidth: 1,
+    borderBottomColor: '#cccccc',
+  },
+  sectionTitle: {
+    fontSize: 18,
+    fontWeight: 'bold',
+  },
+  sectionContent: {
+    fontSize: 16,
+    textAlign: 'justify',
+  },
+  keywords: {
+    flexDirection: 'row',
+    justifyContent: 'flex-start',
+    alignItems: 'flex-start',
+    flexWrap: 'wrap',
+  },
+  keywordContainer: {
+    backgroundColor: '#999999',
+    borderRadius: 10,
+    margin: 10,
+    padding: 10,
+  },
+  keyword: {
+    fontSize: 16,
+    color: 'white',
+  },
+});
+
+export default TvShow;

exemples/TvShow.js

@@ -0,0 +1,12 @@
+import 'react-native';
+import React from 'react';
+import Index from '../index.android.js';
+
+// Note: test renderer must be required after react-native.
+import renderer from 'react-test-renderer';
+
+it('renders correctly', () => {
+  const tree = renderer.create(
+    <Index />
+  );
+});