- };
- }
-
- // see react-jsx.d.ts
- export function createElement(type: React.ReactType,
- props?: P,
- ...children: React.ReactNode[]): React.ReactElement
;
-
-
- export type Runnable = (appParameters: any) => void;
-
-
- // Similar to React.SyntheticEvent except for nativeEvent
- interface NativeSyntheticEvent {
- bubbles: boolean
- cancelable: boolean
- currentTarget: EventTarget
- defaultPrevented: boolean
- eventPhase: number
- isTrusted: boolean
- nativeEvent: T
- preventDefault(): void
- stopPropagation(): void
- target: EventTarget
- timeStamp: Date
- type: string
- }
-
- export interface NativeTouchEvent {
- /**
- * Array of all touch events that have changed since the last event
- */
- changedTouches: NativeTouchEvent[]
-
- /**
- * The ID of the touch
- */
- identifier: string
-
- /**
- * The X position of the touch, relative to the element
- */
- locationX: number
-
- /**
- * The Y position of the touch, relative to the element
- */
- locationY: number
-
- /**
- * The X position of the touch, relative to the screen
- */
- pageX: number
-
- /**
- * The Y position of the touch, relative to the screen
- */
- pageY: number
-
- /**
- * The node id of the element receiving the touch event
- */
- target: string
-
- /**
- * A time identifier for the touch, useful for velocity calculation
- */
- timestamp: number
-
- /**
- * Array of all current touches on the screen
- */
- touches: NativeTouchEvent[]
- }
-
- export interface GestureResponderEvent extends NativeSyntheticEvent {
- }
-
-
- export interface PointProperties {
- x: number
- y: number
- }
-
- export interface Insets {
- top?: number
- left?: number
- bottom?: number
- right?: number
- }
-
- /**
- * //FIXME: need to find documentation on which component is a TTouchable and can implement that interface
- * @see React.DOMAtributes
- */
- export interface Touchable {
- onTouchStart?: (event: GestureResponderEvent) => void
- onTouchMove?: (event: GestureResponderEvent) => void
- onTouchEnd?: (event: GestureResponderEvent) => void
- onTouchCancel?: (event: GestureResponderEvent) => void
- onTouchEndCapture?: (event: GestureResponderEvent) => void
- }
-
- export type ComponentProvider = () => React.ComponentClass
-
- export type AppConfig = {
- appKey: string;
- component?: ComponentProvider
- run?: Runnable;
- }
-
- // https://github.com/facebook/react-native/blob/master/Libraries/AppRegistry/AppRegistry.js
- /**
- * `AppRegistry` is the JS entry point to running all React Native apps. App
- * root components should register themselves with
- * `AppRegistry.registerComponent`, then the native system can load the bundle
- * for the app and then actually run the app when it's ready by invoking
- * `AppRegistry.runApplication`.
- *
- * To "stop" an application when a view should be destroyed, call
- * `AppRegistry.unmountApplicationComponentAtRootTag` with the tag that was
- * pass into `runApplication`. These should always be used as a pair.
- *
- * `AppRegistry` should be `require`d early in the `require` sequence to make
- * sure the JS execution environment is setup before other modules are
- * `require`d.
- */
- export class AppRegistry {
- static registerConfig(config: AppConfig[]): void;
-
- static registerComponent( appKey: string, getComponentFunc: ComponentProvider ): string;
-
- static registerRunnable(appKey: string, func: Runnable): string;
-
- static getAppKeys(): string[];
-
- static unmountApplicationComponentAtRootTag(rootTag: number): void;
-
- static runApplication(appKey: string, appParameters: any): void;
- }
-
- export interface LayoutAnimationTypes {
- spring: string
- linear: string
- easeInEaseOut: string
- easeIn: string
- easeOut: string
- }
-
- export interface LayoutAnimationProperties {
- opacity: string
- scaleXY: string
- }
-
- export interface LayoutAnimationAnim {
- duration?: number
- delay?: number
- springDamping?: number
- initialVelocity?: number
- type?: string //LayoutAnimationTypes
- property?: string //LayoutAnimationProperties
- }
-
- export interface LayoutAnimationConfig {
- duration: number
- create?: LayoutAnimationAnim
- update?: LayoutAnimationAnim
- delete?: LayoutAnimationAnim
- }
-
- /** Automatically animates views to their new positions when the next layout happens.
- * A common way to use this API is to call LayoutAnimation.configureNext before
- * calling setState. */
- export interface LayoutAnimationStatic {
- /** Schedules an animation to happen on the next layout.
- * @param config Specifies animation properties:
- * `duration` in milliseconds
- * `create`, config for animating in new views (see Anim type)
- * `update`, config for animating views that have been updated (see Anim type)
- * @param onAnimationDidEnd Called when the animation finished. Only supported on iOS.
- */
- configureNext: ( config: LayoutAnimationConfig, onAnimationDidEnd?: () => void ) => void
- /** Helper for creating a config for configureNext. */
- create: (duration: number, type?: string, creationProp?: string) => LayoutAnimationConfig
- Types: LayoutAnimationTypes
- Properties: LayoutAnimationProperties
- configChecker: (shapeTypes: {[key: string]: any}) => any
- Presets: {
- easeInEaseOut: LayoutAnimationConfig
- linear: LayoutAnimationConfig
- spring: LayoutAnimationConfig
- }
- easeInEaseOut: (config: LayoutAnimationConfig, onAnimationDidEnd?: () => void) => void
- linear: (config: LayoutAnimationConfig, onAnimationDidEnd?: () => void) => void
- spring: (config: LayoutAnimationConfig, onAnimationDidEnd?: () => void) => void
- }
-
- export type FlexAlignType = "flex-start" | "flex-end" | "center" | "stretch";
- export type FlexJustifyType = "flex-start" | "flex-end" | "center" | "space-between" | "space-around";
- export type FlexDirection = "row" | "column" | "row-reverse" | "column-reverse";
-
- /**
- * Flex Prop Types
- * @see https://facebook.github.io/react-native/docs/flexbox.html#proptypes
- * @see LayoutPropTypes.js
- */
- export interface FlexStyle {
-
- alignItems?: FlexAlignType;
- alignSelf?: "auto" | FlexAlignType;
- borderBottomWidth?: number
- borderLeftWidth?: number
- borderRightWidth?: number
- borderTopWidth?: number
- borderWidth?: number
- bottom?: number
- flex?: number
- flexGrow?: number
- flexShrink?: number
- flexBasis?: number
- flexDirection?: FlexDirection
- flexWrap?: "wrap" | "nowrap"
- height?: number
- justifyContent?: FlexJustifyType
- left?: number
- minWidth?: number
- maxWidth?: number
- minHeight?: number
- maxHeight?: number
- margin?: number
- marginBottom?: number
- marginHorizontal?: number
- marginLeft?: number
- marginRight?: number
- marginTop?: number
- marginVertical?: number
- overflow?: "visible" | "hidden" | "scroll"
- padding?: number
- paddingBottom?: number
- paddingHorizontal?: number
- paddingLeft?: number
- paddingRight?: number
- paddingTop?: number
- paddingVertical?: number
- position?: "absolute" | "relative"
- right?: number
- top?: number
- width?: number
-
- /**
- * @platform ios
- */
- zIndex?: number
- }
-
- /**
- * @see ShadowPropTypesIOS.js
- */
- export interface ShadowPropTypesIOSStatic {
- /**
- * Sets the drop shadow color
- * @platform ios
- */
- shadowColor: string
-
- /**
- * Sets the drop shadow offset
- * @platform ios
- */
- shadowOffset: { width: number, height: number }
-
- /**
- * Sets the drop shadow opacity (multiplied by the color's alpha component)
- * @platform ios
- */
- shadowOpacity: number
-
- /**
- * Sets the drop shadow blur radius
- * @platform ios
- */
- shadowRadius: number
- }
-
- type GetCurrentPositionOptions = {
- timeout: number
- maximumAge: number
- enableHighAccuracy: boolean
- distanceFilter: number
- }
-
- type WatchPositionOptions = {
- timeout: number
- maximumAge: number
- enableHighAccuracy: boolean
- distanceFilter: number
- }
-
- type GeolocationReturnType = {
- coords: {
- latitude: number
- longitude: number
- altitude?: number
- accuracy?: number
- altitudeAccuracy?: number
- heading?: number
- speed?: number
- }
- timestamp: number
- }
-
- interface PerpectiveTransform {
- perspective: number;
- }
-
- interface RotateTransform {
- rotate: string;
- }
-
- interface RotateXTransform {
- rotateX: string;
- }
-
- interface RotateYTransform {
- rotateY: string;
- }
-
- interface RotateZTransform {
- rotateZ: string;
- }
-
- interface ScaleTransform {
- scale: number;
- }
-
- interface ScaleXTransform {
- scaleX: number;
- }
-
- interface ScaleYTransform {
- scaleY: number;
- }
-
- interface TranslateXTransform {
- translateX: number;
- }
-
- interface TranslateYTransform {
- translateY: number;
- }
-
- interface SkewXTransform {
- skewX: string;
- }
-
- interface SkewYTransform {
- skewY: string;
- }
-
- export interface TransformsStyle {
-
- transform?: (PerpectiveTransform|RotateTransform|RotateXTransform|RotateYTransform|RotateZTransform|ScaleTransform|ScaleXTransform|ScaleYTransform|TranslateXTransform|TranslateYTransform|SkewXTransform|SkewYTransform)[]
- transformMatrix?: Array
- rotation?: number
- scaleX?: number
- scaleY?: number
- translateX?: number
- translateY?: number
- }
-
-
- export interface StyleSheetProperties {
- hairlineWidth: number
- flatten(style: T): T
- }
-
- export interface LayoutRectangle {
- x: number;
- y: number;
- width: number;
- height: number;
- }
-
- // @see TextProperties.onLayout
- export interface LayoutChangeEvent {
- nativeEvent: {
- layout: LayoutRectangle
- }
- }
-
- export interface TextStyleIOS extends ViewStyle {
- letterSpacing?: number
- textDecorationColor?: string
- textDecorationStyle?: "solid" | "double" | "dotted" | "dashed"
- writingDirection?: "auto" | "ltr" | "rtl"
- }
-
- export interface TextStyleAndroid extends ViewStyle {
- textAlignVertical?: "auto" | "top" | "bottom" | "center"
- includeFontPadding?: boolean
- }
-
- // @see https://facebook.github.io/react-native/docs/text.html#style
- export interface TextStyle extends TextStyleIOS, TextStyleAndroid, ViewStyle {
- color?: string
- fontFamily?: string
- fontSize?: number
- fontStyle?: "normal" | "italic"
- /**
- * Specifies font weight. The values 'normal' and 'bold' are supported
- * for most fonts. Not all fonts have a variant for each of the numeric
- * values, in that case the closest one is chosen.
- */
- fontWeight?: "normal" | "bold" | "100" | "200" | "300" | "400" | "500" | "600" | "700" | "800" | "900"
- letterSpacing?: number
- lineHeight?: number
- /**
- * Specifies text alignment.
- * The value 'justify' is only supported on iOS.
- */
- textAlign?: "auto" | "left" | "right" | "center"
- textDecorationLine?: "none" | "underline" | "line-through" | "underline line-through"
- textDecorationStyle?: "solid" | "double" | "dotted" | "dashed"
- textDecorationColor?: string
- textShadowColor?: string
- textShadowOffset?: { width: number, height: number }
- textShadowRadius?: number
- testID?: string
- }
-
- export interface TextPropertiesIOS {
- /**
- * Specifies whether fonts should scale to respect Text Size accessibility setting on iOS. The
- * default is `true`.
- */
- allowFontScaling?: boolean
-
- /**
- * Specifies whether font should be scaled down automatically to fit given style constraints.
- */
- adjustsFontSizeToFit?: boolean
-
- /**
- * Specifies smallest possible scale a font can reach when adjustsFontSizeToFit is enabled. (values 0.01-1.0).
- */
- minimumFontScale?: number
-
- /**
- * When `true`, no visual change is made when text is pressed down. By
- * default, a gray oval highlights the text on press down.
- */
- suppressHighlighting?: boolean
- }
-
- export interface TextPropertiesAndroid {
- /**
- * Lets the user select text, to use the native copy and paste functionality.
- */
- selectable?: boolean
- }
-
- // https://facebook.github.io/react-native/docs/text.html#props
- export interface TextProperties extends TextPropertiesIOS, TextPropertiesAndroid, React.Props {
-
- /**
- * When set to `true`, indicates that the view is an accessibility element. The default value
- * for a `Text` element is `true`.
- *
- * See the
- * [Accessibility guide](/react-native/docs/accessibility.html#accessible-ios-android)
- * for more information.
- */
- accessible?: boolean
-
- /**
- * This can be one of the following values:
- *
- * - `head` - The line is displayed so that the end fits in the container and the missing text
- * at the beginning of the line is indicated by an ellipsis glyph. e.g., "...wxyz"
- * - `middle` - The line is displayed so that the beginning and end fit in the container and the
- * missing text in the middle is indicated by an ellipsis glyph. "ab...yz"
- * - `tail` - The line is displayed so that the beginning fits in the container and the
- * missing text at the end of the line is indicated by an ellipsis glyph. e.g., "abcd..."
- * - `clip` - Lines are not drawn past the edge of the text container.
- *
- * The default is `tail`.
- *
- * `numberOfLines` must be set in conjunction with this prop.
- *
- * > `clip` is working only for iOS
- */
- ellipsizeMode?: 'head' | 'middle' | 'tail' | 'clip'
-
- /**
- * Line Break mode. Works only with numberOfLines.
- * clip is working only for iOS
- */
- lineBreakMode?: 'head' | 'middle' | 'tail' | 'clip'
-
- /**
- * Used to truncate the text with an ellipsis after computing the text
- * layout, including line wrapping, such that the total number of lines
- * does not exceed this number.
- *
- * This prop is commonly used with `ellipsizeMode`.
- */
- numberOfLines?: number
-
- /**
- * Invoked on mount and layout changes with
- *
- * {nativeEvent: { layout: {x, y, width, height}}}.
- */
- onLayout?: (event: LayoutChangeEvent) => void
-
- /**
- * This function is called on press.
- * Text intrinsically supports press handling with a default highlight state (which can be disabled with suppressHighlighting).
- */
- onPress?: () => void
-
- /**
- * This function is called on long press.
- * e.g., `onLongPress={this.increaseSize}>``
- */
- onLongPress?: () => void
-
- /**
- * @see https://facebook.github.io/react-native/docs/text.html#style
- */
- style?: TextStyle
-
- /**
- * Used to locate this view in end-to-end tests.
- */
- testID?: string
- }
-
- /**
- * A React component for displaying text which supports nesting, styling, and touch handling.
- */
- export interface TextStatic extends NativeMethodsMixin, React.ClassicComponentClass {
-
- }
-
- type DataDetectorTypes = 'phoneNumber' | 'link' | 'address' | 'calendarEvent' | 'none' | 'all';
-
- /**
- * DocumentSelectionState is responsible for maintaining selection information
- * for a document.
- *
- * It is intended for use by AbstractTextEditor-based components for
- * identifying the appropriate start/end positions to modify the
- * DocumentContent, and for programatically setting browser selection when
- * components re-render.
- */
- export interface DocumentSelectionState extends EventEmitter {
- new(anchor: number, focus: number): DocumentSelectionState
-
- /**
- * Apply an update to the state. If either offset value has changed,
- * set the values and emit the `change` event. Otherwise no-op.
- *
- * @param {number} anchor
- * @param {number} focus
- */
- update(anchor: number, focus: number): void
-
- /**
- * Given a max text length, constrain our selection offsets to ensure
- * that the selection remains strictly within the text range.
- *
- * @param {number} maxLength
- */
- constrainLength(maxLength: number): void
-
- focus(): void
- blur(): void
- hasFocus(): boolean
- isCollapsed(): boolean
- isBackward(): boolean
-
- getAnchorOffset(): number
- getFocusOffset(): number
- getStartOffset(): number
- getEndOffset(): number
- overlaps(start: number, end: number): boolean
- }
-
-
- /**
- * IOS Specific properties for TextInput
- * @see https://facebook.github.io/react-native/docs/textinput.html#props
- */
- export interface TextInputIOSProperties {
-
- /**
- * enum('never', 'while-editing', 'unless-editing', 'always')
- * When the clear button should appear on the right side of the text view
- */
- clearButtonMode?: 'never' | 'while-editing' | 'unless-editing' | 'always'
-
- /**
- * If true, clears the text field automatically when editing begins
- */
- clearTextOnFocus?: boolean
-
- /**
- * Determines the types of data converted to clickable URLs in the text input.
- * Only valid if `multiline={true}` and `editable={false}`.
- * By default no data types are detected.
- *
- * You can provide one type or an array of many types.
- *
- * Possible values for `dataDetectorTypes` are:
- *
- * - `'phoneNumber'`
- * - `'link'`
- * - `'address'`
- * - `'calendarEvent'`
- * - `'none'`
- * - `'all'`
- */
- dataDetectorTypes?: DataDetectorTypes | DataDetectorTypes[]
-
- /**
- * If true, the keyboard disables the return key when there is no text and automatically enables it when there is text.
- * The default value is false.
- */
- enablesReturnKeyAutomatically?: boolean
-
- /**
- * Determines the color of the keyboard.
- */
- keyboardAppearance?: 'default' | 'light' | 'dark'
-
- /**
- * Callback that is called when a key is pressed.
- * Pressed key value is passed as an argument to the callback handler.
- * Fires before onChange callbacks.
- */
- onKeyPress?: (key: string) => void
-
- /**
- * See DocumentSelectionState.js, some state that is responsible for maintaining selection information for a document
- */
- selectionState?: DocumentSelectionState
-
-
- }
-
- /**
- * Android Specific properties for TextInput
- * @see https://facebook.github.io/react-native/docs/textinput.html#props
- */
- export interface TextInputAndroidProperties {
-
- /**
- * If defined, the provided image resource will be rendered on the left.
- */
- inlineImageLeft?: string
-
- /**
- * Padding between the inline image, if any, and the text input itself.
- */
- inlineImagePadding?: number
-
- /**
- * Sets the number of lines for a TextInput.
- * Use it with multiline set to true to be able to fill the lines.
- */
- numberOfLines?: number
-
- /**
- * Sets the return key to the label. Use it instead of `returnKeyType`.
- * @platform android
- */
- returnKeyLabel?: string
-
- /**
- * The color of the textInput underline.
- */
- underlineColorAndroid?: string
- }
-
- export type KeyboardType = "default" | "email-address" | "numeric" | "phone-pad"
- export type KeyboardTypeIOS = "ascii-capable" | "numbers-and-punctuation" | "url" | "number-pad" | "name-phone-pad" | "decimal-pad" | "twitter" | "web-search"
-
- export type ReturnKeyType = "done" | "go" | "next" | "search" | "send"
- export type ReturnKeyTypeAndroid = "none" | "previous"
- export type ReturnKeyTypeIOS = "default" | "google" | "join" | "route" | "yahoo" | "emergency-call"
-
- /**
- * @see https://facebook.github.io/react-native/docs/textinput.html#props
- */
- export interface TextInputProperties extends ViewProperties, TextInputIOSProperties, TextInputAndroidProperties, React.Props {
-
- /**
- * Can tell TextInput to automatically capitalize certain characters.
- * characters: all characters,
- * words: first letter of each word
- * sentences: first letter of each sentence (default)
- * none: don't auto capitalize anything
- *
- * https://facebook.github.io/react-native/docs/textinput.html#autocapitalize
- */
- autoCapitalize?: "none" | "sentences" | "words" | "characters"
-
- /**
- * If false, disables auto-correct.
- * The default value is true.
- */
- autoCorrect?: boolean
-
- /**
- * If true, focuses the input on componentDidMount.
- * The default value is false.
- */
- autoFocus?: boolean
-
- /**
- * If true, the text field will blur when submitted.
- * The default value is true.
- */
- blurOnSubmit?: boolean
-
- /**
- * Provides an initial value that will change when the user starts typing.
- * Useful for simple use-cases where you don't want to deal with listening to events
- * and updating the value prop to keep the controlled state in sync.
- */
- defaultValue?: string
-
- /**
- * If false, text is not editable. The default value is true.
- */
- editable?: boolean
-
- /**
- * enum("default", 'numeric', 'email-address', "ascii-capable", 'numbers-and-punctuation', 'url', 'number-pad', 'phone-pad', 'name-phone-pad', 'decimal-pad', 'twitter', 'web-search')
- * Determines which keyboard to open, e.g.numeric.
- * The following values work across platforms: - default - numeric - email-address - phone-pad
- */
- keyboardType?: KeyboardType | KeyboardTypeIOS
-
- /**
- * Limits the maximum number of characters that can be entered.
- * Use this instead of implementing the logic in JS to avoid flicker.
- */
- maxLength?: number
-
- /**
- * If true, the text input can be multiple lines. The default value is false.
- */
- multiline?: boolean
-
- /**
- * Callback that is called when the text input is blurred
- */
- onBlur?: () => void
-
- /**
- * Callback that is called when the text input's text changes.
- */
- onChange?: (event: { nativeEvent: { text: string, contentSize: { width: number, height: number }, target: number, eventCount: number } }) => void
-
- /**
- * Callback that is called when the text input's text changes.
- * Changed text is passed as an argument to the callback handler.
- */
- onChangeText?: (text: string) => void
-
- /**
- * Callback that is called when the text input's content size changes.
- * This will be called with
- * `{ nativeEvent: { contentSize: { width, height } } }`.
- *
- * Only called for multiline text inputs.
- */
- onContentSizeChange?: ( event: {nativeEvent: {contentSize: { width: number, height: number}}} ) => void
-
- /**
- * Callback that is called when text input ends.
- */
- onEndEditing?: (event: { nativeEvent: { text: string } }) => void
-
- /**
- * Callback that is called when the text input is focused
- */
- onFocus?: () => void
-
- /**
- * Callback that is called when the text input selection is changed.
- */
- onSelectionChange?: (event: { nativeEvent: { selection: { start: number, end: number }, target: number } }) => void
-
- /**
- * Callback that is called when the text input's submit button is pressed.
- */
- onSubmitEditing?: (event: { nativeEvent: { text: string } }) => void
-
- /**
- * The string that will be rendered before text input has been entered
- */
- placeholder?: string
-
- /**
- * The text color of the placeholder string
- */
- placeholderTextColor?: string
-
- /**
- * enum('default', 'go', 'google', 'join', 'next', 'route', 'search', 'send', 'yahoo', 'done', 'emergency-call')
- * Determines how the return key should look.
- */
- returnKeyType?: ReturnKeyType | ReturnKeyTypeAndroid | ReturnKeyTypeIOS
-
- /**
- * If true, the text input obscures the text entered so that sensitive text like passwords stay secure.
- * The default value is false.
- */
- secureTextEntry?: boolean
-
- /**
- * If true, all text will automatically be selected on focus
- */
- selectTextOnFocus?: boolean
-
- /**
- * The start and end of the text input's selection. Set start and end to
- * the same value to position the cursor.
- */
- selection?: { start: number, end?: number }
-
- /**
- * The highlight (and cursor on ios) color of the text input
- */
- selectionColor?: string
-
- /**
- * Styles
- */
- style?: TextStyle
-
- /**
- * Used to locate this view in end-to-end tests
- */
- testID?: string
-
- /**
- * The value to show for the text input. TextInput is a controlled component,
- * which means the native value will be forced to match this value prop if provided.
- * For most uses this works great, but in some cases this may cause flickering - one common cause is preventing edits by keeping value the same.
- * In addition to simply setting the same value, either set editable={false},
- * or set/update maxLength to prevent unwanted edits without flicker.
- */
- value?: string
-
- ref?: Ref
- }
-
- /**
- * This class is responsible for coordinating the "focused"
- * state for TextInputs. All calls relating to the keyboard
- * should be funneled through here
- */
- interface TextInputState {
- /**
- * Returns the ID of the currently focused text field, if one exists
- * If no text field is focused it returns null
- */
- currentlyFocusedField(): number
-
- /**
- * @param {number} TextInputID id of the text field to focus
- * Focuses the specified text field
- * noop if the text field was already focused
- */
- focusTextInput(textFieldID?: number): void
-
- /**
- * @param {number} textFieldID id of the text field to focus
- * Unfocuses the specified text field
- * noop if it wasn't focused
- */
- blurTextInput(textFieldID?: number) : void
- }
-
- /**
- * @see https://facebook.github.io/react-native/docs/textinput.html#methods
- */
- export interface TextInputStatic extends NativeMethodsMixin, TimerMixin, React.ComponentClass {
- State: TextInputState
-
- /**
- * Returns if the input is currently focused.
- */
- isFocused: () => boolean
-
- /**
- * Removes all text from the input.
- */
- clear: () => void
- }
-
- export type ToolbarAndroidAction = {
- /**
- * title: required, the title of this action
- */
- title: string
-
- /**
- * icon: the icon for this action, e.g. require('./some_icon.png')
- */
- icon?: ImageURISource
-
- /**
- * show: when to show this action as an icon or hide it in the overflow menu: always, ifRoom or never
- */
- show?: "always" | "ifRoom" | "never"
-
- /**
- * showWithText: boolean, whether to show text alongside the icon or not
- */
- showWithText?: boolean
- }
-
- export interface ToolbarAndroidProperties extends ViewProperties, React.Props {
-
- /**
- * Sets possible actions on the toolbar as part of the action menu. These are displayed as icons
- * or text on the right side of the widget. If they don't fit they are placed in an 'overflow'
- * menu.
- *
- * This property takes an array of objects, where each object has the following keys:
- *
- * * `title`: **required**, the title of this action
- * * `icon`: the icon for this action, e.g. `require('./some_icon.png')`
- * * `show`: when to show this action as an icon or hide it in the overflow menu: `always`,
- * `ifRoom` or `never`
- * * `showWithText`: boolean, whether to show text alongside the icon or not
- */
- actions?: ToolbarAndroidAction[]
-
- /**
- * Sets the content inset for the toolbar ending edge.
- * The content inset affects the valid area for Toolbar content other
- * than the navigation button and menu. Insets define the minimum
- * margin for these components and can be used to effectively align
- * Toolbar content along well-known gridlines.
- */
- contentInsetEnd?: number
-
- /**
- * Sets the content inset for the toolbar starting edge.
- * The content inset affects the valid area for Toolbar content
- * other than the navigation button and menu. Insets define the
- * minimum margin for these components and can be used to effectively
- * align Toolbar content along well-known gridlines.
- */
- contentInsetStart?: number
-
- /**
- * Sets the toolbar logo.
- */
- logo?: ImageURISource
-
- /**
- * Sets the navigation icon.
- */
- navIcon?: ImageURISource
-
- /**
- * Callback that is called when an action is selected. The only
- * argument that is passed to the callback is the position of the
- * action in the actions array.
- */
- onActionSelected?: (position: number) => void
-
- /**
- * Callback called when the icon is selected.
- */
- onIconClicked?: () => void
-
- /**
- * Sets the overflow icon.
- */
- overflowIcon?: ImageURISource
-
- /**
- * Used to set the toolbar direction to RTL.
- * In addition to this property you need to add
- * android:supportsRtl="true"
- * to your application AndroidManifest.xml and then call
- * setLayoutDirection(LayoutDirection.RTL) in your MainActivity
- * onCreate method.
- */
- rtl?: boolean
-
- /**
- * Sets the toolbar subtitle.
- */
- subtitle?: string
-
- /**
- * Sets the toolbar subtitle color.
- */
- subtitleColor?: string
-
- /**
- * Used to locate this view in end-to-end tests.
- */
- testID?: string
-
- /**
- * Sets the toolbar title.
- */
- title?: string
-
- /**
- * Sets the toolbar title color.
- */
- titleColor?: string
-
- ref?: Ref
- }
-
- /**
- * React component that wraps the Android-only [`Toolbar` widget][0]. A Toolbar can display a logo,
- * navigation icon (e.g. hamburger menu), a title & subtitle and a list of actions. The title and
- * subtitle are expanded so the logo and navigation icons are displayed on the left, title and
- * subtitle in the middle and the actions on the right.
- *
- * If the toolbar has an only child, it will be displayed between the title and actions.
- *
- * Although the Toolbar supports remote images for the logo, navigation and action icons, this
- * should only be used in DEV mode where `require('./some_icon.png')` translates into a packager
- * URL. In release mode you should always use a drawable resource for these icons. Using
- * `require('./some_icon.png')` will do this automatically for you, so as long as you don't
- * explicitly use e.g. `{uri: 'http://...'}`, you will be good.
- *
- * [0]: https://developer.android.com/reference/android/support/v7/widget/Toolbar.html
- */
- export interface ToolbarAndroidStatic extends NativeMethodsMixin, React.ComponentClass {
-
- }
-
-
- /**
- * Gesture recognition on mobile devices is much more complicated than web.
- * A touch can go through several phases as the app determines what the user's intention is.
- * For example, the app needs to determine if the touch is scrolling, sliding on a widget, or tapping.
- * This can even change during the duration of a touch. There can also be multiple simultaneous touches.
- *
- * The touch responder system is needed to allow components to negotiate these touch interactions
- * without any additional knowledge about their parent or child components.
- * This system is implemented in ResponderEventPlugin.js, which contains further details and documentation.
- *
- * Best Practices
- * Users can feel huge differences in the usability of web apps vs. native, and this is one of the big causes.
- * Every action should have the following attributes:
- * Feedback/highlighting- show the user what is handling their touch, and what will happen when they release the gesture
- * Cancel-ability- when making an action, the user should be able to abort it mid-touch by dragging their finger away
- *
- * These features make users more comfortable while using an app,
- * because it allows people to experiment and interact without fear of making mistakes.
- *
- * TouchableHighlight and Touchable*
- * The responder system can be complicated to use.
- * So we have provided an abstract Touchable implementation for things that should be "tappable".
- * This uses the responder system and allows you to easily configure tap interactions declaratively.
- * Use TouchableHighlight anywhere where you would use a button or link on web.
- */
- export interface GestureResponderHandlers {
-
- /**
- * A view can become the touch responder by implementing the correct negotiation methods.
- * There are two methods to ask the view if it wants to become responder:
- */
-
- /**
- * Does this view want to become responder on the start of a touch?
- */
- onStartShouldSetResponder?: (event: GestureResponderEvent) => boolean
-
- /**
- * Called for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?
- */
- onMoveShouldSetResponder?: (event: GestureResponderEvent) => boolean
-
- /**
- * If the View returns true and attempts to become the responder, one of the following will happen:
- */
-
- onResponderEnd?: ( event: GestureResponderEvent ) => void
-
- /**
- * The View is now responding for touch events.
- * This is the time to highlight and show the user what is happening
- */
- onResponderGrant?: (event: GestureResponderEvent) => void
-
- /**
- * Something else is the responder right now and will not release it
- */
- onResponderReject?: (event: GestureResponderEvent) => void
-
- /**
- * If the view is responding, the following handlers can be called:
- */
-
- /**
- * The user is moving their finger
- */
- onResponderMove?: (event: GestureResponderEvent) => void
-
- /**
- * Fired at the end of the touch, ie "touchUp"
- */
- onResponderRelease?: (event: GestureResponderEvent) => void
-
- onResponderStart?: ( event: GestureResponderEvent ) => void
-
- /**
- * Something else wants to become responder.
- * Should this view release the responder? Returning true allows release
- */
- onResponderTerminationRequest?: (event: GestureResponderEvent) => boolean
-
- /**
- * The responder has been taken from the View.
- * Might be taken by other views after a call to onResponderTerminationRequest,
- * or might be taken by the OS without asking (happens with control center/ notification center on iOS)
- */
- onResponderTerminate?: (event: GestureResponderEvent) => void
-
- /**
- * onStartShouldSetResponder and onMoveShouldSetResponder are called with a bubbling pattern,
- * where the deepest node is called first.
- * That means that the deepest component will become responder when multiple Views return true for *ShouldSetResponder handlers.
- * This is desirable in most cases, because it makes sure all controls and buttons are usable.
- *
- * However, sometimes a parent will want to make sure that it becomes responder.
- * This can be handled by using the capture phase.
- * Before the responder system bubbles up from the deepest component,
- * it will do a capture phase, firing on*ShouldSetResponderCapture.
- * So if a parent View wants to prevent the child from becoming responder on a touch start,
- * it should have a onStartShouldSetResponderCapture handler which returns true.
- */
- onStartShouldSetResponderCapture?: (event: GestureResponderEvent) => boolean
-
- /**
- * onStartShouldSetResponder and onMoveShouldSetResponder are called with a bubbling pattern,
- * where the deepest node is called first.
- * That means that the deepest component will become responder when multiple Views return true for *ShouldSetResponder handlers.
- * This is desirable in most cases, because it makes sure all controls and buttons are usable.
- *
- * However, sometimes a parent will want to make sure that it becomes responder.
- * This can be handled by using the capture phase.
- * Before the responder system bubbles up from the deepest component,
- * it will do a capture phase, firing on*ShouldSetResponderCapture.
- * So if a parent View wants to prevent the child from becoming responder on a touch start,
- * it should have a onStartShouldSetResponderCapture handler which returns true.
- */
- onMoveShouldSetResponderCapture?: () => void;
-
- }
-
- // @see https://facebook.github.io/react-native/docs/view.html#style
- export interface ViewStyle extends FlexStyle, TransformsStyle {
- backfaceVisibility?: "visible" | "hidden"
- backgroundColor?: string;
- borderBottomColor?: string;
- borderBottomLeftRadius?: number;
- borderBottomRightRadius?: number;
- borderBottomWidth?: number;
- borderColor?: string;
- borderLeftColor?: string;
- borderRadius?: number;
- borderRightColor?: string;
- borderRightWidth?: number;
- borderStyle?: "solid" | "dotted" | "dashed"
- borderTopColor?: string;
- borderTopLeftRadius?: number;
- borderTopRightRadius?: number;
- borderTopWidth?: number
- opacity?: number;
- overflow?: "visible" | "hidden"
- shadowColor?: string;
- shadowOffset?: { width: number, height: number };
- shadowOpacity?: number;
- shadowRadius?: number;
- elevation?: number;
- testID?: string;
- }
-
-
- export interface ViewPropertiesIOS {
-
- /**
- * Provides additional traits to screen reader.
- * By default no traits are provided unless specified otherwise in element
- *
- * @enum('none', 'button', 'link', 'header', 'search', 'image', 'selected', 'plays', 'key', 'text','summary', 'disabled', 'frequentUpdates', 'startsMedia', 'adjustable', 'allowsDirectInteraction', 'pageTurn')
- */
- accessibilityTraits?: ViewAccessibilityTraits | ViewAccessibilityTraits[];
-
- /**
- * Whether this view should be rendered as a bitmap before compositing.
- *
- * On iOS, this is useful for animations and interactions that do not modify this component's dimensions nor its children;
- * for example, when translating the position of a static view, rasterization allows the renderer to reuse a cached bitmap of a static view
- * and quickly composite it during each frame.
- *
- * Rasterization incurs an off-screen drawing pass and the bitmap consumes memory.
- * Test and measure when using this property.
- */
- shouldRasterizeIOS?: boolean
- }
-
- export interface ViewPropertiesAndroid {
-
- /**
- * Indicates to accessibility services to treat UI component like a native one.
- * Works for Android only.
- *
- * @enum('none', 'button', 'radiobutton_checked', 'radiobutton_unchecked' )
- */
- accessibilityComponentType?: 'none' | 'button' | 'radiobutton_checked' | 'radiobutton_unchecked'
-
-
- /**
- * Indicates to accessibility services whether the user should be notified when this view changes.
- * Works for Android API >= 19 only.
- * See http://developer.android.com/reference/android/view/View.html#attr_android:accessibilityLiveRegion for references.
- */
- accessibilityLiveRegion?: 'none' | 'polite' | 'assertive'
-
- /**
- * Views that are only used to layout their children or otherwise don't draw anything
- * may be automatically removed from the native hierarchy as an optimization.
- * Set this property to false to disable this optimization and ensure that this View exists in the native view hierarchy.
- */
- collapsable?: boolean
-
-
- /**
- * Controls how view is important for accessibility which is if it fires accessibility events
- * and if it is reported to accessibility services that query the screen.
- * Works for Android only. See http://developer.android.com/reference/android/R.attr.html#importantForAccessibility for references.
- *
- * Possible values:
- * 'auto' - The system determines whether the view is important for accessibility - default (recommended).
- * 'yes' - The view is important for accessibility.
- * 'no' - The view is not important for accessibility.
- * 'no-hide-descendants' - The view is not important for accessibility, nor are any of its descendant views.
- */
- importantForAccessibility?: 'auto' | 'yes' | 'no' | 'no-hide-descendants'
-
-
- /**
- * Whether this view needs to rendered offscreen and composited with an alpha in order to preserve 100% correct colors and blending behavior.
- * The default (false) falls back to drawing the component and its children
- * with an alpha applied to the paint used to draw each element instead of rendering the full component offscreen and compositing it back with an alpha value.
- * This default may be noticeable and undesired in the case where the View you are setting an opacity on
- * has multiple overlapping elements (e.g. multiple overlapping Views, or text and a background).
- *
- * Rendering offscreen to preserve correct alpha behavior is extremely expensive
- * and hard to debug for non-native developers, which is why it is not turned on by default.
- * If you do need to enable this property for an animation,
- * consider combining it with renderToHardwareTextureAndroid if the view contents are static (i.e. it doesn't need to be redrawn each frame).
- * If that property is enabled, this View will be rendered off-screen once,
- * saved in a hardware texture, and then composited onto the screen with an alpha each frame without having to switch rendering targets on the GPU.
- */
- needsOffscreenAlphaCompositing?: boolean
-
-
- /**
- * Whether this view should render itself (and all of its children) into a single hardware texture on the GPU.
- *
- * On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale:
- * in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can just be
- * re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.
- */
- renderToHardwareTextureAndroid?: boolean;
-
- }
-
- /**
- * @see https://facebook.github.io/react-native/docs/view.html#props
- */
- export interface ViewProperties extends ViewPropertiesAndroid, ViewPropertiesIOS, GestureResponderHandlers, Touchable, React.Props {
-
- /**
- * Overrides the text that's read by the screen reader when the user interacts with the element. By default, the label is constructed by traversing all the children and accumulating all the Text nodes separated by space.
- */
- accessibilityLabel?: string;
-
- /**
- * When true, indicates that the view is an accessibility element.
- * By default, all the touchable elements are accessible.
- */
- accessible?: boolean;
-
- /**
- * This defines how far a touch event can start away from the view.
- * Typical interface guidelines recommend touch targets that are at least
- * 30 - 40 points/density-independent pixels. If a Touchable view has
- * a height of 20 the touchable height can be extended to 40 with
- * hitSlop={{top: 10, bottom: 10, left: 0, right: 0}}
- * NOTE The touch area never extends past the parent view bounds and
- * the Z-index of sibling views always takes precedence if a touch
- * hits two overlapping views.
- */
-
- hitSlop?: Insets
-
- /**
- * When `accessible` is true, the system will try to invoke this function when the user performs accessibility tap gesture.
- */
- onAcccessibilityTap?: () => void;
-
- /**
- * Invoked on mount and layout changes with
- *
- * {nativeEvent: { layout: {x, y, width, height}}}.
- */
- onLayout?: (event: LayoutChangeEvent) => void;
-
- /**
- * When accessible is true, the system will invoke this function when the user performs the magic tap gesture.
- */
- onMagicTap?: () => void;
-
- /**
- *
- * In the absence of auto property, none is much like CSS's none value. box-none is as if you had applied the CSS class:
- *
- * .box-none {
- * pointer-events: none;
- * }
- * .box-none * {
- * pointer-events: all;
- * }
- *
- * box-only is the equivalent of
- *
- * .box-only {
- * pointer-events: all;
- * }
- * .box-only * {
- * pointer-events: none;
- * }
- *
- * But since pointerEvents does not affect layout/appearance, and we are already deviating from the spec by adding additional modes,
- * we opt to not include pointerEvents on style. On some platforms, we would need to implement it as a className anyways. Using style or not is an implementation detail of the platform.
- */
- pointerEvents?: "box-none" | "none" | "box-only" | "auto"
-
- /**
- *
- * This is a special performance property exposed by RCTView and is useful for scrolling content when there are many subviews,
- * most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound.
- * The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).
- */
- removeClippedSubviews?: boolean
-
- style?: ViewStyle;
-
- /**
- * Used to locate this view in end-to-end tests.
- */
- testID?: string;
- }
-
- /**
- * The most fundamental component for building UI, View is a container that supports layout with flexbox, style, some touch handling,
- * and accessibility controls, and is designed to be nested inside other views and to have 0 to many children of any type.
- * View maps directly to the native view equivalent on whatever platform React is running on,
- * whether that is a UIView, , android.view, etc.
- */
- export interface ViewStatic extends NativeMethodsMixin, React.ClassicComponentClass
{
- AccessibilityTraits: [
- 'none',
- 'button',
- 'link',
- 'header',
- 'search',
- 'image',
- 'selected',
- 'plays',
- 'key',
- 'text',
- 'summary',
- 'disabled',
- 'frequentUpdates',
- 'startsMedia',
- 'adjustable',
- 'allowsDirectInteraction',
- 'pageTurn'
- ]
-
- AccessibilityComponentType: [
- 'none',
- 'button',
- 'radiobutton_checked',
- 'radiobutton_unchecked'
- ],
-
- /**
- * Is 3D Touch / Force Touch available (i.e. will touch events include `force`)
- * @platform ios
- */
- forceTouchAvailable: boolean,
- }
-
- /**
- * @see https://facebook.github.io/react-native/docs/viewpagerandroid.html#props
- */
-
-
- export interface ViewPagerAndroidOnPageScrollEventData {
- position: number;
- offset: number;
- }
-
- export interface ViewPagerAndroidOnPageSelectedEventData {
- position: number;
- }
-
- export interface ViewPagerAndroidProperties extends ViewProperties {
- /**
- * Index of initial page that should be selected. Use `setPage` method to
- * update the page, and `onPageSelected` to monitor page changes
- */
- initialPage?: number;
-
- /**
- * When false, the content does not scroll.
- * The default value is true.
- */
- scrollEnabled?: boolean;
-
- /**
- * Executed when transitioning between pages (ether because of animation for
- * the requested page change or when user is swiping/dragging between pages)
- * The `event.nativeEvent` object for this callback will carry following data:
- * - position - index of first page from the left that is currently visible
- * - offset - value from range [0,1) describing stage between page transitions.
- * Value x means that (1 - x) fraction of the page at "position" index is
- * visible, and x fraction of the next page is visible.
- */
- onPageScroll?: (event: NativeSyntheticEvent) => void;
-
- /**
- * This callback will be called once ViewPager finish navigating to selected page
- * (when user swipes between pages). The `event.nativeEvent` object passed to this
- * callback will have following fields:
- * - position - index of page that has been selected
- */
- onPageSelected?: (event: NativeSyntheticEvent) => void;
-
- /**
- * Function called when the page scrolling state has changed.
- * The page scrolling state can be in 3 states:
- * - idle, meaning there is no interaction with the page scroller happening at the time
- * - dragging, meaning there is currently an interaction with the page scroller
- * - settling, meaning that there was an interaction with the page scroller, and the
- * page scroller is now finishing it's closing or opening animation
- */
- onPageScrollStateChanged?: (state: "Idle" | "Dragging" | "Settling") => void
-
- /**
- * Determines whether the keyboard gets dismissed in response to a drag.
- * - 'none' (the default), drags do not dismiss the keyboard.
- * - 'on-drag', the keyboard is dismissed when a drag begins.
- */
- keyboardDismissMode?: "none" | "on-drag"
-
- /**
- * Blank space to show between pages. This is only visible while scrolling, pages are still
- * edge-to-edge.
- */
- pageMargin?: number
- }
-
- export interface ViewPagerAndroidStatic extends NativeMethodsMixin, React.ComponentClass {
- /**
- * A helper function to scroll to a specific page in the ViewPager.
- * The transition between pages will be animated.
- */
- setPage(selectedPage: number): void
-
- /**
- * A helper function to scroll to a specific page in the ViewPager.
- * The transition between pages will *not* be animated.
- */
- setPageWithoutAnimation(selectedPage: number): void
- }
-
- /**
- * It is a component to solve the common problem of views that need to move out of the way of the virtual keyboard.
- * It can automatically adjust either its position or bottom padding based on the position of the keyboard.
- */
- export interface KeyboardAvoidingViewStatic extends TimerMixin, React.ClassicComponentClass {
-
- }
-
- export interface KeyboardAvoidingViewProps extends ViewProperties, React.Props {
-
- behavior?: 'height' | 'position' | 'padding'
-
- /**
- * The style of the content container(View) when behavior is 'position'.
- */
- contentContainerStyle?: ViewStyle
-
- /**
- * This is the distance between the top of the user screen and the react native view,
- * may be non-zero in some use cases.
- */
- keyboardVerticalOffset?: number
-
- ref?: Ref
- }
-
- /**
- * //FIXME: No documentation extracted from code comment on WebView.ios.js
- */
- export interface NavState {
-
- url?: string
- title?: string
- loading?: boolean
- canGoBack?: boolean
- canGoForward?: boolean;
-
- [key: string]: any
- }
-
- /**
- * Passed data from WebView via window.postMessage.
- */
- export interface WebViewMessageEventData {
- /**
- * The data sent from a WebView; can only be a string.
- */
- data: string
- }
-
- export interface WebViewPropertiesAndroid {
-
- /**
- * Used for android only, JS is enabled by default for WebView on iOS
- */
- javaScriptEnabled?: boolean
-
- /**
- * Used on Android only, controls whether DOM Storage is enabled
- * or not android
- */
- domStorageEnabled?: boolean,
-
- /**
- * Sets the user-agent for the WebView.
- */
- userAgent?: string
- }
-
- export interface WebViewIOSLoadRequestEvent {
- target: number
- canGoBack: boolean
- lockIdentifier: number
- loading: boolean
- title: string
- canGoForward: boolean
- navigationType: 'other' | 'click'
- url: string
- }
-
- export interface WebViewPropertiesIOS {
-
- /**
- * Determines whether HTML5 videos play inline or use the native
- * full-screen controller. default value false
- * NOTE : "In order * for video to play inline, not only does
- * this property need to be set to true, but the video element
- * in the HTML document must also include the webkit-playsinline
- * attribute."
- */
- allowsInlineMediaPlayback?: boolean
-
- /**
- * Boolean value that determines whether the web view bounces
- * when it reaches the edge of the content. The default value is `true`.
- * @platform ios
- */
- bounces?: boolean
-
- /**
- * A floating-point number that determines how quickly the scroll
- * view decelerates after the user lifts their finger. You may also
- * use string shortcuts "normal" and "fast" which match the
- * underlying iOS settings for UIScrollViewDecelerationRateNormal
- * and UIScrollViewDecelerationRateFast respectively.
- * - normal: 0.998 - fast: 0.99 (the default for iOS WebView)
- */
- decelerationRate?: "normal" | "fast" | number
-
- /**
- * Allows custom handling of any webview requests by a JS handler.
- * Return true or false from this method to continue loading the
- * request.
- */
- onShouldStartLoadWithRequest?: (event: WebViewIOSLoadRequestEvent) => boolean
-
- /**
- * Boolean value that determines whether scrolling is enabled in the
- * `WebView`. The default value is `true`.
- */
- scrollEnabled?: boolean
- }
-
- export interface WebViewUriSource {
-
- /*
- * The URI to load in the WebView. Can be a local or remote file.
- */
- uri?: string;
-
- /*
- * The HTTP Method to use. Defaults to GET if not specified.
- * NOTE: On Android, only GET and POST are supported.
- */
- method?: string;
-
- /*
- * Additional HTTP headers to send with the request.
- * NOTE: On Android, this can only be used with GET requests.
- */
- headers?: any;
-
- /*
- * The HTTP body to send with the request. This must be a valid
- * UTF-8 string, and will be sent exactly as specified, with no
- * additional encoding (e.g. URL-escaping or base64) applied.
- * NOTE: On Android, this can only be used with POST requests.
- */
- body?: string;
- }
-
- export interface WebViewHtmlSource {
-
- /*
- * A static HTML page to display in the WebView.
- */
- html: string;
-
- /*
- * The base URL to be used for any relative links in the HTML.
- */
- baseUrl?: string;
- }
-
- /**
- * @see https://facebook.github.io/react-native/docs/webview.html#props
- */
- export interface WebViewProperties extends ViewProperties, WebViewPropertiesAndroid, WebViewPropertiesIOS, React.Props {
-
- /**
- * Controls whether to adjust the content inset for web views that are
- * placed behind a navigation bar, tab bar, or toolbar. The default value
- * is `true`.
- */
- automaticallyAdjustContentInsets?: boolean
-
- /**
- * The amount by which the web view content is inset from the edges of
- * the scroll view. Defaults to {top: 0, left: 0, bottom: 0, right: 0}.
- */
- contentInset?: Insets
-
- /**
- * @deprecated
- */
- html?: string
-
- /**
- * Set this to provide JavaScript that will be injected into the web page
- * when the view loads.
- */
- injectedJavaScript?: string
-
- /**
- * Invoked when load fails
- */
- onError?: (event: NavState) => void
-
- /**
- * Invoked when load finish
- */
- onLoad?: (event: NavState) => void
-
- /**
- * Invoked when load either succeeds or fails
- */
- onLoadEnd?: (event: NavState) => void
-
- /**
- * Invoked on load start
- */
- onLoadStart?: (event: NavState) => void
-
- /**
- * Invoked when window.postMessage is called from WebView.
- */
- onMessage?: ( event: NativeSyntheticEvent ) => void
-
- /**
- * Function that is invoked when the `WebView` loading starts or ends.
- */
- onNavigationStateChange?: ( event: NavState ) => void
-
- /**
- * Function that returns a view to show if there's an error.
- */
- renderError?: () => React.ReactElement
-
- /**
- * Function that returns a loading indicator.
- */
- renderLoading?: () => React.ReactElement
-
- /**
- * Boolean value that forces the `WebView` to show the loading view
- * on the first load.
- */
- startInLoadingState?: boolean
-
- style?: ViewStyle
-
- // Deprecated: Use the `source` prop instead.
- url?: string
-
- source?: WebViewUriSource | WebViewHtmlSource | number
-
- /**
- * Determines whether HTML5 audio & videos require the user to tap
- * before they can start playing. The default value is false.
- */
- mediaPlaybackRequiresUserAction?: boolean
-
- /**
- * sets whether the webpage scales to fit the view and the user can change the scale
- */
- scalesPageToFit?: boolean
-
- ref?: Ref
- }
-
-
- export interface WebViewStatic extends React.ClassicComponentClass {
-
- /**
- * Go back one page in the webview's history.
- */
- goBack: () => void
-
- /**
- * Go forward one page in the webview's history.
- */
- goForward: () => void
-
- /**
- * Post a message to the WebView in the form of a string.
- */
- postMessage: (message: string) => void
-
- /**
- * Reloads the current page.
- */
- reload: () => void
-
- /**
- * Stop loading the current page.
- */
- stopLoading(): void
-
- /**
- * Returns the native webview node.
- */
- getWebViewHandle: () => any
- }
-
-
- /**
- * @see https://facebook.github.io/react-native/docs/segmentedcontrolios.html
- * @see SegmentedControlIOS.ios.js
- */
- export interface NativeSegmentedControlIOSChangeEvent {
- value: string
- selectedSegmentIndex: number
- target: number
- }
-
- export interface SegmentedControlIOSProperties extends ViewProperties, React.Props {
-
- /**
- * If false the user won't be able to interact with the control. Default value is true.
- */
- enabled?: boolean
-
- /**
- * If true, then selecting a segment won't persist visually.
- * The onValueChange callback will still work as expected.
- */
- momentary?: boolean
-
- /**
- * Callback that is called when the user taps a segment;
- * passes the event as an argument
- * @param event
- */
- onChange?: (event: NativeSyntheticEvent) => void
-
- /**
- * Callback that is called when the user taps a segment; passes the segment's value as an argument
- * @param value
- */
- onValueChange?: (value: string) => void
-
- /**
- * The index in props.values of the segment to be (pre)selected.
- */
- selectedIndex?: number
-
- /**
- * Accent color of the control.
- */
- tintColor?: string
-
- /**
- * The labels for the control's segment buttons, in order.
- */
- values?: string[]
-
- ref?: Ref
- }
-
- /**
- * Use `SegmentedControlIOS` to render a UISegmentedControl iOS.
- *
- * #### Programmatically changing selected index
- *
- * The selected index can be changed on the fly by assigning the
- * selectIndex prop to a state variable, then changing that variable.
- * Note that the state variable would need to be updated as the user
- * selects a value and changes the index, as shown in the example below.
- *
- * ````
- * {
- * this.setState({selectedIndex: event.nativeEvent.selectedSegmentIndex});
- * }}
- * />
- * ````
- */
- export interface SegmentedControlIOSStatic extends NativeMethodsMixin, React.ClassicComponentClass {
-
- }
-
-
- export interface NavigatorIOSProperties extends React.Props {
- /**
- * The default background color of the navigation bar.
- */
- barTintColor?: string
-
- /**
- * 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
- */
- initialRoute: Route
-
- /**
- * The default wrapper style for components in the navigator.
- * A common use case is to set the backgroundColor for every page
- */
- itemWrapperStyle?: ViewStyle
-
- /**
- * Boolean value that indicates whether the interactive pop gesture is
- * enabled. This is useful for enabling/disabling the back swipe navigation
- * gesture.
- *
- * If this prop is not provided, the default behavior is for the back swipe
- * gesture to be enabled when the navigation bar is shown and disabled when
- * the navigation bar is hidden. Once you've provided the
- * `interactivePopGestureEnabled` prop, you can never restore the default
- * behavior.
- */
- interactivePopGestureEnabled?: boolean
-
- /**
- * A Boolean value that indicates whether the navigation bar is hidden
- */
- navigationBarHidden?: boolean
-
- /**
- * A Boolean value that indicates whether to hide the 1px hairline shadow
- */
- shadowHidden?: boolean
-
- /**
- * The color used for buttons in the navigation bar
- */
- tintColor?: string
-
- /**
- * The text color of the navigation bar title
- */
- titleTextColor?: string
-
- /**
- * A Boolean value that indicates whether the navigation bar is translucent
- */
- translucent?: boolean
-
- /**
- * NOT IN THE DOC BUT IN THE EXAMPLES
- */
- style?: ViewStyle
- }
-
- /**
- * A navigator is an object of navigation functions that a view can call.
- * It is passed as a prop to any component rendered by NavigatorIOS.
- *
- * Navigator functions are also available on the NavigatorIOS component:
- *
- * @see https://facebook.github.io/react-native/docs/navigatorios.html#navigator
- */
- export interface NavigationIOS {
- /**
- * Navigate forward to a new route
- */
- push: (route: Route) => void
-
- /**
- * Go back one page
- */
- pop: () => void
-
- /**
- * Go back N pages at once. When N=1, behavior matches pop()
- */
- popN: (n: number) => void
-
- /**
- * Replace the route for the current page and immediately load the view for the new route
- */
- replace: (route: Route) => void
-
- /**
- * Replace the route/view for the previous page
- */
- replacePrevious: (route: Route) => void
-
- /**
- * Replaces the previous route/view and transitions back to it
- */
- replacePreviousAndPop: (route: Route) => void
-
- /**
- * Replaces the top item and popToTop
- */
- resetTo: (route: Route) => void
-
- /**
- * Go back to the item for a particular route object
- */
- popToRoute(route: Route): void
-
- /**
- * Go back to the top item
- */
- popToTop(): void
- }
-
- export interface NavigatorIOSStatic extends NavigationIOS, React.ComponentClass {
- }
-
-
- /**
- * @see https://facebook.github.io/react-native/docs/activityindicator.html#props
- */
- export interface ActivityIndicatorProperties extends ViewProperties, React.Props {
-
- /**
- * Whether to show the indicator (true, the default) or hide it (false).
- */
- animating?: boolean
-
- /**
- * The foreground color of the spinner (default is gray).
- */
- color?: string
-
- /**
- * Whether the indicator should hide when not animating (true by default).
- */
- hidesWhenStopped?: boolean
-
- /**
- * Size of the indicator.
- * Small has a height of 20, large has a height of 36.
- *
- * enum('small', 'large')
- */
- size?: number | 'small' | 'large'
-
- style?: ViewStyle
-
- ref?: Ref
- }
-
- export interface ActivityIndicatorStatic extends React.NativeMethodsMixin, React.ClassicComponentClass {
- }
-
-
- /**
- * @see https://facebook.github.io/react-native/docs/activityindicatorios.html#props
- */
- export interface ActivityIndicatorIOSProperties extends ViewProperties, React.Props {
-
- /**
- * Whether to show the indicator (true, the default) or hide it (false).
- */
- animating?: boolean
-
- /**
- * The foreground color of the spinner (default is gray).
- */
- color?: string
-
- /**
- * Whether the indicator should hide when not animating (true by default).
- */
- hidesWhenStopped?: boolean
-
- /**
- * Invoked on mount and layout changes with
- */
- onLayout?: (event: { nativeEvent: { layout: { x: number, y: number, width: number, height: number } } }) => void
-
- /**
- * Size of the indicator.
- * Small has a height of 20, large has a height of 36.
- *
- * enum('small', 'large')
- */
- size?: 'small' | 'large'
-
- style?: ViewStyle
-
- ref?: Ref
- }
-
- /**
- * @Deprecated since version 0.28.0
- */
- export interface ActivityIndicatorIOSStatic extends React.ComponentClass {
- }
-
-
- export interface DatePickerIOSProperties extends ViewProperties, React.Props {
-
- /**
- * The currently selected date.
- */
- date: Date
-
-
- /**
- * Maximum date.
- * Restricts the range of possible date/time values.
- */
- maximumDate?: Date
-
- /**
- * Maximum date.
- * Restricts the range of possible date/time values.
- */
- minimumDate?: Date
-
- /**
- * enum(1, 2, 3, 4, 5, 6, 10, 12, 15, 20, 30)
- * The interval at which minutes can be selected.
- */
- minuteInterval?: number
-
- /**
- * enum('date', 'time', 'datetime')
- * The date picker mode.
- */
- mode?: "date" | "time" | "datetime"
-
- /**
- * 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.
- */
- onDateChange: ( newDate: Date ) => void
-
- /**
- * Timezone offset in minutes.
- * 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.
- */
- timeZoneOffsetInMinutes?: number
-
- ref?: Ref
- }
-
- export interface DatePickerIOSStatic extends React.NativeMethodsMixin, React.ComponentClass {
- }
-
- export interface DrawerSlideEvent extends NativeSyntheticEvent {
- }
-
- /**
- * @see DrawerLayoutAndroid.android.js
- */
- export interface DrawerLayoutAndroidProperties extends ViewProperties, React.Props {
-
- /**
- * Specifies the background color of the drawer. The default value
- * is white. If you want to set the opacity of the drawer, use rgba.
- * Example:
- * return (
- *
- *
- *);
- */
- drawerBackgroundColor?: string;
-
- /**
- * Specifies the lock mode of the drawer. The drawer can be locked
- * in 3 states:
- *
- * - unlocked (default), meaning that the drawer will respond
- * (open/close) to touch gestures.
- *
- * - locked-closed, meaning that the drawer will stay closed and not
- * respond to gestures.
- *
- * - locked-open, meaning that the drawer will stay opened and
- * not respond to gestures. The drawer may still be opened and
- * closed programmatically (openDrawer/closeDrawer).
- */
- drawerLockMode?: "unlocked" | "locked-closed" | "locked-open";
-
- /**
- * Specifies the side of the screen from which the drawer will slide in.
- * enum(DrawerLayoutAndroid.positions.Left, DrawerLayoutAndroid.positions.Right)
- */
- drawerPosition?: number;
-
- /**
- * Specifies the width of the drawer, more precisely the width of the
- * view that be pulled in from the edge of the window.
- */
- drawerWidth?: number;
-
- /**
- * Determines whether the keyboard gets dismissed in response to a drag.
- * - 'none' (the default), drags do not dismiss the keyboard.
- * - 'on-drag', the keyboard is dismissed when a drag begins.
- */
- keyboardDismissMode?: "none" | "on-drag"
-
- /**
- * Function called whenever the navigation view has been closed.
- */
- onDrawerClose?: () => void
-
- /**
- * Function called whenever the navigation view has been opened.
- */
- onDrawerOpen?: () => void
-
- /**
- * Function called whenever there is an interaction with the navigation view.
- * @param event
- */
- onDrawerSlide?: (event: DrawerSlideEvent) => void
-
- /**
- * Function called when the drawer state has changed.
- * The drawer can be in 3 states:
- * - idle, meaning there is no interaction with the navigation
- * view happening at the time
- * - dragging, meaning there is currently an interaction with the
- * navigation view
- * - settling, meaning that there was an interaction with the
- * navigation view, and the navigation view is now finishing
- * it's closing or opening animation
- * @param event
- */
- onDrawerStateChanged?: (event: "Idle" | "Dragging" | "Settling") => void
-
- /**
- * The navigation view that will be rendered to the side of the
- * screen and can be pulled in.
- */
- renderNavigationView: () => JSX.Element
-
- /**
- * Make the drawer take the entire screen and draw the background of
- * the status bar to allow it to open over the status bar. It will
- * only have an effect on API 21+.
- */
- statusBarBackgroundColor?: string
-
- ref?: Ref
- }
-
- interface DrawerPosition {
- Left: number
- Right: number
- }
-
- export interface DrawerLayoutAndroidStatic extends NativeMethodsMixin, React.ClassicComponentClass {
-
- /**
- * drawer's positions.
- */
- positions: DrawerPosition
-
- /**
- * Opens the drawer.
- */
- openDrawer(): void
-
- /**
- * Closes the drawer.
- */
- closeDrawer(): void
- }
-
-
- /**
- * @see PickerIOS.ios.js
- */
- export interface PickerIOSItemProperties extends React.Props {
- value?: string | number
- label?: string
- }
-
- /**
- * @see PickerIOS.ios.js
- */
- export interface PickerIOSItemStatic extends React.ComponentClass {
- }
-
- /**
- * @see Picker.js
- */
- export interface PickerItemProperties extends React.Props {
- label: string
- value?: any
- }
-
- export interface PickerItemStatic extends React.ComponentClass {
- }
-
- export interface PickerPropertiesIOS extends ViewProperties, React.Props {
-
- /**
- * Style to apply to each of the item labels.
- * @platform ios
- */
- itemStyle?: ViewStyle,
-
- ref?: Ref
- }
-
- export interface PickerPropertiesAndroid extends ViewProperties, React.Props {
-
- /**
- * If set to false, the picker will be disabled, i.e. the user will not be able to make a
- * selection.
- * @platform android
- */
- enabled?: boolean
-
- /**
- * On Android, specifies how to display the selection items when the user taps on the picker:
- *
- * - 'dialog': Show a modal dialog. This is the default.
- * - 'dropdown': Shows a dropdown anchored to the picker view
- *
- * @platform android
- */
- mode?: "dialog" | "dropdown"
-
- /**
- * Prompt string for this picker, used on Android in dialog mode as the title of the dialog.
- * @platform android
- */
- prompt?: string
-
- ref?: Ref
- }
-
- /**
- * @see https://facebook.github.io/react-native/docs/picker.html
- * @see Picker.js
- */
- export interface PickerProperties extends PickerPropertiesIOS, PickerPropertiesAndroid, React.Props {
-
- /**
- * Callback for when an item is selected. This is called with the
- * following parameters:
- * - itemValue: the value prop of the item that was selected
- * - itemPosition: the index of the selected item in this picker
- * @param itemValue
- * @param itemPosition
- */
- onValueChange?: (itemValue: any, itemPosition: number) => void
-
- /**
- * Value matching value of one of the items.
- * Can be a string or an integer.
- */
- selectedValue?: any
-
- style?: ViewStyle
-
- /**
- * Used to locate this view in end-to-end tests.
- */
- testId?: string
-
- ref?: Ref
- }
-
- /**
- * @see https://facebook.github.io/react-native/docs/picker.html
- * @see Picker.js
- */
- export interface PickerStatic extends React.ComponentClass {
-
- /**
- * On Android, display the options in a dialog.
- */
- MODE_DIALOG: string
- /**
- * On Android, display the options in a dropdown (this is the default).
- */
- MODE_DROPDOWN: string
-
- Item?: PickerItemStatic
- }
-
- /**
- * @see https://facebook.github.io/react-native/docs/pickerios.html
- * @see PickerIOS.ios.js
- */
- export interface PickerIOSProperties extends ViewProperties, React.Props {
-
- itemStyle?: TextStyle
- onValueChange?: ( value: string | number ) => void
- selectedValue?: string | number
-
- ref?: Ref
- }
-
- /**
- * @see https://facebook.github.io/react-native/docs/pickerios.html
- * @see PickerIOS.ios.js
- */
- export interface PickerIOSStatic extends NativeMethodsMixin, React.ClassicComponentClass {
-
- Item: PickerIOSItemStatic
- }
-
- /**
- * @see https://facebook.github.io/react-native/docs/progressbarandroid.html
- * @see ProgressBarAndroid.android.js
- */
- export interface ProgressBarAndroidProperties extends ViewProperties, React.Props {
-
- /**
- * Style of the ProgressBar. One of:
- Horizontal
- Normal (default)
- Small
- Large
- Inverse
- SmallInverse
- LargeInverse
- */
- styleAttr?: "Horizontal" | "Normal" | "Small" | "Large" | "Inverse" | "SmallInverse" | "LargeInverse"
-
- /**
- * If the progress bar will show indeterminate progress.
- * Note that this can only be false if styleAttr is Horizontal.
- */
- indeterminate?: boolean
-
- /**
- * The progress value (between 0 and 1).
- */
- progress?: number
-
- /**
- * Color of the progress bar.
- */
- color?: string
-
- /**
- * Used to locate this view in end-to-end tests.
- */
- testID?: string
-
- ref?: Ref
- }
- /**
- * React component that wraps the Android-only `ProgressBar`. This component is used to indicate
- * that the app is loading or there is some activity in the app.
- */
- export interface ProgressBarAndroidStatic extends NativeMethodsMixin, React.ClassicComponentClass {
- }
-
- /**
- * @see https://facebook.github.io/react-native/docs/progressviewios.html
- * @see ProgressViewIOS.ios.js
- */
- export interface ProgressViewIOSProperties extends ViewProperties, React.Props {
-
- /**
- * The progress bar style.
- */
- progressViewStyle?: "default" | "bar"
-
- /**
- * The progress value (between 0 and 1).
- */
- progress?: number
-
- /**
- * The tint color of the progress bar itself.
- */
- progressTintColor?: string
-
- /**
- * The tint color of the progress bar track.
- */
- trackTintColor?: string
-
- /**
- * A stretchable image to display as the progress bar.
- */
- progressImage?: ImageURISource | ImageURISource[]
-
- /**
- * A stretchable image to display behind the progress bar.
- */
- trackImage?: ImageURISource | ImageURISource[]
-
- ref?: Ref
- }
- export interface ProgressViewIOSStatic extends NativeMethodsMixin, React.ClassicComponentClass {
- }
-
- export interface RefreshControlPropertiesIOS extends ViewProperties, React.Props {
-
- /**
- * The color of the refresh indicator.
- */
- tintColor?: string
-
- /**
- * The title displayed under the refresh indicator.
- */
- title?: string
-
- /**
- * Title color.
- */
- titleColor?: string
-
- ref?: Ref
- }
-
- export interface RefreshControlPropertiesAndroid extends ViewProperties, React.Props {
-
- /**
- * The colors (at least one) that will be used to draw the refresh indicator.
- */
- colors?: string[]
-
- /**
- * Whether the pull to refresh functionality is enabled.
- */
- enabled?: boolean
-
- /**
- * The background color of the refresh indicator.
- */
- progressBackgroundColor?: string
-
- /**
- * Size of the refresh indicator, see RefreshControl.SIZE.
- */
- size?: number
-
- /**
- * Progress view top offset
- * @platform android
- */
- progressViewOffset?: number
-
- ref?: Ref
- }
-
- export interface RefreshControlProperties extends RefreshControlPropertiesIOS, RefreshControlPropertiesAndroid, React.Props {
-
- /**
- * Called when the view starts refreshing.
- */
- onRefresh?: () => void
-
- /**
- * Whether the view should be indicating an active refresh.
- */
- refreshing: boolean
-
- ref?: Ref
- }
-
- /**
- * This component is used inside a ScrollView or ListView to add pull to refresh
- * functionality. When the ScrollView is at `scrollY: 0`, swiping down
- * triggers an `onRefresh` event.
- *
- * __Note:__ `refreshing` is a controlled prop, this is why it needs to be set to true
- * in the `onRefresh` function otherwise the refresh indicator will stop immediately.
- */
- export interface RefreshControlStatic extends NativeMethodsMixin, React.ClassicComponentClass {
- SIZE: Object // Undocumented
- }
-
- export interface RecyclerViewBackedScrollViewProperties extends ScrollViewProperties, React.Props {
- ref?: Ref
- }
-
- /**
- * Wrapper around android native recycler view.
- *
- * It simply renders rows passed as children in a separate recycler view cells
- * similarly to how `ScrollView` is doing it. Thanks to the fact that it uses
- * native `RecyclerView` though, rows that are out of sight are going to be
- * automatically detached (similarly on how this would work with
- * `removeClippedSubviews = true` on a `ScrollView.js`).
- *
- * CAUTION: This is an experimental component and should only be used together
- * with javascript implementation of list view (see ListView.js). In order to
- * use it pass this component as `renderScrollComponent` to the list view. For
- * now only horizontal scrolling is supported.
- */
- export interface RecyclerViewBackedScrollViewStatic extends ScrollResponderMixin, React.ClassicComponentClass {
-
- /**
- * A helper function to scroll to a specific point in the scrollview.
- * This is currently used to help focus on child textviews, but can also
- * be used to quickly scroll to any element we want to focus. Syntax:
- *
- * scrollResponderScrollTo(options: {x: number = 0; y: number = 0; animated: boolean = true})
- *
- * Note: The weird argument signature is due to the fact that, for historical reasons,
- * the function also accepts separate arguments as as alternative to the options object.
- * This is deprecated due to ambiguity (y before x), and SHOULD NOT BE USED.
- */
- scrollTo(
- y?: number | { x?: number, y?: number, animated?: boolean },
- x?: number,
- animated?: boolean
- ): void;
-
- /**
- * Returns a reference to the underlying scroll responder, which supports
- * operations like `scrollTo`. All ScrollView-like components should
- * implement this method so that they can be composed while providing access
- * to the underlying scroll responder's methods.
- */
- getScrollResponder(): JSX.Element;
- }
-
- export interface SliderPropertiesIOS extends ViewProperties, React.Props {
-
- /**
- * Assigns a maximum track image. Only static images are supported.
- * The leftmost pixel of the image will be stretched to fill the track.
- */
- maximumTrackImage?: ImageURISource
-
- /**
- * The color used for the track to the right of the button.
- * Overrides the default blue gradient image.
- */
- maximumTrackTintColor?: string
-
- /**
- * Assigns a minimum track image. Only static images are supported.
- * The rightmost pixel of the image will be stretched to fill the track.
- */
- minimumTrackImage?: ImageURISource
-
- /**
- * The color used for the track to the left of the button.
- * Overrides the default blue gradient image.
- */
- minimumTrackTintColor?: string
-
- /**
- * Sets an image for the thumb. Only static images are supported.
- */
- thumbImage?: ImageURISource
-
- /**
- * Assigns a single image for the track. Only static images
- * are supported. The center pixel of the image will be stretched
- * to fill the track.
- */
- trackImage?: ImageURISource
-
- ref?: Ref
- }
-
- export interface SliderProperties extends SliderPropertiesIOS, React.Props {
-
- /**
- * If true the user won't be able to move the slider.
- * Default value is false.
- */
- disabled?: boolean
-
- /**
- * Initial maximum value of the slider. Default value is 1.
- */
- maximumValue?: number
-
- /**
- * Initial minimum value of the slider. Default value is 0.
- */
- minimumValue?: number
-
- /**
- * Callback called when the user finishes changing the value (e.g. when the slider is released).
- * @param value
- */
- onSlidingComplete?: (value: number) => void
-
- /**
- * Callback continuously called while the user is dragging the slider.
- * @param value
- */
- onValueChange?: (value: number) => void
-
- /**
- * Step value of the slider. The value should be between 0 and (maximumValue - minimumValue). Default value is 0.
- */
- step?: number
-
- /**
- * Used to style and layout the Slider. See StyleSheet.js and ViewStylePropTypes.js for more info.
- */
- style?: ViewStyle
-
- /**
- * Used to locate this view in UI automation tests.
- */
- testID?: string
-
- /**
- * Initial value of the slider. The value should be between minimumValue
- * and maximumValue, which default to 0 and 1 respectively.
- * Default value is 0.
- * This is not a controlled component, you don't need to update
- * the value during dragging.
- */
- value?: number
- }
-
- /**
- * A component used to select a single value from a range of values.
- */
- export interface SliderStatic extends NativeMethodsMixin, React.ClassicComponentClass {
-
- }
-
- /**
- * https://facebook.github.io/react-native/docs/switchios.html#props
- */
- export interface SwitchIOSProperties extends ViewProperties, React.Props {
-
- /**
- * If true the user won't be able to toggle the switch. Default value is false.
- */
- disabled?: boolean
-
- /**
- * Background color when the switch is turned on.
- */
- onTintColor?: string
-
- /**
- * Callback that is called when the user toggles the switch.
- */
- onValueChange?: (value: boolean) => void
-
- /**
- * Background color for the switch round button.
- */
- thumbTintColor?: string
-
- /**
- * Background color when the switch is turned off.
- */
- tintColor?: string
-
- /**
- * The value of the switch, if true the switch will be turned on. Default value is false.
- */
- value?: boolean
-
- ref?: Ref
- }
-
- /**
- *
- * Use SwitchIOS to render a boolean input on iOS.
- *
- * This is a controlled component, so you must hook in to the onValueChange callback and update the value prop in order for the component to update,
- * otherwise the user's change will be reverted immediately to reflect props.value as the source of truth.
- *
- * @see https://facebook.github.io/react-native/docs/switchios.html
- */
- export interface SwitchIOSStatic extends React.ComponentClass {
-
- }
-
- export type ImageResizeMode = "contain" | "cover" | "stretch" | "center" | "repeat"
-
- /**
- * @see ImageResizeMode.js
- */
- export interface ImageResizeModeStatic {
- /**
- * contain - The image will be resized such that it will be completely
- * visible, contained within the frame of the View.
- */
- contain: ImageResizeMode
- /**
- * cover - The image will be resized such that the entire area of the view
- * is covered by the image, potentially clipping parts of the image.
- */
- cover: ImageResizeMode
- /**
- * stretch - The image will be stretched to fill the entire frame of the
- * view without clipping. This may change the aspect ratio of the image,
- * distoring it. Only supported on iOS.
- */
- stretch: ImageResizeMode
- /**
- * center - The image will be scaled down such that it is completely visible,
- * if bigger than the area of the view.
- * The image will not be scaled up.
- */
- center: ImageResizeMode,
-
- /**
- * repeat - The image will be repeated to cover the frame of the View. The
- * image will keep it's size and aspect ratio.
- */
- repeat: ImageResizeMode,
- }
-
- export interface ShadowStyleIOS {
- shadowColor?: string
- shadowOffset?: {width: number, height: number}
- shadowOpacity?: number
- shadowRadius?: number
- }
-
- /**
- * Image style
- * @see https://facebook.github.io/react-native/docs/image.html#style
- */
- export interface ImageStyle extends FlexStyle, TransformsStyle, ShadowStyleIOS {
- resizeMode?: ImageResizeMode
- backfaceVisibility?: "visible" | "hidden"
- borderBottomLeftRadius?: number
- borderBottomRightRadius?: number
- backgroundColor?: string
- borderColor?: string
- borderWidth?: number
- borderRadius?: number
- borderTopLeftRadius?: number
- borderTopRightRadius?: number
- overflow?: "visible" | "hidden"
- overlayColor?: string
- tintColor?: string
- opacity?: number
- }
-
- export interface ImagePropertiesIOS {
- /**
- * The text that's read by the screen reader when the user interacts with the image.
- */
- accessibilityLabel?: string;
-
- /**
- * When true, indicates the image is an accessibility element.
- */
- accessible?: boolean;
-
- /**
- * blurRadius: the blur radius of the blur filter added to the image
- * @platform ios
- */
- blurRadius?: number,
-
- /**
- * 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 rounded buttons, shadows, and other resizable assets.
- * More info on Apple documentation
- */
- capInsets?: Insets
-
- /**
- * A static image to display while downloading the final image off the network.
- */
- defaultSource?: ImageURISource | number
-
- /**
- * Invoked on load error with {nativeEvent: {error}}
- */
- onError?: (error: { nativeEvent: any }) => void
-
- /**
- * Invoked on download progress with {nativeEvent: {loaded, total}}
- */
- onProgress?: () => void
-
- /**
- * Invoked when a partial load of the image is complete. The definition of
- * what constitutes a "partial load" is loader specific though this is meant
- * for progressive JPEG loads.
- * @platform ios
- */
- onPartialLoad?: () => void,
- }
-
- /*
- * @see https://github.com/facebook/react-native/blob/master/Libraries/Image/ImageSourcePropType.js
- */
- interface ImageURISource {
- /**
- * `uri` is a string representing the resource identifier for the image, which
- * could be an http address, a local file path, or the name of a static image
- * resource (which should be wrapped in the `require('./path/to/image.png')`
- * function).
- */
- uri?: string,
- /**
- * `bundle` is the iOS asset bundle which the image is included in. This
- * will default to [NSBundle mainBundle] if not set.
- * @platform ios
- */
- bundle?: string,
- /**
- * `method` is the HTTP Method to use. Defaults to GET if not specified.
- */
- method?: string,
- /**
- * `headers` is an object representing the HTTP headers to send along with the
- * request for a remote image.
- */
- headers?: {[key: string]: string},
- /**
- * `body` is the HTTP body to send with the request. This must be a valid
- * UTF-8 string, and will be sent exactly as specified, with no
- * additional encoding (e.g. URL-escaping or base64) applied.
- */
- body?: string,
- /**
- * `width` and `height` can be specified if known at build time, in which case
- * these will be used to set the default `` component dimensions.
- */
- width?: number,
- height?: number,
- /**
- * `scale` is used to indicate the scale factor of the image. Defaults to 1.0 if
- * unspecified, meaning that one image pixel equates to one display point / DIP.
- */
- scale?: number,
- }
-
- /**
- * @see https://facebook.github.io/react-native/docs/image.html
- */
- export interface ImageProperties extends ImagePropertiesIOS, React.Props {
- fadeDuration?: number
- /**
- * onLayout function
- *
- * Invoked on mount and layout changes with
- *
- * {nativeEvent: { layout: {x, y, width, height}}}.
- */
- onLayout?: (event: LayoutChangeEvent) => void;
-
- /**
- * Invoked when load completes successfully
- */
- onLoad?: () => void
-
- /**
- * Invoked when load either succeeds or fails
- */
- onLoadEnd?: () => void
-
- /**
- * Invoked on load start
- */
- onLoadStart?: () => void
-
- progressiveRenderingEnabled?: boolean
-
- /**
- * Determines how to resize the image when the frame doesn't match the raw
- * image dimensions.
- *
- * 'cover': Scale the image uniformly (maintain the image's aspect ratio)
- * so that both dimensions (width and height) of the image will be equal
- * to or larger than the corresponding dimension of the view (minus padding).
- *
- * 'contain': Scale the image uniformly (maintain the image's aspect ratio)
- * so that both dimensions (width and height) of the image will be equal to
- * or less than the corresponding dimension of the view (minus padding).
- *
- * 'stretch': Scale width and height independently, This may change the
- * aspect ratio of the src.
- *
- * 'center': Scale the image down so that it is completely visible,
- * if bigger than the area of the view.
- * The image will not be scaled up.
- */
- resizeMode?: 'cover' |'contain' |'stretch' |'center'
-
- /**
- * The mechanism that should be used to resize the image when the image's dimensions
- * differ from the image view's dimensions. Defaults to `auto`.
- *
- * - `auto`: Use heuristics to pick between `resize` and `scale`.
- *
- * - `resize`: A software operation which changes the encoded image in memory before it
- * gets decoded. This should be used instead of `scale` when the image is much larger
- * than the view.
- *
- * - `scale`: The image gets drawn downscaled or upscaled. Compared to `resize`, `scale` is
- * faster (usually hardware accelerated) and produces higher quality images. This
- * should be used if the image is smaller than the view. It should also be used if the
- * image is slightly bigger than the view.
- *
- * More details about `resize` and `scale` can be found at http://frescolib.org/docs/resizing-rotating.html.
- *
- * @platform android
- */
- resizeMethod?: 'auto' | 'resize' | 'scale'
-
- /**
- * `uri` is a string representing the resource identifier for the image, which
- * could be an http address, a local file path, or a static image
- * resource (which should be wrapped in the `require('./path/to/image.png')` function).
- * This prop can also contain several remote `uri`, specified together with
- * their width and height. The native side will then choose the best `uri` to display
- * based on the measured size of the image container.
- */
- source: ImageURISource | ImageURISource[]
-
- /**
- * similarly to `source`, this property represents the resource used to render
- * the loading indicator for the image, displayed until image is ready to be
- * displayed, typically after when it got downloaded from network.
- */
- loadingIndicatorSource?: ImageURISource;
-
- /**
- *
- * Style
- */
- style?: ImageStyle;
-
- /**
- * A unique identifier for this element to be used in UI Automation testing scripts.
- */
- testID?: string;
-
- }
-
- export interface ImageStatic extends React.NativeMethodsMixin, React.ComponentClass {
- resizeMode: ImageResizeMode
- getSize(uri: string, success: (width: number, height: number) => void, failure: (error: any) => void): any
- prefetch(url: string): any
- abortPrefetch?(requestId: number): void
- queryCache?(urls: string[]): Promise>
- }
-
- /**
- * @see https://facebook.github.io/react-native/docs/listview.html#props
- */
- export interface ListViewProperties extends ScrollViewProperties, React.Props {
-
- /**
- * An instance of [ListView.DataSource](docs/listviewdatasource.html) to use
- */
- dataSource: ListViewDataSource
-
- /**
- * Flag indicating whether empty section headers should be rendered.
- * In the future release empty section headers will be rendered by
- * default, and the flag will be deprecated. If empty sections are not
- * desired to be rendered their indices should be excluded from
- * sectionID object.
- */
- enableEmptySections?: boolean
-
- /**
- * How many rows to render on initial component mount. Use this to make
- * it so that the first screen worth of data apears at one time instead of
- * over the course of multiple frames.
- */
- initialListSize?: number
-
- /**
- * (visibleRows, changedRows) => void
- *
- * Called when the set of visible rows changes. `visibleRows` maps
- * { sectionID: { rowID: true }} for all the visible rows, and
- * `changedRows` maps { sectionID: { rowID: true | false }} for the rows
- * that have changed their visibility, with true indicating visible, and
- * false indicating the view has moved out of view.
- */
- onChangeVisibleRows?: (visibleRows: Array<{ [sectionId: string]: { [rowID: string]: boolean } }>, changedRows: Array<{ [sectionId: string]: { [rowID: string]: boolean } }>) => void
-
- /**
- * Called when all rows have been rendered and the list has been scrolled
- * to within onEndReachedThreshold of the bottom. The native scroll
- * event is provided.
- */
- onEndReached?: () => void
-
- /**
- * Threshold in pixels for onEndReached.
- */
- onEndReachedThreshold?: number
-
- /**
- * Number of rows to render per event loop.
- */
- pageSize?: number
-
- /**
- * A performance optimization for improving scroll perf of
- * large lists, used in conjunction with overflow: 'hidden' on the row
- * containers. Use at your own risk.
- */
- removeClippedSubviews?: boolean
-
- /**
- * () => renderable
- *
- * The header and footer are always rendered (if these props are provided)
- * on every render pass. If they are expensive to re-render, wrap them
- * in StaticContainer or other mechanism as appropriate. Footer is always
- * at the bottom of the list, and header at the top, on every render pass.
- */
- renderFooter?: () => React.ReactElement
-
- /**
- * () => renderable
- *
- * The header and footer are always rendered (if these props are provided)
- * on every render pass. If they are expensive to re-render, wrap them
- * in StaticContainer or other mechanism as appropriate. Footer is always
- * at the bottom of the list, and header at the top, on every render pass.
- */
- renderHeader?: () => React.ReactElement
-
- /**
- * (rowData, sectionID, rowID) => renderable
- * Takes a data entry from the data source and its ids and should return
- * a renderable component to be rendered as the row. By default the data
- * is exactly what was put into the data source, but it's also possible to
- * provide custom extractors.
- */
- renderRow: ( rowData: any, sectionID: string | number, rowID: string | number, highlightRow?: boolean ) => React.ReactElement
-
-
- /**
- * A function that returns the scrollable component in which the list rows are rendered.
- * Defaults to returning a ScrollView with the given props.
- */
- renderScrollComponent?: (props: ScrollViewProperties) => React.ReactElement
-
- /**
- * (sectionData, sectionID) => renderable
- *
- * If provided, a sticky header is rendered for this section. The sticky
- * behavior means that it will scroll with the content at the top of the
- * section until it reaches the top of the screen, at which point it will
- * stick to the top until it is pushed off the screen by the next section
- * header.
- */
- renderSectionHeader?: (sectionData: any, sectionId: string | number) => React.ReactElement
-
-
- /**
- * (sectionID, rowID, adjacentRowHighlighted) => renderable
- * If provided, a renderable component to be rendered as the separator below each row
- * but not the last row if there is a section header below.
- * Take a sectionID and rowID of the row above and whether its adjacent row is highlighted.
- */
- renderSeparator?: (sectionID: string | number, rowID: string | number, adjacentRowHighlighted?: boolean) => React.ReactElement
-
- /**
- * How early to start rendering rows before they come on screen, in
- * pixels.
- */
- scrollRenderAheadDistance?: number
-
- /**
- * An array of child indices determining which children get docked to the
- * top of the screen when scrolling. For example, passing
- * `stickyHeaderIndices={[0]}` will cause the first child to be fixed to the
- * top of the scroll view. This property is not supported in conjunction
- * with `horizontal={true}`.
- * @platform ios
- */
- stickyHeaderIndices?: number[]
-
- ref?: Ref
- }
-
-
- interface TimerMixin {
- setTimeout: typeof setTimeout,
- clearTimeout: typeof clearTimeout,
- setInterval: typeof setInterval,
- clearInterval: typeof clearInterval,
- setImmediate: typeof setImmediate,
- clearImmediate: typeof clearImmediate,
- requestAnimationFrame: typeof requestAnimationFrame,
- cancelAnimationFrame: typeof cancelAnimationFrame,
- }
-
- export interface ListViewStatic extends ScrollResponderMixin, TimerMixin, React.ComponentClass {
- DataSource: ListViewDataSource;
-
- /**
- * Exports some data, e.g. for perf investigations or analytics.
- */
- getMetrics: () => {
- contentLength: number,
- totalRows: number,
- renderedRows: number,
- visibleRows: number,
- }
-
- /**
- * Provides a handle to the underlying scroll responder.
- */
- getScrollResponder: () => any,
-
- /**
- * Scrolls to a given x, y offset, either immediately or with a smooth animation.
- *
- * See `ScrollView#scrollTo`.
- */
- scrollTo: ( y?: number | { x?: number, y?: number, animated?: boolean } , x?: number, animated?: boolean ) => void,
- }
-
-
- export interface MapViewAnnotation {
- latitude: number
- longitude: number
- animateDrop?: boolean
- draggable?: boolean
- onDragStateChange?: () => any,
- onFocus?: () => any,
- onBlur?: () => any,
- title?: string
- subtitle?: string
- leftCalloutView?: ReactElement
- rightCalloutView?: ReactElement
- detailCalloutView?: ReactElement
- tintColor?: string
- image?: ImageURISource
- view?: ReactElement
- hasLeftCallout?: boolean
- hasRightCallout?: boolean
- onLeftCalloutPress?: () => void
- onRightCalloutPress?: () => void
- id?: string
- }
-
- export interface MapViewRegion {
- latitude: number
- longitude: number
- latitudeDelta?: number
- longitudeDelta?: number
- }
-
- export interface MapViewOverlay {
- coordinates: ({ latitude: number, longitude: number })[]
- lineWidth?: number
- strokeColor?: string
- fillColor?: string
- id?: string
- }
-
- export interface MapViewProperties extends ViewProperties, React.Props {
-
- /**
- * If false points of interest won't be displayed on the map.
- * Default value is true.
- */
- showsPointsOfInterest?: boolean
-
- /**
- * Map annotations with title/subtitle.
- */
- annotations?: MapViewAnnotation[]
-
- /**
- * If true the map will follow the user's location whenever it changes.
- * Note that this has no effect unless showsUserLocation is enabled.
- * Default value is true.
- */
- followUserLocation?: boolean
-
- /**
- * Insets for the map's legal label, originally at bottom left of the map. See EdgeInsetsPropType.js for more information.
- */
- legalLabelInsets?: Insets
-
- /**
- * The map type to be displayed.
- * standard: standard road map (default)
- * satellite: satellite view
- * hybrid: satellite view with roads and points of interest overlayed
- *
- * enum('standard', 'satellite', 'hybrid')
- */
- mapType?: 'standard' |'satellite' |'hybrid'
-
- /**
- * Maximum size of area that can be displayed.
- */
- maxDelta?: number
-
- /**
- * Minimum size of area that can be displayed.
- */
- minDelta?: number
-
- /**
- * Map overlays
- */
- overlays?: MapViewOverlay[]
-
- /**
- * If false compass won't be displayed on the map.
- * Default value is true.
- */
- showsCompass?: boolean
-
- /**
- * Callback that is called once, when the user taps an annotation.
- */
- onAnnotationPress?: () => void
-
- /**
- * Callback that is called continuously when the user is dragging the map.
- */
- onRegionChange?: (region: MapViewRegion) => void
-
- /**
- * Callback that is called once, when the user is done moving the map.
- */
- onRegionChangeComplete?: (region: MapViewRegion) => void
-
- /**
- * 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 angle is ignored and
- * the map is always displayed as if the user is looking straight down onto it.
- */
- pitchEnabled?: boolean
-
- /**
- * The region to be displayed by the map.
- * The region is defined by the center coordinates and the span of coordinates to display.
- */
- region?: MapViewRegion
-
- /**
- * When this property is set to true and a valid camera is associated with the map,
- * the camera’s heading angle is used to rotate the plane of the map around its center point.
- *
- * When this property is set to false, the camera’s heading angle is ignored and the map is always oriented
- * so that true north is situated at the top of the map view
- */
- rotateEnabled?: boolean
-
- /**
- * If false the user won't be able to change the map region being displayed.
- * Default value is true.
- */
- scrollEnabled?: boolean
-
- /**
- * If true the app will ask for the user's location and focus on it.
- * Default value is false.
- *
- * NOTE: You need to add NSLocationWhenInUseUsageDescription key in Info.plist to enable geolocation,
- * otherwise it is going to fail silently!
- */
- showsUserLocation?: boolean
-
- /**
- * Used to style and layout the MapView.
- * See StyleSheet.js and ViewStylePropTypes.js for more info.
- */
- style?: ViewStyle
-
- /**
- * If false the user won't be able to pinch/zoom the map.
- * Default value is true.
- */
- zoomEnabled?: boolean
-
- ref?: Ref
- }
-
- /**
- * @see https://facebook.github.io/react-native/docs/mapview.html#content
- */
- export interface MapViewStatic extends React.NativeMethodsMixin, React.ComponentClass {
- PinColors: {
- RED: string,
- GREEN: string,
- PURPLE: string
- }
- }
-
- export interface ModalProperties extends React.Props {
-
- // Only `animated` is documented. The JS code says `animated` is
- // deprecated and `animationType` is preferred.
- animated?: boolean
- /**
- * The `animationType` prop controls how the modal animates.
- *
- * - `slide` slides in from the bottom
- * - `fade` fades into view
- * - `none` appears without an animation
- */
- animationType?: "none" | "slide" | "fade"
- /**
- * The `transparent` prop determines whether your modal will fill the entire view.
- * Setting this to `true` will render the modal over a transparent background.
- */
- transparent?: boolean
- /**
- * The `visible` prop determines whether your modal is visible.
- */
- visible?: boolean
- /**
- * The `onRequestClose` prop allows passing a function that will be called once the modal has been dismissed.
- * _On the Android platform, this is a required function._
- */
- onRequestClose?: () => void
- /**
- * The `onShow` prop allows passing a function that will be called once the modal has been shown.
- */
- onShow?: (event: NativeSyntheticEvent) => void
- /**
- * The `supportedOrientations` prop allows the modal to be rotated to any of the specified orientations.
- * On iOS, the modal is still restricted by what's specified in your app's Info.plist's UISupportedInterfaceOrientations field.
- * @platform ios
- */
- supportedOrientations?: ('portrait' | 'portrait-upside-down' | 'landscape' | 'landscape-left' | 'landscape-right')[]
- /**
- * The `onOrientationChange` callback is called when the orientation changes while the modal is being displayed.
- * The orientation provided is only 'portrait' or 'landscape'. This callback is also called on initial render, regardless of the current orientation.
- * @platform ios
- */
- onOrientationChange?: () => void
- }
-
- export interface ModalStatic extends React.ComponentClass {
-
- }
-
- /**
- * @see https://github.com/facebook/react-native/blob/0.34-stable\Libraries\Components\Touchable\Touchable.js
- */
- interface TouchableMixin {
-
- /**
- * Invoked when the item should be highlighted. Mixers should implement this
- * to visually distinguish the `VisualRect` so that the user knows that
- * releasing a touch will result in a "selection" (analog to click).
- */
- touchableHandleActivePressIn(e: Event): void
-
- /**
- * Invoked when the item is "active" (in that it is still eligible to become
- * a "select") but the touch has left the `PressRect`. Usually the mixer will
- * want to unhighlight the `VisualRect`. If the user (while pressing) moves
- * back into the `PressRect` `touchableHandleActivePressIn` will be invoked
- * again and the mixer should probably highlight the `VisualRect` again. This
- * event will not fire on an `touchEnd/mouseUp` event, only move events while
- * the user is depressing the mouse/touch.
- */
- touchableHandleActivePressOut(e: Event): void
-
- /**
- * Invoked when the item is "selected" - meaning the interaction ended by
- * letting up while the item was either in the state
- * `RESPONDER_ACTIVE_PRESS_IN` or `RESPONDER_INACTIVE_PRESS_IN`.
- */
- touchableHandlePress(e: Event): void
-
- /**
- * Invoked when the item is long pressed - meaning the interaction ended by
- * letting up while the item was in `RESPONDER_ACTIVE_LONG_PRESS_IN`. If
- * `touchableHandleLongPress` is *not* provided, `touchableHandlePress` will
- * be called as it normally is. If `touchableHandleLongPress` is provided, by
- * default any `touchableHandlePress` callback will not be invoked. To
- * override this default behavior, override `touchableLongPressCancelsPress`
- * to return false. As a result, `touchableHandlePress` will be called when
- * lifting up, even if `touchableHandleLongPress` has also been called.
- */
- touchableHandleLongPress(e: Event): void
-
- /**
- * Returns the amount to extend the `HitRect` into the `PressRect`. Positive
- * numbers mean the size expands outwards.
- */
- touchableGetPressRectOffset(): Insets
-
- /**
- * Returns the number of millis to wait before triggering a highlight.
- */
- touchableGetHighlightDelayMS(): number
-
- // These methods are undocumented but still being used by TouchableMixin internals
- touchableGetLongPressDelayMS(): number
- touchableGetPressOutDelayMS(): number
- touchableGetHitSlop(): Insets
- }
-
- export interface TouchableWithoutFeedbackAndroidProperties {
-
- /**
- * Indicates to accessibility services to treat UI component like a native one.
- * Works for Android only.
- *
- * @enum('none', 'button', 'radiobutton_checked', 'radiobutton_unchecked' )
- */
- accessibilityComponentType?: 'none' | 'button' | 'radiobutton_checked' | 'radiobutton_unchecked'
- }
-
- type ViewAccessibilityTraits = 'none' | 'button' | 'link' | 'header' | 'search' | 'image' | 'selected' | 'plays' | 'key' | 'text' | 'summary' | 'disabled' | 'frequentUpdates' | 'startsMedia' | 'adjustable' | 'allowsDirectInteraction' | 'pageTurn'
-
- export interface TouchableWithoutFeedbackIOSProperties {
-
- /**
- * Provides additional traits to screen reader.
- * By default no traits are provided unless specified otherwise in element
- *
- * @enum('none', 'button', 'link', 'header', 'search', 'image', 'selected', 'plays', 'key', 'text','summary', 'disabled', 'frequentUpdates', 'startsMedia', 'adjustable', 'allowsDirectInteraction', 'pageTurn')
- */
- accessibilityTraits?: ViewAccessibilityTraits | ViewAccessibilityTraits[]
-
- }
-
- /**
- * @see https://facebook.github.io/react-native/docs/touchablewithoutfeedback.html#props
- */
- export interface TouchableWithoutFeedbackProperties extends TouchableWithoutFeedbackAndroidProperties, TouchableWithoutFeedbackIOSProperties {
-
-
- /**
- * Called when the touch is released, but not if cancelled (e.g. by a scroll that steals the responder lock).
- */
- accessible?: boolean
-
- /**
- * Delay in ms, from onPressIn, before onLongPress is called.
- */
- delayLongPress?: number;
-
- /**
- * Delay in ms, from the start of the touch, before onPressIn is called.
- */
- delayPressIn?: number;
-
- /**
- * Delay in ms, from the release of the touch, before onPressOut is called.
- */
- delayPressOut?: number;
-
- /**
- * If true, disable all interactions for this component.
- */
- disabled?: boolean
-
- /**
- * This defines how far your touch can start away from the button.
- * This is added to pressRetentionOffset when moving off of the button.
- * NOTE The touch area never extends past the parent view bounds and
- * the Z-index of sibling views always takes precedence if a touch hits
- * two overlapping views.
- */
- hitSlop?: Insets
-
- /**
- * Invoked on mount and layout changes with
- * {nativeEvent: {layout: {x, y, width, height}}}
- */
- onLayout?: (event: LayoutChangeEvent) => void
-
- onLongPress?: () => void;
-
- /**
- * Called when the touch is released,
- * but not if cancelled (e.g. by a scroll that steals the responder lock).
- */
- onPress?: () => void;
-
- onPressIn?: () => void;
-
- onPressOut?: () => void;
-
- /**
- * //FIXME: not in doc but available in examples
- */
- style?: ViewStyle
-
- /**
- * When the scroll view is disabled, this defines how far your
- * touch may move off of the button, before deactivating the button.
- * Once deactivated, try moving it back and you'll see that the button
- * is once again reactivated! Move it back and forth several times
- * while the scroll view is disabled. Ensure you pass in a constant
- * to reduce memory allocations.
- */
- pressRetentionOffset?: Insets
- }
-
-
- export interface TouchableWithoutFeedbackProps extends TouchableWithoutFeedbackProperties, React.Props {
-
- }
-
- /**
- * Do not use unless you have a very good reason.
- * All the elements that respond to press should have a visual feedback when touched.
- * This is one of the primary reason a "web" app doesn't feel "native".
- *
- * @see https://facebook.github.io/react-native/docs/touchablewithoutfeedback.html
- */
- export interface TouchableWithoutFeedbackStatic extends TimerMixin, TouchableMixin, React.ClassicComponentClass {
-
- }
-
- /**
- * @see https://facebook.github.io/react-native/docs/touchablehighlight.html#props
- */
- export interface TouchableHighlightProperties extends TouchableWithoutFeedbackProperties, React.Props {
-
- /**
- * Determines what the opacity of the wrapped view should be when touch is active.
- */
- activeOpacity?: number
-
- /**
- *
- * Called immediately after the underlay is hidden
- */
- onHideUnderlay?: () => void
-
- /**
- * Called immediately after the underlay is shown
- */
- onShowUnderlay?: () => void
-
- /**
- * @see https://facebook.github.io/react-native/docs/view.html#style
- */
- style?: ViewStyle
-
-
- /**
- * The color of the underlay that will show through when the touch is active.
- */
- underlayColor?: string
- }
-
- /**
- * A wrapper for making views respond properly to touches.
- * On press down, the opacity of the wrapped view is decreased,
- * which allows the underlay color to show through, darkening or tinting the view.
- * The underlay comes from adding a view to the view hierarchy,
- * which can sometimes cause unwanted visual artifacts if not used correctly,
- * for example if the backgroundColor of the wrapped view isn't explicitly set to an opaque color.
- *
- * NOTE: TouchableHighlight supports only one child
- * If you wish to have several child components, wrap them in a View.
- *
- * @see https://facebook.github.io/react-native/docs/touchablehighlight.html
- */
- export interface TouchableHighlightStatic extends NativeMethodsMixin, TimerMixin, TouchableMixin, React.ClassicComponentClass {
- }
-
-
- /**
- * @see https://facebook.github.io/react-native/docs/touchableopacity.html#props
- */
- export interface TouchableOpacityProperties extends TouchableWithoutFeedbackProperties, React.Props {
- /**
- * Determines what the opacity of the wrapped view should be when touch is active.
- * Defaults to 0.2
- */
- activeOpacity?: number
- }
-
- /**
- * A wrapper for making views respond properly to touches.
- * On press down, the opacity of the wrapped view is decreased, dimming it.
- * This is done without actually changing the view hierarchy,
- * and in general is easy to add to an app without weird side-effects.
- *
- * @see https://facebook.github.io/react-native/docs/touchableopacity.html
- */
- export interface TouchableOpacityStatic extends TimerMixin, TouchableMixin, NativeMethodsMixin, React.ClassicComponentClass {
- /**
- * Animate the touchable to a new opacity.
- */
- setOpacityTo: (value: number) => void
- }
-
- interface BaseBackgroundPropType {
- type: string
- }
-
- interface RippleBackgroundPropType extends BaseBackgroundPropType {
- type: 'RippleAndroid'
- color?: number,
- borderless?: boolean
- }
-
- interface ThemeAttributeBackgroundPropType extends BaseBackgroundPropType {
- type: 'ThemeAttrAndroid'
- attribute: string
- }
-
- type BackgroundPropType = RippleBackgroundPropType | ThemeAttributeBackgroundPropType
-
- /**
- * @see https://facebook.github.io/react-native/docs/touchableopacity.html#props
- */
- export interface TouchableNativeFeedbackProperties extends TouchableWithoutFeedbackProperties, React.Props {
- /**
- * Determines the type of background drawable that's going to be used to display feedback.
- * It takes an object with type property and extra data depending on the type.
- * It's recommended to use one of the following static methods to generate that dictionary:
- * 1) TouchableNativeFeedback.SelectableBackground() - will create object that represents android theme's default background for selectable elements (?android:attr/selectableItemBackground)
- * 2) TouchableNativeFeedback.SelectableBackgroundBorderless() - will create object that represent android theme's default background for borderless selectable elements (?android:attr/selectableItemBackgroundBorderless). Available on android API level 21+
- * 3) TouchableNativeFeedback.Ripple(color, borderless) - will create object that represents ripple drawable with specified color (as a string). If property borderless evaluates to true the ripple will render outside of the view bounds (see native actionbar buttons as an example of that behavior). This background type is available on Android API level 21+
- */
- background?: BackgroundPropType
- }
-
- /**
- * A wrapper for making views respond properly to touches (Android only).
- * On Android this component uses native state drawable to display touch feedback.
- * At the moment it only supports having a single View instance as a child node,
- * as it's implemented by replacing that View with another instance of RCTView node with some additional properties set.
- *
- * Background drawable of native feedback touchable can be customized with background property.
- *
- * @see https://facebook.github.io/react-native/docs/touchablenativefeedback.html#content
- */
- export interface TouchableNativeFeedbackStatic extends TouchableMixin, React.ClassicComponentClass {
-
- /**
- * Creates an object that represents android theme's default background for
- * selectable elements (?android:attr/selectableItemBackground).
- */
- SelectableBackground(): ThemeAttributeBackgroundPropType
-
- /**
- * Creates an object that represent android theme's default background for borderless
- * selectable elements (?android:attr/selectableItemBackgroundBorderless).
- * Available on android API level 21+.
- */
- SelectableBackgroundBorderless(): ThemeAttributeBackgroundPropType
-
- /**
- * Creates an object that represents ripple drawable with specified color (as a
- * string). If property `borderless` evaluates to true the ripple will
- * render outside of the view bounds (see native actionbar buttons as an
- * example of that behavior). This background type is available on Android
- * API level 21+.
- *
- * @param color The ripple color
- * @param borderless If the ripple can render outside it's bounds
- */
- Ripple( color: string, borderless?: boolean ): RippleBackgroundPropType
- }
-
-
- export interface LeftToRightGesture {
- // If the gesture can end and restart during one continuous touch
- isDetachable: boolean;
- // How far the swipe must drag to start transitioning
- gestureDetectMovement: number;
- // Amplitude of release velocity that is considered still
- notMoving: number;
- // Fraction of directional move required.
- directionRatio: number;
- // Velocity to transition with when the gesture release was "not moving"
- snapVelocity: number;
- // Region that can trigger swipe. iOS default is 30px from the left edge
- edgeHitWidth: number;
- // Ratio of gesture completion when non-velocity release will cause action
- stillCompletionRatio: number;
- fullDistance: any;
- direction: string;
- }
-
- export interface JumpGesture extends LeftToRightGesture{
- overswipe: {
- frictionConstant: number
- frictionByDistance: number
- }
- }
-
- // see /NavigatorSceneConfigs.js
- export interface SceneConfig {
- // A list of all gestures that are enabled on this scene
- gestures?: {
- pop?: LeftToRightGesture,
- },
-
- // Rebound spring parameters when transitioning FROM this scene
- springFriction: number;
- springTension: number;
-
- // Velocity to start at when transitioning without gesture
- defaultTransitionVelocity: number;
-
- // Animation interpolators for horizontal transitioning:
- animationInterpolators: {
- into: () => boolean,
- out: () => boolean
- };
- }
-
- export interface JumpSceneConfig extends SceneConfig {
- gestures: {
- jumpBack: JumpGesture
- jumpForward: JumpGesture
- }
- }
-
- // see /NavigatorSceneConfigs.js
- export interface SceneConfigs {
- PushFromRight: SceneConfig;
- PushFromLeft: SceneConfig;
- FloatFromRight: SceneConfig;
- FloatFromLeft: SceneConfig;
- FloatFromBottom: SceneConfig;
- FloatFromBottomAndroid: SceneConfig;
- FadeAndroid: SceneConfig;
- HorizontalSwipeJump: SceneConfig;
- HorizontalSwipeJumpFromRight: SceneConfig;
- VerticalUpSwipeJump: SceneConfig;
- VerticalDownSwipeJump: SceneConfig;
- }
-
- export interface Route {
- component?: React.ComponentClass
- id?: string
- title?: string
- passProps?: Object;
-
- //anything else
- [key: string]: any
-
- //Commonly found properties
- backButtonTitle?: string
- content?: string
- message?: string;
- index?: number
- onRightButtonPress?: () => void
- rightButtonTitle?: string
- sceneConfig?: SceneConfig
- wrapperStyle?: any
- }
-
-
- /**
- * @see https://facebook.github.io/react-native/docs/navigator.html#content
- */
- export interface NavigatorProperties extends React.Props {
- /**
- * Optional function that allows configuration about scene animations and gestures.
- * Will be invoked with `route` and `routeStack` parameters, where `route`
- * corresponds to the current scene being rendered by the `Navigator` and
- * `routeStack` is the set of currently mounted routes that the navigator
- * could transition to. The function should return a scene configuration object.
- * @param route
- * @param routeStack
- */
- configureScene?: (route: Route, routeStack: Route[]) => SceneConfig
- /**
- * Specify a route to start on.
- * A route is an object that the navigator will use to identify each scene to render.
- * initialRoute must be a route in the initialRouteStack if both props are provided.
- * The initialRoute will default to the last item in the initialRouteStack.
- */
- initialRoute?: Route
- /**
- * Provide a set of routes to initially mount.
- * Required if no initialRoute is provided.
- * Otherwise, it will default to an array containing only the initialRoute
- */
- initialRouteStack?: Route[]
-
- /**
- * Optionally provide a navigation bar that persists across scene transitions
- */
- navigationBar?: React.ReactElement
-
- /**
- * Optionally provide the navigator object from a parent Navigator
- */
- navigator?: Navigator
-
- /**
- * @deprecated Use navigationContext.addListener('willfocus', callback) instead.
- */
- onDidFocus?: Function
-
- /**
- * @deprecated Use navigationContext.addListener('willfocus', callback) instead.
- */
- onWillFocus?: Function
-
- /**
- * Required function which renders the scene for a given route.
- * Will be invoked with the route and the navigator object
- * @param route
- * @param navigator
- */
- renderScene: ( route: Route, navigator: Navigator ) => React.ReactElement
-
- /**
- * Styles to apply to the container of each scene
- */
- sceneStyle?: ViewStyle
-
- }
-
- /**
- * Class that contains the info and methods for app navigation.
- */
- export interface NavigationContext {
- parent: NavigationContext;
- top: NavigationContext;
- currentRoute: any;
- appendChild(childContext: NavigationContext): void;
- addListener(eventType: string, listener: () => void, useCapture?: boolean): NativeEventSubscription;
- emit(eventType: string, data: any, didEmitCallback?: () => void): void;
- dispose(): void;
- }
-
- interface InteractionMixin {
- createInteractionHandle(): number
- clearInteractionHandle(clearHandle: number): void
- /**
- * Schedule work for after all interactions have completed.
- *
- * @param {function} callback
- */
- runAfterInteractions(callback: () => any): void
- }
-
- interface SubscribableMixin {
- /**
- * Special form of calling `addListener` that *guarantees* that a
- * subscription *must* be tied to a component instance, and therefore will
- * be cleaned up when the component is unmounted. It is impossible to create
- * the subscription and pass it in - this method must be the one to create
- * the subscription and therefore can guarantee it is retained in a way that
- * will be cleaned up.
- *
- * @param {EventEmitter} eventEmitter emitter to subscribe to.
- * @param {string} eventType Type of event to listen to.
- * @param {function} listener Function to invoke when event occurs.
- * @param {object} context Object to use as listener context.
- */
- addListenerOn( eventEmitter: any, eventType: string, listener: () => any, context: any ): void
- }
-
- /**
- * Use Navigator to transition between different scenes in your app.
- * To accomplish this, provide route objects to the navigator to identify each scene,
- * and also a renderScene function that the navigator can use to render the scene for a given route.
- *
- * To change the animation or gesture properties of the scene, provide a configureScene prop to get the config object for a given route.
- * See Navigator.SceneConfigs for default animations and more info on scene config options.
- * @see https://facebook.github.io/react-native/docs/navigator.html
- */
- export interface NavigatorStatic extends TimerMixin, InteractionMixin, SubscribableMixin, React.ComponentClass {
- SceneConfigs: SceneConfigs;
- NavigationBar: NavigatorStatic.NavigationBarStatic;
- BreadcrumbNavigationBar: NavigatorStatic.BreadcrumbNavigationBarStatic;
-
- navigationContext: NavigationContext;
-
- /**
- * returns the current list of routes
- */
- getCurrentRoutes(): Route[];
-
- /**
- * Jump backward without unmounting the current scen
- */
- jumpBack(): void;
-
- /**
- * Jump forward to the next scene in the route stack
- */
- jumpForward(): void;
-
- /**
- * Transition to an existing scene without unmounting
- */
- jumpTo(route: Route): void;
-
- /**
- * Navigate forward to a new scene, squashing any scenes that you could jumpForward to
- */
- push(route: Route): void;
-
- /**
- * Transition back and unmount the current scene
- */
- pop(): void;
-
- /**
- * Go back N scenes at once. When N=1, behavior matches `pop()`.
- * When N is invalid(negative or bigger than current routes count), do nothing.
- * @param {number} n The number of scenes to pop. Should be an integer.
- */
- popN(n: number): void
-
- /**
- * Replace the current scene with a new route
- */
- replace(route: Route): void;
-
- /**
- * Replace a scene as specified by an index
- */
- replaceAtIndex(route: Route, index: number): void;
-
- /**
- * Replace the previous scene
- */
- replacePrevious(route: Route): void;
-
- /**
- * Reset every scene with an array of routes
- */
- immediatelyResetRouteStack(routes: Route[]): void;
-
- /**
- * Pop to a particular scene, as specified by its route. All scenes after it will be unmounted
- */
- popToRoute(route: Route): void;
-
- /**
- * Pop to the first scene in the stack, unmounting every other scene
- */
- popToTop(): void;
-
- /**
- * Replace the previous scene and pop to it.
- */
- replacePreviousAndPop( route: Route ): void;
-
- /**
- * Navigate to a new scene and reset route stack.
- */
- resetTo( route: Route ): void;
-
- }
-
- namespace NavigatorStatic {
-
-
- export interface NavState {
- routeStack: Route[]
- presentedIndex: number
- }
-
- // @see NavigationBarStyle.ios.js
- export interface NavigationBarStyle {
- General: {
- NavBarHeight: number
- StatusBarHeight: number
- TotalNavHeight: number
- },
- Interpolators: {
- // Animating *into* the center stage from the right
- RightToCenter: () => boolean
- // Animating out of the center stage, to the left
- CenterToLeft: () => boolean
- // Both stages (animating *past* the center stage)
- RightToLeft: () => boolean
- },
- Stages: {
- Left: {
- Title: FlexStyle
- LeftButton: FlexStyle
- RightButton: FlexStyle
- },
- Center: {
- Title: FlexStyle
- LeftButton: FlexStyle
- RightButton: FlexStyle
- },
- Right: {
- Title: FlexStyle
- LeftButton: FlexStyle
- RightButton: FlexStyle
- },
- }
- }
-
-
- export interface NavigationBarRouteMapper {
- Title: (route: Route, nav: Navigator, index: number, navState: NavState) => JSX.Element | null;
- LeftButton: (route: Route, nav: Navigator, index: number, navState: NavState) => JSX.Element | null;
- RightButton: (route: Route, nav: Navigator, index: number, navState: NavState) => JSX.Element | null;
- }
-
- /**
- * @see NavigatorNavigationBar.js
- */
- export interface NavigationBarProperties extends React.Props {
- navigator?: Navigator
- routeMapper?: NavigationBarRouteMapper
- navState?: NavState
- navigationStyles?: NavigationBarStyle
- style?: ViewStyle
- }
-
- export interface NavigationBarStatic extends React.ComponentClass {
- Styles: NavigationBarStyle
- StylesAndroid: NavigationBarStyle;
- StylesIOS: NavigationBarStyle;
-
- /**
- * Stop transtion, immediately resets the cached state and re-render the
- * whole view.
- */
- immediatelyRefresh(): void;
- }
-
- export type NavigationBar = NavigationBarStatic
- export var NavigationBar: NavigationBarStatic
-
-
- export interface BreadcrumbNavigationBarStyle {
- //TODO &see NavigatorBreadcrumbNavigationBar.js
- }
-
- export interface BreadcrumbNavigationBarRouteMapper {
- rightContentForRoute: (route: Route, navigator: Navigator) => React.ReactElement
- titleContentForRoute: (route: Route, navigator: Navigator) => React.ReactElement
- iconForRoute: (route: Route, navigator: Navigator) => React.ReactElement
- //in samples...
- separatorForRoute: (route: Route, navigator: Navigator) => React.ReactElement
- }
-
- /**
- * @see NavigatorNavigationBar.js
- */
- export interface BreadcrumbNavigationBarProperties extends React.Props {
- navigator?: Navigator
- routeMapper?: BreadcrumbNavigationBarRouteMapper
- navState?: NavState
- style?: ViewStyle
- }
-
- export interface BreadcrumbNavigationBarStatic extends React.ComponentClass {
- Styles: BreadcrumbNavigationBarStyle
-
- immediatelyRefresh(): void
- }
-
- export type BreadcrumbNavigationBar = BreadcrumbNavigationBarStatic
- var BreadcrumbNavigationBar: BreadcrumbNavigationBarStatic
-
- }
-
- // @see https://github.com/facebook/react-native/blob/0.34-stable\Libraries\StyleSheet\StyleSheetTypes.js
- export namespace StyleSheet {
-
- type Style = ViewStyle | TextStyle | ImageStyle
-
- /**
- * Creates a StyleSheet style reference from the given object.
- */
- export function create( styles: T ): T;
-
- /**
- * Flattens an array of style objects, into one aggregated style object.
- * Alternatively, this method can be used to lookup IDs, returned by
- * StyleSheet.register.
- *
- * > **NOTE**: Exercise caution as abusing this can tax you in terms of
- * > optimizations.
- * >
- * > IDs enable optimizations through the bridge and memory in general. Refering
- * > to style objects directly will deprive you of these optimizations.
- *
- * Example:
- * ```
- * var styles = StyleSheet.create({
- * listItem: {
- * flex: 1,
- * fontSize: 16,
- * color: 'white'
- * },
- * selectedListItem: {
- * color: 'green'
- * }
- * });
- *
- * StyleSheet.flatten([styles.listItem, styles.selectedListItem])
- * // returns { flex: 1, fontSize: 16, color: 'green' }
- * ```
- * Alternative use:
- * ```
- * StyleSheet.flatten(styles.listItem);
- * // return { flex: 1, fontSize: 16, color: 'white' }
- * // Simply styles.listItem would return its ID (number)
- * ```
- * This method internally uses `StyleSheetRegistry.getStyleByID(style)`
- * to resolve style objects represented by IDs. Thus, an array of style
- * objects (instances of StyleSheet.create), are individually resolved to,
- * their respective objects, merged as one and then returned. This also explains
- * the alternative use.
- */
- export function flatten(style?: Style | Style[]): Style
-
- /**
- * This is defined as the width of a thin line on the platform. It can be
- * used as the thickness of a border or division between two elements.
- * Example:
- * ```
- * {
- * borderBottomColor: '#bbb',
- * borderBottomWidth: StyleSheet.hairlineWidth
- * }
- * ```
- *
- * This constant will always be a round number of pixels (so a line defined
- * by it look crisp) and will try to match the standard width of a thin line
- * on the underlying platform. However, you should not rely on it being a
- * constant size, because on different platforms and screen densities its
- * value may be calculated differently.
- */
- export var hairlineWidth: number
-
- /**
- * A very common pattern is to create overlays with position absolute and zero positioning,
- * so `absoluteFill` can be used for convenience and to reduce duplication of these repeated
- * styles.
- */
- export var absoluteFill: number
-
- /**
- * Sometimes you may want `absoluteFill` but with a couple tweaks - `absoluteFillObject` can be
- * used to create a customized entry in a `StyleSheet`, e.g.:
- *
- * const styles = StyleSheet.create({
- * wrapper: {
- * ...StyleSheet.absoluteFillObject,
- * top: 10,
- * backgroundColor: 'transparent',
- * },
- * });
- */
- export var absoluteFillObject: {
- position: string
- left: number
- right: number
- top: number
- bottom: number
- }
- }
-
- export interface RelayProfiler {
- attachProfileHandler(
- name: string,
- handler: (name: string, state?: any) => () => void
- ): void,
-
- attachAggregateHandler(
- name: string,
- handler: (name: string, callback: () => void) => void
- ): void,
- }
-
- export interface SystraceStatic {
- setEnabled(enabled: boolean): void
- /**
- * beginEvent/endEvent for starting and then ending a profile within the same call stack frame
- **/
- beginEvent(profileName?: any, args?: any): void
- endEvent(): void
- /**
- * beginAsyncEvent/endAsyncEvent for starting and then ending a profile where the end can either
- * occur on another thread or out of the current stack frame, eg await
- * the returned cookie variable should be used as input into the endAsyncEvent call to end the profile
- **/
- beginAsyncEvent(profileName?: any): any
- endAsyncEvent(profileName?: any, cookie?: any): void
- /**
- * counterEvent registers the value to the profileName on the systrace timeline
- **/
- counterEvent(profileName?: any, value?: any): void
- /**
- * Relay profiles use await calls, so likely occur out of current stack frame
- * therefore async variant of profiling is used
- **/
- attachToRelayProfiler(relayProfiler: RelayProfiler): void
- /* This is not called by default due to perf overhead but it's useful
- if you want to find traces which spend too much time in JSON. */
- swizzleJSON(): void
- /**
- * Measures multiple methods of a class. For example, you can do:
- * Systrace.measureMethods(JSON, 'JSON', ['parse', 'stringify']);
- *
- * @param object
- * @param objectName
- * @param methodNames Map from method names to method display names.
- */
- measureMethods(object: any, objectName: string, methodNames: Array): void
- /**
- * Returns an profiled version of the input function. For example, you can:
- * JSON.parse = Systrace.measure('JSON', 'parse', JSON.parse);
- *
- * @param objName
- * @param fnName
- * @param {function} func
- * @return {function} replacement function
- */
- measure(objName: string, fnName: string, func: Function): Function
- }
-
- /**
- * //FIXME: Could not find docs. Inferred from examples and jscode : ListViewDataSource.js
- */
- export interface DataSourceAssetCallback {
- rowHasChanged?: (r1: any, r2: any) => boolean
- sectionHeaderHasChanged?: (h1: any, h2: any) => boolean
- getRowData?: (dataBlob: any, sectionID: number | string, rowID: number | string) => T
- getSectionHeaderData?: (dataBlob: any, sectionID: number | string) => T
- }
-
- /**
- * Provides efficient data processing and access to the
- * `ListView` component. A `ListViewDataSource` is created with functions for
- * extracting data from the input blob, and comparing elements (with default
- * implementations for convenience). The input blob can be as simple as an
- * array of strings, or an object with rows nested inside section objects.
- *
- * To update the data in the datasource, use `cloneWithRows` (or
- * `cloneWithRowsAndSections` if you care about sections). The data in the
- * data source is immutable, so you can't modify it directly. The clone methods
- * suck in the new data and compute a diff for each row so ListView knows
- * whether to re-render it or not.
- */
- export interface ListViewDataSource {
- /**
- * You can provide custom extraction and `hasChanged` functions for section
- * headers and rows. If absent, data will be extracted with the
- * `defaultGetRowData` and `defaultGetSectionHeaderData` functions.
- *
- * The default extractor expects data of one of the following forms:
- *
- * { sectionID_1: { rowID_1: , ... }, ... }
- *
- * or
- *
- * { sectionID_1: [ , , ... ], ... }
- *
- * or
- *
- * [ [ , , ... ], ... ]
- *
- * The constructor takes in a params argument that can contain any of the
- * following:
- *
- * - getRowData(dataBlob, sectionID, rowID);
- * - getSectionHeaderData(dataBlob, sectionID);
- * - rowHasChanged(prevRowData, nextRowData);
- * - sectionHeaderHasChanged(prevSectionData, nextSectionData);
- */
- new (onAsset: DataSourceAssetCallback): ListViewDataSource;
-
- /**
- * Clones this `ListViewDataSource` with the specified `dataBlob` and
- * `rowIdentities`. The `dataBlob` is just an aribitrary blob of data. At
- * construction an extractor to get the interesting informatoin was defined
- * (or the default was used).
- *
- * The `rowIdentities` is is a 2D array of identifiers for rows.
- * ie. [['a1', 'a2'], ['b1', 'b2', 'b3'], ...]. If not provided, it's
- * assumed that the keys of the section data are the row identities.
- *
- * Note: This function does NOT clone the data in this data source. It simply
- * passes the functions defined at construction to a new data source with
- * the data specified. If you wish to maintain the existing data you must
- * handle merging of old and new data separately and then pass that into
- * this function as the `dataBlob`.
- */
- cloneWithRows