React NativeActivityIndicatorIOS
animating bool #
Whether to show the indicator (true, the default) or hide it (false).
color string #
The foreground color of the spinner (default is gray).
size enum(// default
+React Native | Build Native Apps Using React Animation
@flow
static startAnimation(node: any, duration: number, delay: number, easing: (string | EasingFunction), properties: {[key: string]: any}) #
static stopAnimation(tag: number) #
{
- "methods": [
- {
- "line": 17,
- "source": "startAnimation: function(\n node: any,\n duration: number,\n delay: number,\n easing: (string | EasingFunction),\n properties: {[key: string]: any}\n ): number {\n var nodeHandle = +node.getNodeHandle();\n var easingSample = AnimationUtils.evaluateEasingFunction(duration, easing);\n var tag: number = RCTAnimationManager.startAnimation(nodeHandle, AnimationUtils.allocateTag(), duration, delay, easingSample, properties);\n return tag;\n }",
- "modifiers": [
- "static"
- ],
- "params": [
- {
- "typehint": "any",
- "name": "node"
- },
- {
- "typehint": "{\"type\":\"simple\",\"value\":\"number\",\"length\":1}",
- "name": "duration"
- },
- {
- "typehint": "{\"type\":\"simple\",\"value\":\"number\",\"length\":1}",
- "name": "delay"
- },
- {
- "typehint": "(string | EasingFunction)",
- "name": "easing"
- },
- {
- "typehint": "{[key: string]: any}",
- "name": "properties"
- }
- ],
- "tparams": null,
- "returntypehint": "{\"type\":\"simple\",\"value\":\"number\",\"length\":1}",
- "name": "startAnimation"
- },
- {
- "line": 30,
- "source": "stopAnimation: function(tag: number) {\n RCTAnimationManager.stopAnimation(tag);\n }",
- "modifiers": [
- "static"
- ],
- "params": [
- {
- "typehint": "{\"type\":\"simple\",\"value\":\"number\",\"length\":1}",
- "name": "tag"
- }
- ],
- "tparams": null,
- "returntypehint": null,
- "name": "stopAnimation"
- }
- ],
- "properties": [
- [
- [
- "static"
- ],
- "",
- "Mixin",
- "require('AnimationMixin')",
- "",
- 15
- ]
- ],
- "superClass": null,
- "type": "api",
- "line": 14,
- "name": "Animation",
- "docblock": "/**\n *\n * @flow\n */\n",
- "requires": [
- {
- "name": "NativeModules"
- },
- {
- "name": "AnimationUtils"
- },
- {
- "name": "AnimationMixin"
- }
- ]
-}AppState
{
- "methods": [
- {
- "line": 18,
- "source": "setApplicationIconBadgeNumber: function(number) {\n RKAppState.setApplicationIconBadgeNumber(number);\n }",
- "modifiers": [
- "static"
- ],
- "params": [
- {
- "typehint": null,
- "name": "number"
- }
- ],
- "tparams": null,
- "returntypehint": null,
- "name": "setApplicationIconBadgeNumber"
- },
- {
- "line": 22,
- "source": "getApplicationIconBadgeNumber: function(callback) {\n RKAppState.getApplicationIconBadgeNumber(callback);\n }",
- "modifiers": [
- "static"
- ],
- "params": [
- {
- "typehint": null,
- "name": "callback"
- }
- ],
- "tparams": null,
- "returntypehint": null,
- "name": "getApplicationIconBadgeNumber"
- }
- ],
- "properties": [],
- "superClass": null,
- "type": "api",
- "line": 16,
- "name": "AppState",
- "docblock": "/**\n *\n */\n",
- "requires": [
- {
- "name": "NativeModulesDeprecated"
- },
- {
- "name": "RCTDeviceEventEmitter"
- },
- {
- "name": "Subscribable"
- },
- {
- "name": "keyMirror"
- }
- ]
-}AppStateIOS
{
- "methods": [
- {
- "line": 20,
- "source": "static addEventListener(type, handler) {\n _appStateHandlers[handler] = RCTDeviceEventEmitter.addListener(\n DEVICE_APPSTATE_EVENT,\n (appStateData) => {\n handler(appStateData.app_state);\n }\n );\n }",
- "modifiers": [
- "static"
- ],
- "params": [
- {
- "typehint": null,
- "name": "type"
- },
- {
- "typehint": null,
- "name": "handler"
- }
- ],
- "tparams": null,
- "returntypehint": null,
- "name": "addEventListener"
- },
- {
- "line": 29,
- "source": "static removeEventListener(type, handler) {\n if (!_appStateHandlers[handler]) {\n return;\n }\n _appStateHandlers[handler].remove();\n _appStateHandlers[handler] = null;\n }",
- "modifiers": [
- "static"
- ],
- "params": [
- {
- "typehint": null,
- "name": "type"
- },
- {
- "typehint": null,
- "name": "handler"
- }
- ],
- "tparams": null,
- "returntypehint": null,
- "name": "removeEventListener"
- }
- ],
- "type": "api",
- "line": 18,
- "name": "AppStateIOS",
- "docblock": "/**\n *\n */\n",
- "requires": [
- {
- "name": "NativeModules"
- },
- {
- "name": "RCTDeviceEventEmitter"
- },
- {
- "name": "logError"
- }
- ]
-}CameraRoll
static saveImageWithTag(tag: string, successCallback, errorCallback) #
Saves the image with tag tag to the camera roll.
@param {string} tag - Can be any of the three kinds of tags we accept:
+
React Native | Build Native Apps Using React CameraRoll
Methods #
static saveImageWithTag(tag: string, successCallback, errorCallback) #
Saves the image with tag tag to the camera roll.
@param {string} tag - Can be any of the three kinds of tags we accept:
1. URL
2. assets-library tag
3. tag returned from storing an image in memory
static getPhotos(params: object, callback: function, errorCallback: function) #
Invokes callback with photo identifier objects from the local camera
roll of the device matching shape defined by getPhotosReturnChecker.
@param {object} params - See getPhotosParamChecker.
@param {function} callback - Invoked with arg of shape defined by
getPhotosReturnChecker on success.
-@param {function} errorCallback - Invoked with error message on error.
{
- "methods": [
- {
- "line": 96,
- "source": "static saveImageWithTag(tag, successCallback, errorCallback) {\n invariant(\n typeof tag === 'string',\n 'CameraRoll.saveImageWithTag tag must be a valid string.'\n );\n RKCameraRollManager.saveImageWithTag(\n tag,\n (imageTag) => {\n successCallback && successCallback(imageTag);\n },\n (errorMessage) => {\n errorCallback && errorCallback(errorMessage);\n });\n }",
- "docblock": "/**\n * Saves the image with tag `tag` to the camera roll.\n *\n * @param {string} tag - Can be any of the three kinds of tags we accept:\n * 1. URL\n * 2. assets-library tag\n * 3. tag returned from storing an image in memory\n */\n",
- "modifiers": [
- "static"
- ],
- "params": [
- {
- "typehint": "{\"type\":\"simple\",\"value\":\"string\",\"length\":1}",
- "name": "tag"
- },
- {
- "typehint": null,
- "name": "successCallback"
- },
- {
- "typehint": null,
- "name": "errorCallback"
- }
- ],
- "tparams": null,
- "returntypehint": null,
- "name": "saveImageWithTag"
- },
- {
- "line": 120,
- "source": "static getPhotos(params, callback, errorCallback) {\n var metaCallback = callback;\n if (__DEV__) {\n getPhotosParamChecker({params}, 'params', 'CameraRoll.getPhotos');\n invariant(\n typeof callback === 'function',\n 'CameraRoll.getPhotos callback must be a valid function.'\n );\n invariant(\n typeof errorCallback === 'function',\n 'CameraRoll.getPhotos errorCallback must be a valid function.'\n );\n }\n if (__DEV__) {\n metaCallback = (response) => {\n getPhotosReturnChecker(\n {response},\n 'response',\n 'CameraRoll.getPhotos callback'\n );\n callback(response);\n };\n }\n RKCameraRollManager.getPhotos(params, metaCallback, errorCallback);\n }",
- "docblock": "/**\n * Invokes `callback` with photo identifier objects from the local camera\n * roll of the device matching shape defined by `getPhotosReturnChecker`.\n *\n * @param {object} params - See `getPhotosParamChecker`.\n * @param {function} callback - Invoked with arg of shape defined by\n * `getPhotosReturnChecker` on success.\n * @param {function} errorCallback - Invoked with error message on error.\n */\n",
- "modifiers": [
- "static"
- ],
- "params": [
- {
- "typehint": "{\"type\":\"simple\",\"value\":\"object\",\"length\":1}",
- "name": "params"
- },
- {
- "typehint": "{\"type\":\"simple\",\"value\":\"function\",\"length\":1}",
- "name": "callback"
- },
- {
- "typehint": "{\"type\":\"simple\",\"value\":\"function\",\"length\":1}",
- "name": "errorCallback"
- }
- ],
- "tparams": null,
- "returntypehint": null,
- "name": "getPhotos"
- }
- ],
- "type": "api",
- "line": 87,
- "name": "CameraRoll",
- "docblock": "/**\n *\n */\n",
- "requires": [
- {
- "name": "ReactPropTypes"
- },
- {
- "name": "NativeModules"
- },
- {
- "name": "createStrictShapeTypeChecker"
- },
- {
- "name": "deepFreezeAndThrowOnMutationInDev"
- },
- {
- "name": "invariant"
- }
- ]
-}DatePickerIOS
Use DatePickerIOS to render a date/time picker (selector) on iOS. This is
+a controlled component, so you must hook in to the onDateChange callback
+and update the date prop in order for the component to update, otherwise
+the user's change will be reverted immediately to reflect props.date as the
+source of truth.
Props #
date Date #
The currently selected date.
maximumDate Date #
Maximum date.
Restricts the range of possible date/time values.
minimumDate Date #
Minimum date.
Restricts the range of possible date/time values.
minuteInterval enum(1, 2, 3, 4, 5, 6, 10, 12, 15, 20, 30) #
The interval at which minutes can be selected.
mode Object.keys(RKDatePickerIOSConsts.DatePickerModes) #
The date picker mode.
Valid modes on iOS are: 'date', 'time', 'datetime'.
onDateChange func #
Date change handler.
This is called when the user changes the date or time in the UI.
+The first and only argument is a Date object representing the new
+date and time.
timeZoneOffsetInMinutes number #
Timezone offset in seconds.
By default, the date picker will use the device's timezone. With this
+parameter, it is possible to force a certain timezone offset. For
+instance, to show times in Pacific Standard Time, pass -7 * 60.
In the following example, the text will trunca
to show only the first 17 characters plus '...' with a See More button to
expand the text to its full length.
render: function() {
return <ExpandingText truncLength={20} text={EXAMPLE_TEXT} />;
-},seeMoreStyle Text.propTypes.style #
The styles that will be applied to the See More button. Default
+},
Props #
seeMoreStyle Text.propTypes.style #
The styles that will be applied to the See More button. Default
is bold.
seeMoreText string #
The caption that will be appended at the end, by default it is
'See More'.
text string #
Text to be displayed. It will be truncated if the character length
is greater than the truncLength property.
textStyle Text.propTypes.style #
The styles that will be applied to the text (both truncated and
diff --git a/docs/image.html b/docs/image.html
index d44fae15b96..2ade56e1395 100644
--- a/docs/image.html
+++ b/docs/image.html
@@ -13,7 +13,7 @@ images from local disk, such as the camera roll.
Example usage:
/>
</View>
);
-},accessibilityLabel string #
accessibilityLabel - Custom string to display for accessibility.
accessible bool #
accessible - Whether this element should be revealed as an accessible
+},
Props #
accessibilityLabel string #
accessibilityLabel - Custom string to display for accessibility.
accessible bool #
accessible - Whether this element should be revealed as an accessible
element.
capInsets EdgeInsetsPropType #
capInsets - When the image is resized, the corners of the size specified
by capInsets will stay a fixed size, but the center content and borders
of the image will be stretched. This is useful for creating resizable
diff --git a/docs/layoutanimation.html b/docs/layoutanimation.html
index 883b34ba8bd..1046388a6e9 100644
--- a/docs/layoutanimation.html
+++ b/docs/layoutanimation.html
@@ -1,106 +1,4 @@
-
React Native | Build Native Apps Using React LayoutAnimation
static configureNext(config, onAnimationDidEnd, onError) #
static create(duration, type, creationProp) #
{
- "methods": [
- {
- "line": 48,
- "source": "configureNext(config, onAnimationDidEnd, onError) {\n configChecker({config}, 'config', 'LayoutAnimation.configureNext');\n RKUIManager.configureNextLayoutAnimation(config, onAnimationDidEnd, onError);\n }",
- "modifiers": [
- "static"
- ],
- "params": [
- {
- "typehint": null,
- "name": "config"
- },
- {
- "typehint": null,
- "name": "onAnimationDidEnd"
- },
- {
- "typehint": null,
- "name": "onError"
- }
- ],
- "tparams": null,
- "returntypehint": null,
- "name": "configureNext"
- },
- {
- "line": 52,
- "source": "create(duration, type, creationProp) {\n return {\n duration,\n create: {\n type,\n property: creationProp,\n },\n update: {\n type,\n },\n };\n }",
- "modifiers": [
- "static"
- ],
- "params": [
- {
- "typehint": null,
- "name": "duration"
- },
- {
- "typehint": null,
- "name": "type"
- },
- {
- "typehint": null,
- "name": "creationProp"
- }
- ],
- "tparams": null,
- "returntypehint": null,
- "name": "create"
- }
- ],
- "properties": [
- [
- [
- "static"
- ],
- "",
- "Types",
- "keyMirror({\n spring: true,\n linear: true,\n easeInEaseOut: true,\n easeIn: true,\n easeOut: true,\n})",
- "",
- 64
- ],
- [
- [
- "static"
- ],
- "",
- "Properties",
- "keyMirror({\n opacity: true,\n scaleXY: true,\n})",
- "",
- 65
- ],
- [
- [
- "static"
- ],
- "",
- "configChecker",
- "createStrictShapeTypeChecker({\n duration: PropTypes.number.isRequired,\n create: animChecker,\n update: animChecker,\n delete: animChecker,\n})",
- "",
- 66
- ]
- ],
- "superClass": null,
- "type": "api",
- "line": 47,
- "name": "LayoutAnimation",
- "docblock": "/**\n *\n */\n",
- "requires": [
- {
- "name": "ReactPropTypes"
- },
- {
- "name": "NativeModules"
- },
- {
- "name": "createStrictShapeTypeChecker"
- },
- {
- "name": "keyMirror"
- }
- ]
-}MapView
legalLabelInsets EdgeInsetsPropType #
Insets for the map's legal label, originally at bottom left of the map.
+
React Native | Build Native Apps Using React MapView
Props #
legalLabelInsets EdgeInsetsPropType #
Insets for the map's legal label, originally at bottom left of the map.
See EdgeInsetsPropType.js for more information.
maxDelta number #
Maximum size of area that can be displayed.
minDelta number #
Minimum size of area that can be displayed.
onRegionChange func #
Callback that is called continuously when the user is dragging the map.
onRegionChangeComplete func #
Callback that is called once, when the user is done moving the map.
pitchEnabled bool #
When this property is set to true and a valid camera is associated
with the map, the camera’s pitch angle is used to tilt the plane
of the map. When this property is set to false, the camera’s pitch
diff --git a/docs/navigatorios.html b/docs/navigatorios.html
index f1307319087..dd8f649412a 100644
--- a/docs/navigatorios.html
+++ b/docs/navigatorios.html
@@ -33,7 +33,7 @@ transitions back to it
resetTo(route) - Replaces the top it
initialRoute={...}
/>
),
-});initialRoute {component: func, title: string, passProps: object, backButtonTitle: string, rightButtonTitle: string, onRightButtonPress: func, wrapperStyle: View.propTypes.style} #
NavigatorIOS uses "route" objects to identify child views, their props,
+});
Props #
initialRoute {component: func, title: string, passProps: object, backButtonTitle: string, rightButtonTitle: string, onRightButtonPress: func, wrapperStyle: View.propTypes.style} #
NavigatorIOS uses "route" objects to identify child views, their props,
and navigation bar configuration. "push" and all the other navigation
operations expect routes to be like this:
itemWrapperStyle View.propTypes.style #
The default wrapper style for components in the navigator.
A common use case is to set the backgroundColor for every page
tintColor string #
The color used for buttons in the navigation bar
ScrollView
Component that wraps platform ScrollView while providing
integration with touch locking "responder" system.
Doesn't yet support other contained responders from blocking this scroll
-view from becoming the responder.
alwaysBounceHorizontal bool #
When true, the scroll view bounces horizontally when it reaches the end
+view from becoming the responder.
Props #
alwaysBounceHorizontal bool #
When true, the scroll view bounces horizontally when it reaches the end
even if the content is smaller than the scroll view itself. The default
value is true when horizontal={true} and false otherwise.
alwaysBounceVertical bool #
When true, the scroll view bounces vertically when it reaches the end
even if the content is smaller than the scroll view itself. The default
diff --git a/docs/slider.html b/docs/slider.html
index 518a4915a56..c2c31b5e990 100644
--- a/docs/slider.html
+++ b/docs/slider.html
@@ -1,4 +1,4 @@
-
React Native | Build Native Apps Using React Slider
onSlidingComplete func #
Callback called when the user finishes changing the value (e.g. when
+
React Native | Build Native Apps Using React Slider
Props #
onSlidingComplete func #
Callback called when the user finishes changing the value (e.g. when
the slider is released).
onValueChange func #
Callback continuously called while the user is dragging the slider.
style View.propTypes.style #
Used to style and layout the Slider. See StyleSheet.js and
ViewStylePropTypes.js for more info.
value number #
Initial value of the slider. The value should be between 0 and 1.
Default value is 0.
This is not a controlled component, e.g. if you don't update
diff --git a/docs/statusbarios.html b/docs/statusbarios.html
index 441fd5f2518..2b890dc7626 100644
--- a/docs/statusbarios.html
+++ b/docs/statusbarios.html
@@ -1,79 +1,4 @@
-
React Native | Build Native Apps Using React StatusBarIOS
@flow
static setStyle(style: number, animated: boolean) #
static setHidden(hidden: boolean, animation: number) #
{
- "methods": [
- {
- "line": 24,
- "source": "setStyle(style: number, animated: boolean) {\n animated = animated || false;\n RKStatusBarManager.setStyle(style, animated);\n }",
- "modifiers": [
- "static"
- ],
- "params": [
- {
- "typehint": "{\"type\":\"simple\",\"value\":\"number\",\"length\":1}",
- "name": "style"
- },
- {
- "typehint": "{\"type\":\"simple\",\"value\":\"boolean\",\"length\":1}",
- "name": "animated"
- }
- ],
- "tparams": null,
- "returntypehint": null,
- "name": "setStyle"
- },
- {
- "line": 29,
- "source": "setHidden(hidden: boolean, animation: number) {\n animation = animation || StatusBarIOS.Animation.none;\n RKStatusBarManager.setHidden(hidden, animation);\n }",
- "modifiers": [
- "static"
- ],
- "params": [
- {
- "typehint": "{\"type\":\"simple\",\"value\":\"boolean\",\"length\":1}",
- "name": "hidden"
- },
- {
- "typehint": "{\"type\":\"simple\",\"value\":\"number\",\"length\":1}",
- "name": "animation"
- }
- ],
- "tparams": null,
- "returntypehint": null,
- "name": "setHidden"
- }
- ],
- "properties": [
- [
- [
- "static"
- ],
- "",
- "Style",
- "{\n default: RKStatusBarManager.Style.default,\n lightContent: RKStatusBarManager.Style.lightContent\n }",
- "",
- 13
- ],
- [
- [
- "static"
- ],
- "",
- "Animation",
- "{\n none: RKStatusBarManager.Animation.none,\n fade: RKStatusBarManager.Animation.fade,\n slide: RKStatusBarManager.Animation.slide,\n }",
- "",
- 18
- ]
- ],
- "superClass": null,
- "type": "api",
- "line": 11,
- "name": "StatusBarIOS",
- "docblock": "/**\n *\n * @flow\n */\n",
- "requires": [
- {
- "name": "NativeModules"
- }
- ]
-}
Animation
@flow
static startAnimation(node: any, duration: number, delay: number, easing: (string | EasingFunction), properties: {[key: string]: any}) #
static stopAnimation(tag: number) #
{
- "methods": [
- {
- "line": 17,
- "source": "startAnimation: function(\n node: any,\n duration: number,\n delay: number,\n easing: (string | EasingFunction),\n properties: {[key: string]: any}\n ): number {\n var nodeHandle = +node.getNodeHandle();\n var easingSample = AnimationUtils.evaluateEasingFunction(duration, easing);\n var tag: number = RCTAnimationManager.startAnimation(nodeHandle, AnimationUtils.allocateTag(), duration, delay, easingSample, properties);\n return tag;\n }",
- "modifiers": [
- "static"
- ],
- "params": [
- {
- "typehint": "any",
- "name": "node"
- },
- {
- "typehint": "{\"type\":\"simple\",\"value\":\"number\",\"length\":1}",
- "name": "duration"
- },
- {
- "typehint": "{\"type\":\"simple\",\"value\":\"number\",\"length\":1}",
- "name": "delay"
- },
- {
- "typehint": "(string | EasingFunction)",
- "name": "easing"
- },
- {
- "typehint": "{[key: string]: any}",
- "name": "properties"
- }
- ],
- "tparams": null,
- "returntypehint": "{\"type\":\"simple\",\"value\":\"number\",\"length\":1}",
- "name": "startAnimation"
- },
- {
- "line": 30,
- "source": "stopAnimation: function(tag: number) {\n RCTAnimationManager.stopAnimation(tag);\n }",
- "modifiers": [
- "static"
- ],
- "params": [
- {
- "typehint": "{\"type\":\"simple\",\"value\":\"number\",\"length\":1}",
- "name": "tag"
- }
- ],
- "tparams": null,
- "returntypehint": null,
- "name": "stopAnimation"
- }
- ],
- "properties": [
- [
- [
- "static"
- ],
- "",
- "Mixin",
- "require('AnimationMixin')",
- "",
- 15
- ]
- ],
- "superClass": null,
- "type": "api",
- "line": 14,
- "name": "Animation",
- "docblock": "/**\n *\n * @flow\n */\n",
- "requires": [
- {
- "name": "NativeModules"
- },
- {
- "name": "AnimationUtils"
- },
- {
- "name": "AnimationMixin"
- }
- ]
-}AppState
{
- "methods": [
- {
- "line": 18,
- "source": "setApplicationIconBadgeNumber: function(number) {\n RKAppState.setApplicationIconBadgeNumber(number);\n }",
- "modifiers": [
- "static"
- ],
- "params": [
- {
- "typehint": null,
- "name": "number"
- }
- ],
- "tparams": null,
- "returntypehint": null,
- "name": "setApplicationIconBadgeNumber"
- },
- {
- "line": 22,
- "source": "getApplicationIconBadgeNumber: function(callback) {\n RKAppState.getApplicationIconBadgeNumber(callback);\n }",
- "modifiers": [
- "static"
- ],
- "params": [
- {
- "typehint": null,
- "name": "callback"
- }
- ],
- "tparams": null,
- "returntypehint": null,
- "name": "getApplicationIconBadgeNumber"
- }
- ],
- "properties": [],
- "superClass": null,
- "type": "api",
- "line": 16,
- "name": "AppState",
- "docblock": "/**\n *\n */\n",
- "requires": [
- {
- "name": "NativeModulesDeprecated"
- },
- {
- "name": "RCTDeviceEventEmitter"
- },
- {
- "name": "Subscribable"
- },
- {
- "name": "keyMirror"
- }
- ]
-}AppStateIOS
{
- "methods": [
- {
- "line": 20,
- "source": "static addEventListener(type, handler) {\n _appStateHandlers[handler] = RCTDeviceEventEmitter.addListener(\n DEVICE_APPSTATE_EVENT,\n (appStateData) => {\n handler(appStateData.app_state);\n }\n );\n }",
- "modifiers": [
- "static"
- ],
- "params": [
- {
- "typehint": null,
- "name": "type"
- },
- {
- "typehint": null,
- "name": "handler"
- }
- ],
- "tparams": null,
- "returntypehint": null,
- "name": "addEventListener"
- },
- {
- "line": 29,
- "source": "static removeEventListener(type, handler) {\n if (!_appStateHandlers[handler]) {\n return;\n }\n _appStateHandlers[handler].remove();\n _appStateHandlers[handler] = null;\n }",
- "modifiers": [
- "static"
- ],
- "params": [
- {
- "typehint": null,
- "name": "type"
- },
- {
- "typehint": null,
- "name": "handler"
- }
- ],
- "tparams": null,
- "returntypehint": null,
- "name": "removeEventListener"
- }
- ],
- "type": "api",
- "line": 18,
- "name": "AppStateIOS",
- "docblock": "/**\n *\n */\n",
- "requires": [
- {
- "name": "NativeModules"
- },
- {
- "name": "RCTDeviceEventEmitter"
- },
- {
- "name": "logError"
- }
- ]
-}CameraRoll
static saveImageWithTag(tag: string, successCallback, errorCallback) #
Saves the image with tag tag to the camera roll.
@param {string} tag - Can be any of the three kinds of tags we accept: +
CameraRoll
Methods #
static saveImageWithTag(tag: string, successCallback, errorCallback) #
Saves the image with tag tag to the camera roll.
@param {string} tag - Can be any of the three kinds of tags we accept: 1. URL 2. assets-library tag 3. tag returned from storing an image in memory
static getPhotos(params: object, callback: function, errorCallback: function) #
Invokes callback with photo identifier objects from the local camera
roll of the device matching shape defined by getPhotosReturnChecker.
@param {object} params - See getPhotosParamChecker.
@param {function} callback - Invoked with arg of shape defined by
getPhotosReturnChecker on success.
-@param {function} errorCallback - Invoked with error message on error.
{
- "methods": [
- {
- "line": 96,
- "source": "static saveImageWithTag(tag, successCallback, errorCallback) {\n invariant(\n typeof tag === 'string',\n 'CameraRoll.saveImageWithTag tag must be a valid string.'\n );\n RKCameraRollManager.saveImageWithTag(\n tag,\n (imageTag) => {\n successCallback && successCallback(imageTag);\n },\n (errorMessage) => {\n errorCallback && errorCallback(errorMessage);\n });\n }",
- "docblock": "/**\n * Saves the image with tag `tag` to the camera roll.\n *\n * @param {string} tag - Can be any of the three kinds of tags we accept:\n * 1. URL\n * 2. assets-library tag\n * 3. tag returned from storing an image in memory\n */\n",
- "modifiers": [
- "static"
- ],
- "params": [
- {
- "typehint": "{\"type\":\"simple\",\"value\":\"string\",\"length\":1}",
- "name": "tag"
- },
- {
- "typehint": null,
- "name": "successCallback"
- },
- {
- "typehint": null,
- "name": "errorCallback"
- }
- ],
- "tparams": null,
- "returntypehint": null,
- "name": "saveImageWithTag"
- },
- {
- "line": 120,
- "source": "static getPhotos(params, callback, errorCallback) {\n var metaCallback = callback;\n if (__DEV__) {\n getPhotosParamChecker({params}, 'params', 'CameraRoll.getPhotos');\n invariant(\n typeof callback === 'function',\n 'CameraRoll.getPhotos callback must be a valid function.'\n );\n invariant(\n typeof errorCallback === 'function',\n 'CameraRoll.getPhotos errorCallback must be a valid function.'\n );\n }\n if (__DEV__) {\n metaCallback = (response) => {\n getPhotosReturnChecker(\n {response},\n 'response',\n 'CameraRoll.getPhotos callback'\n );\n callback(response);\n };\n }\n RKCameraRollManager.getPhotos(params, metaCallback, errorCallback);\n }",
- "docblock": "/**\n * Invokes `callback` with photo identifier objects from the local camera\n * roll of the device matching shape defined by `getPhotosReturnChecker`.\n *\n * @param {object} params - See `getPhotosParamChecker`.\n * @param {function} callback - Invoked with arg of shape defined by\n * `getPhotosReturnChecker` on success.\n * @param {function} errorCallback - Invoked with error message on error.\n */\n",
- "modifiers": [
- "static"
- ],
- "params": [
- {
- "typehint": "{\"type\":\"simple\",\"value\":\"object\",\"length\":1}",
- "name": "params"
- },
- {
- "typehint": "{\"type\":\"simple\",\"value\":\"function\",\"length\":1}",
- "name": "callback"
- },
- {
- "typehint": "{\"type\":\"simple\",\"value\":\"function\",\"length\":1}",
- "name": "errorCallback"
- }
- ],
- "tparams": null,
- "returntypehint": null,
- "name": "getPhotos"
- }
- ],
- "type": "api",
- "line": 87,
- "name": "CameraRoll",
- "docblock": "/**\n *\n */\n",
- "requires": [
- {
- "name": "ReactPropTypes"
- },
- {
- "name": "NativeModules"
- },
- {
- "name": "createStrictShapeTypeChecker"
- },
- {
- "name": "deepFreezeAndThrowOnMutationInDev"
- },
- {
- "name": "invariant"
- }
- ]
-}DatePickerIOS
Use DatePickerIOS to render a date/time picker (selector) on iOS. This is
+a controlled component, so you must hook in to the onDateChange callback
+and update the date prop in order for the component to update, otherwise
+the user's change will be reverted immediately to reflect props.date as the
+source of truth.
Props #
date Date #
The currently selected date.
maximumDate Date #
Maximum date.
Restricts the range of possible date/time values.
minimumDate Date #
Minimum date.
Restricts the range of possible date/time values.
minuteInterval enum(1, 2, 3, 4, 5, 6, 10, 12, 15, 20, 30) #
The interval at which minutes can be selected.
mode Object.keys(RKDatePickerIOSConsts.DatePickerModes) #
The date picker mode.
Valid modes on iOS are: 'date', 'time', 'datetime'.
onDateChange func #
Date change handler.
This is called when the user changes the date or time in the UI. +The first and only argument is a Date object representing the new +date and time.
timeZoneOffsetInMinutes number #
Timezone offset in seconds.
By default, the date picker will use the device's timezone. With this +parameter, it is possible to force a certain timezone offset. For +instance, to show times in Pacific Standard Time, pass -7 * 60.
In the following example, the text will trunca to show only the first 17 characters plus '...' with a See More button to expand the text to its full length.
seeMoreStyle Text.propTypes.style #
The styles that will be applied to the See More button. Default +},
Props #
seeMoreStyle Text.propTypes.style #
The styles that will be applied to the See More button. Default is bold.
seeMoreText string #
The caption that will be appended at the end, by default it is
'See More'.
text string #
Text to be displayed. It will be truncated if the character length
is greater than the truncLength property.
textStyle Text.propTypes.style #
The styles that will be applied to the text (both truncated and diff --git a/docs/image.html b/docs/image.html index d44fae15b96..2ade56e1395 100644 --- a/docs/image.html +++ b/docs/image.html @@ -13,7 +13,7 @@ images from local disk, such as the camera roll.
Example usage:
accessibilityLabel string #
accessibilityLabel - Custom string to display for accessibility.
accessible bool #
accessible - Whether this element should be revealed as an accessible +},
Props #
accessibilityLabel string #
accessibilityLabel - Custom string to display for accessibility.
accessible bool #
accessible - Whether this element should be revealed as an accessible element.
capInsets EdgeInsetsPropType #
capInsets - When the image is resized, the corners of the size specified by capInsets will stay a fixed size, but the center content and borders of the image will be stretched. This is useful for creating resizable diff --git a/docs/layoutanimation.html b/docs/layoutanimation.html index 883b34ba8bd..1046388a6e9 100644 --- a/docs/layoutanimation.html +++ b/docs/layoutanimation.html @@ -1,106 +1,4 @@ -
LayoutAnimation
static configureNext(config, onAnimationDidEnd, onError) #
static create(duration, type, creationProp) #
{
- "methods": [
- {
- "line": 48,
- "source": "configureNext(config, onAnimationDidEnd, onError) {\n configChecker({config}, 'config', 'LayoutAnimation.configureNext');\n RKUIManager.configureNextLayoutAnimation(config, onAnimationDidEnd, onError);\n }",
- "modifiers": [
- "static"
- ],
- "params": [
- {
- "typehint": null,
- "name": "config"
- },
- {
- "typehint": null,
- "name": "onAnimationDidEnd"
- },
- {
- "typehint": null,
- "name": "onError"
- }
- ],
- "tparams": null,
- "returntypehint": null,
- "name": "configureNext"
- },
- {
- "line": 52,
- "source": "create(duration, type, creationProp) {\n return {\n duration,\n create: {\n type,\n property: creationProp,\n },\n update: {\n type,\n },\n };\n }",
- "modifiers": [
- "static"
- ],
- "params": [
- {
- "typehint": null,
- "name": "duration"
- },
- {
- "typehint": null,
- "name": "type"
- },
- {
- "typehint": null,
- "name": "creationProp"
- }
- ],
- "tparams": null,
- "returntypehint": null,
- "name": "create"
- }
- ],
- "properties": [
- [
- [
- "static"
- ],
- "",
- "Types",
- "keyMirror({\n spring: true,\n linear: true,\n easeInEaseOut: true,\n easeIn: true,\n easeOut: true,\n})",
- "",
- 64
- ],
- [
- [
- "static"
- ],
- "",
- "Properties",
- "keyMirror({\n opacity: true,\n scaleXY: true,\n})",
- "",
- 65
- ],
- [
- [
- "static"
- ],
- "",
- "configChecker",
- "createStrictShapeTypeChecker({\n duration: PropTypes.number.isRequired,\n create: animChecker,\n update: animChecker,\n delete: animChecker,\n})",
- "",
- 66
- ]
- ],
- "superClass": null,
- "type": "api",
- "line": 47,
- "name": "LayoutAnimation",
- "docblock": "/**\n *\n */\n",
- "requires": [
- {
- "name": "ReactPropTypes"
- },
- {
- "name": "NativeModules"
- },
- {
- "name": "createStrictShapeTypeChecker"
- },
- {
- "name": "keyMirror"
- }
- ]
-}MapView
legalLabelInsets EdgeInsetsPropType #
Insets for the map's legal label, originally at bottom left of the map. +
MapView
Props #
legalLabelInsets EdgeInsetsPropType #
Insets for the map's legal label, originally at bottom left of the map.
See EdgeInsetsPropType.js for more information.
maxDelta number #
Maximum size of area that can be displayed.
minDelta number #
Minimum size of area that can be displayed.
onRegionChange func #
Callback that is called continuously when the user is dragging the map.
onRegionChangeComplete func #
Callback that is called once, when the user is done moving the map.
pitchEnabled bool #
When this property is set to true and a valid camera is associated
with the map, the camera’s pitch angle is used to tilt the plane
of the map. When this property is set to false, the camera’s pitch
diff --git a/docs/navigatorios.html b/docs/navigatorios.html
index f1307319087..dd8f649412a 100644
--- a/docs/navigatorios.html
+++ b/docs/navigatorios.html
@@ -33,7 +33,7 @@ transitions back to it
resetTo(route) - Replaces the top it
initialRoute={...}
/>
),
-});initialRoute {component: func, title: string, passProps: object, backButtonTitle: string, rightButtonTitle: string, onRightButtonPress: func, wrapperStyle: View.propTypes.style} #
NavigatorIOS uses "route" objects to identify child views, their props, +});
Props #
initialRoute {component: func, title: string, passProps: object, backButtonTitle: string, rightButtonTitle: string, onRightButtonPress: func, wrapperStyle: View.propTypes.style} #
NavigatorIOS uses "route" objects to identify child views, their props, and navigation bar configuration. "push" and all the other navigation operations expect routes to be like this:
itemWrapperStyle View.propTypes.style #
The default wrapper style for components in the navigator. A common use case is to set the backgroundColor for every page
tintColor string #
The color used for buttons in the navigation bar
ScrollView
Component that wraps platform ScrollView while providing integration with touch locking "responder" system.
Doesn't yet support other contained responders from blocking this scroll -view from becoming the responder.
alwaysBounceHorizontal bool #
When true, the scroll view bounces horizontally when it reaches the end +view from becoming the responder.
Props #
alwaysBounceHorizontal bool #
When true, the scroll view bounces horizontally when it reaches the end
even if the content is smaller than the scroll view itself. The default
value is true when horizontal={true} and false otherwise.
alwaysBounceVertical bool #
When true, the scroll view bounces vertically when it reaches the end even if the content is smaller than the scroll view itself. The default diff --git a/docs/slider.html b/docs/slider.html index 518a4915a56..c2c31b5e990 100644 --- a/docs/slider.html +++ b/docs/slider.html @@ -1,4 +1,4 @@ -
Slider
onSlidingComplete func #
Callback called when the user finishes changing the value (e.g. when +
Slider
Props #
onSlidingComplete func #
Callback called when the user finishes changing the value (e.g. when the slider is released).
onValueChange func #
Callback continuously called while the user is dragging the slider.
style View.propTypes.style #
Used to style and layout the Slider. See StyleSheet.js and
ViewStylePropTypes.js for more info.
value number #
Initial value of the slider. The value should be between 0 and 1. Default value is 0.
This is not a controlled component, e.g. if you don't update diff --git a/docs/statusbarios.html b/docs/statusbarios.html index 441fd5f2518..2b890dc7626 100644 --- a/docs/statusbarios.html +++ b/docs/statusbarios.html @@ -1,79 +1,4 @@ -
StatusBarIOS
@flow
static setStyle(style: number, animated: boolean) #
static setHidden(hidden: boolean, animation: number) #
{
- "methods": [
- {
- "line": 24,
- "source": "setStyle(style: number, animated: boolean) {\n animated = animated || false;\n RKStatusBarManager.setStyle(style, animated);\n }",
- "modifiers": [
- "static"
- ],
- "params": [
- {
- "typehint": "{\"type\":\"simple\",\"value\":\"number\",\"length\":1}",
- "name": "style"
- },
- {
- "typehint": "{\"type\":\"simple\",\"value\":\"boolean\",\"length\":1}",
- "name": "animated"
- }
- ],
- "tparams": null,
- "returntypehint": null,
- "name": "setStyle"
- },
- {
- "line": 29,
- "source": "setHidden(hidden: boolean, animation: number) {\n animation = animation || StatusBarIOS.Animation.none;\n RKStatusBarManager.setHidden(hidden, animation);\n }",
- "modifiers": [
- "static"
- ],
- "params": [
- {
- "typehint": "{\"type\":\"simple\",\"value\":\"boolean\",\"length\":1}",
- "name": "hidden"
- },
- {
- "typehint": "{\"type\":\"simple\",\"value\":\"number\",\"length\":1}",
- "name": "animation"
- }
- ],
- "tparams": null,
- "returntypehint": null,
- "name": "setHidden"
- }
- ],
- "properties": [
- [
- [
- "static"
- ],
- "",
- "Style",
- "{\n default: RKStatusBarManager.Style.default,\n lightContent: RKStatusBarManager.Style.lightContent\n }",
- "",
- 13
- ],
- [
- [
- "static"
- ],
- "",
- "Animation",
- "{\n none: RKStatusBarManager.Animation.none,\n fade: RKStatusBarManager.Animation.fade,\n slide: RKStatusBarManager.Animation.slide,\n }",
- "",
- 18
- ]
- ],
- "superClass": null,
- "type": "api",
- "line": 11,
- "name": "StatusBarIOS",
- "docblock": "/**\n *\n * @flow\n */\n",
- "requires": [
- {
- "name": "NativeModules"
- }
- ]
-}