react-native-tvos 0.87.1-0 → 0.87.1-1

package/types_generated/Libraries/Components/TV/TVViewPropTypes.d.ts

@@ -0,0 +1,123 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @generated SignedSource<<fde9225b13476772c8c96111e1f19ad4>>
+ *
+ * This file was translated from Flow by scripts/js-api/build-types/index.js.
+ * Original file: packages/react-native/Libraries/Components/TV/TVViewPropTypes.js
+ */
+
+export type TVParallaxPropertiesType = Readonly<{
+  /**
+   * If true, parallax effects are enabled.  Defaults to true.
+   */
+  enabled?: boolean | undefined;
+  /**
+   * Defaults to 2.0.
+   */
+  shiftDistanceX?: number | undefined;
+  /**
+   * Defaults to 2.0.
+   */
+  shiftDistanceY?: number | undefined;
+  /**
+   * Defaults to 0.05.
+   */
+  tiltAngle?: number | undefined;
+  /**
+   * Defaults to 1.0
+   */
+  magnification?: number | undefined;
+  /**
+   * Defaults to 1.0
+   */
+  pressMagnification?: number | undefined;
+  /**
+   * Defaults to 0.3
+   */
+  pressDuration?: number | undefined;
+  /**
+   * Defaults to 0.3
+   */
+  pressDelay?: number | undefined;
+}>;
+/**
+ * These props are for both Apple TV and Android TV.
+ * TODO: update `@react-native/eslint-plugin` so that the
+ * name can be changed to TVViewProps
+ */
+export type TVViewProps = Readonly<{
+  /**
+   * @deprecated Replaced by `focusable`.
+   *
+   * @platform ios
+   */
+  isTVSelectable?: boolean | undefined;
+  /**
+   * Whether this `View` should be focusable with a non-touch input device, eg. receive focus with a hardware keyboard.
+   *
+   */
+  focusable?: boolean | undefined;
+  /**
+   * May be set to true to force the focus engine to move focus to this view.
+   *
+   */
+  hasTVPreferredFocus?: boolean | undefined;
+  /**
+   * *(Apple TV only)* Object with properties to control Apple TV parallax effects.
+   *
+   * @platform ios
+   */
+  tvParallaxProperties?: TVParallaxPropertiesType | undefined;
+  /**
+   * Additional properties needed for flow checks on TVFocusGuideView
+   */
+  destinations?: Object[] | undefined;
+  enabled?: boolean | undefined;
+  autoFocus?: boolean | undefined;
+  safePadding?: string | null | undefined;
+  onPressIn?: ((event: any) => void) | undefined;
+  onPressOut?: ((event: any) => void) | undefined;
+  /**
+   * TV next focus forward (see documentation for the View component).
+   *
+   * @platform android
+   */
+  nextFocusForward?: number | undefined;
+  /**
+   * TV next focus down (see documentation for the View component).
+   *
+   */
+  nextFocusDown?: number | undefined;
+  /**
+   * TV next focus left (see documentation for the View component).
+   *
+   */
+  nextFocusLeft?: number | undefined;
+  /**
+   * TV next focus right (see documentation for the View component).
+   *
+   */
+  nextFocusRight?: number | undefined;
+  /**
+   * TV next focus up (see documentation for the View component).
+   *
+   */
+  nextFocusUp?: number | undefined;
+  /**
+   * Scroll snap alignment (used with snapToAlignment="item" in ScrollView).
+   *
+   */
+  scrollSnapAlign?: ("start" | "center" | "end") | undefined;
+  /**
+   * Per-item scroll snap offset in dp/pt. When set on a View inside a
+   * ScrollView with `snapToAlignment="item"`, the focus engine lands the
+   * View's top at viewport y = scrollSnapOffset. Standalone alternative to
+   * `scrollSnapAlign` — set one or the other; if both are set on the same
+   * View, `scrollSnapOffset` takes precedence.
+   */
+  scrollSnapOffset?: number | undefined;
+}>;

package/types_generated/Libraries/Components/TV/tagForComponentOrHandle.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @generated SignedSource<<9c48b7a2894d59b37f70e94b6435db63>>
+ *
+ * This file was translated from Flow by scripts/js-api/build-types/index.js.
+ * Original file: packages/react-native/Libraries/Components/TV/tagForComponentOrHandle.js
+ */
+/*
+ * Replacement for findNodeHandle, since we need this for converting
+ * components to tags when rendering nextFocus props
+ *
+ */
+
+import * as React from "react";
+export type ComponentOrHandleType = null | undefined | (React.ComponentRef<React.ElementType> | number);
+export type TagForComponentOrHandleType = (component: ComponentOrHandleType) => null | undefined | number;
+declare const tagForComponentOrHandle: TagForComponentOrHandleType;
+declare const $$tagForComponentOrHandle: typeof tagForComponentOrHandle;
+declare type $$tagForComponentOrHandle = typeof $$tagForComponentOrHandle;
+export default $$tagForComponentOrHandle;

package/types_generated/Libraries/Components/TV/useTVEventHandler.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @generated SignedSource<<dda32f9f77aa4745546e57f1620a3942>>
+ *
+ * This file was translated from Flow by scripts/js-api/build-types/index.js.
+ * Original file: packages/react-native/Libraries/Components/TV/useTVEventHandler.js
+ */
+/*
+ *
+ */
+
+import type { TVRemoteEvent } from "../../Types/CoreEventTypes";
+declare const useTVEventHandler: (handleEvent: (evt: TVRemoteEvent) => void) => void;
+declare const $$useTVEventHandler: typeof useTVEventHandler;
+declare type $$useTVEventHandler = typeof $$useTVEventHandler;
+export default $$useTVEventHandler;

package/types_generated/Libraries/Components/TextInput/InputAccessoryView.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @generated SignedSource<<7192abadcfe547ec0a5e4bdf83c39ef4>>
+ *
+ * This file was translated from Flow by scripts/js-api/build-types/index.js.
+ * Original file: packages/react-native/Libraries/Components/TextInput/InputAccessoryView.js
+ */
+
+import { type ColorValue, type ViewStyleProp } from "../../StyleSheet/StyleSheet";
+import * as React from "react";
+export interface InputAccessoryViewProps {
+  readonly children: React.ReactNode;
+  /**
+   * An ID used to associate this `InputAccessoryView` to specified `TextInput`(s).
+   */
+  readonly nativeID?: string | undefined;
+  readonly style?: ViewStyleProp | undefined;
+  readonly backgroundColor?: ColorValue | undefined;
+}
+declare const InputAccessoryView: React.ComponentType<InputAccessoryViewProps>;
+/**
+ * A component which enables customization of the keyboard input accessory view on iOS. The input accessory view is displayed above the keyboard whenever a `TextInput` has focus. This component can be used to create custom toolbars.
+ *
+ * To use this component, wrap your custom toolbar with `InputAccessoryView` and set a `nativeID`. Then, pass that `nativeID` as the `inputAccessoryViewID` of whatever `TextInput` you desire.
+ *
+ * This component can also be used to create sticky text inputs (text inputs which are anchored to the top of the keyboard). To do this, wrap a `TextInput` with `InputAccessoryView` and don't set a `nativeID`.
+ *
+ * @see https://reactnative.dev/docs/inputaccessoryview
+ * @platform ios
+ */
+declare const $$InputAccessoryView: typeof InputAccessoryView;
+declare type $$InputAccessoryView = typeof $$InputAccessoryView;
+export default $$InputAccessoryView;

package/types_generated/Libraries/Components/TextInput/TextInput.d.ts

@@ -0,0 +1,162 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @generated SignedSource<<b30102f26b887dd69b59174dea6e08b7>>
+ *
+ * This file was translated from Flow by scripts/js-api/build-types/index.js.
+ * Original file: packages/react-native/Libraries/Components/TextInput/TextInput.js
+ */
+
+import type { HostInstance } from "../../../src/private/types/HostInstance";
+import type { BlurEvent, FocusEvent } from "../../Types/CoreEventTypes";
+import type { AutoCapitalize, EnterKeyHintType, EnterKeyHintTypeAndroid, EnterKeyHintTypeIOS, EnterKeyHintTypeOptions, InputModeOptions, KeyboardType, KeyboardTypeAndroid, KeyboardTypeIOS, KeyboardTypeOptions, ReturnKeyType, ReturnKeyTypeAndroid, ReturnKeyTypeIOS, ReturnKeyTypeOptions, SubmitBehavior, TextContentType, TextInputAndroidProps, TextInputBlurEvent, TextInputChangeEvent, TextInputContentSizeChangeEvent, TextInputEditingEvent, TextInputEndEditingEvent, TextInputEvent, TextInputFocusEvent, TextInputInstance, TextInputIOSProps, TextInputKeyPressEvent, TextInputProps, TextInputSelectionChangeEvent, TextInputSubmitEditingEvent, TextInputType } from "./TextInput.flow";
+export type { AutoCapitalize, BlurEvent, EnterKeyHintType, EnterKeyHintTypeAndroid, EnterKeyHintTypeIOS, EnterKeyHintTypeOptions, FocusEvent, InputModeOptions, KeyboardType, KeyboardTypeAndroid, KeyboardTypeIOS, KeyboardTypeOptions, ReturnKeyType, ReturnKeyTypeAndroid, ReturnKeyTypeIOS, ReturnKeyTypeOptions, SubmitBehavior, TextContentType, TextInputAndroidProps, TextInputBlurEvent, TextInputChangeEvent, TextInputContentSizeChangeEvent, TextInputEditingEvent, TextInputEndEditingEvent, TextInputEvent, TextInputFocusEvent, TextInputIOSProps, TextInputKeyPressEvent, TextInputProps, TextInputSelectionChangeEvent, TextInputInstance, TextInputSubmitEditingEvent };
+type TextInputStateType = Readonly<{
+  /**
+   * @deprecated Use currentlyFocusedInput
+   * Returns the ID of the currently focused text field, if one exists
+   * If no text field is focused it returns null
+   */
+  currentlyFocusedField: () => number | undefined;
+  /**
+   * Returns the ref of the currently focused text field, if one exists
+   * If no text field is focused it returns null
+   */
+  currentlyFocusedInput: () => HostInstance | undefined;
+  /**
+   * @param textField ref of the text field to focus
+   * Focuses the specified text field
+   * noop if the text field was already focused
+   */
+  focusTextInput: (textField: HostInstance | undefined) => void;
+  /**
+   * @param textField ref of the text field to focus
+   * Unfocuses the specified text field
+   * noop if it wasn't focused
+   */
+  blurTextInput: (textField: HostInstance | undefined) => void;
+}>;
+export type TextInputComponentStatics = Readonly<{
+  State: TextInputStateType;
+}>;
+/**
+ * A foundational component for inputting text into the app via a
+ * keyboard. Props provide configurability for several features, such as
+ * auto-correction, auto-capitalization, placeholder text, and different keyboard
+ * types, such as a numeric keypad.
+ *
+ * The simplest use case is to plop down a `TextInput` and subscribe to the
+ * `onChangeText` events to read the user input. There are also other events,
+ * such as `onSubmitEditing` and `onFocus` that can be subscribed to.
+ *
+ * Example:
+ *
+ * ```tsx
+ * import React, { Component } from 'react';
+ * import { AppRegistry, TextInput } from 'react-native';
+ *
+ * export default class UselessTextInput extends Component {
+ *   constructor(props) {
+ *     super(props);
+ *     this.state = { text: 'Useless Placeholder' };
+ *   }
+ *
+ *   render() {
+ *     return (
+ *       <TextInput
+ *         style={{height: 40, borderColor: 'gray', borderWidth: 1}}
+ *         onChangeText={(text) => this.setState({text})}
+ *         value={this.state.text}
+ *       />
+ *     );
+ *   }
+ * }
+ *
+ * // skip this line if using Create React Native App
+ * AppRegistry.registerComponent('AwesomeProject', () => UselessTextInput);
+ * ```
+ *
+ * Two methods exposed via the native element are .focus() and .blur() that
+ * will focus or blur the TextInput programmatically.
+ *
+ * Note that some props are only available with `multiline={true/false}`.
+ * Additionally, border styles that apply to only one side of the element
+ * (e.g., `borderBottomColor`, `borderLeftWidth`, etc.) will not be applied if
+ * `multiline=false`. To achieve the same effect, you can wrap your `TextInput`
+ * in a `View`:
+ *
+ * Example:
+ *
+ * ```tsx
+ * import React, { Component } from 'react';
+ * import { AppRegistry, View, TextInput } from 'react-native';
+ *
+ * class UselessTextInput extends Component {
+ *   render() {
+ *     return (
+ *       <TextInput
+ *         {...this.props} // Inherit any props passed to it; e.g., multiline, numberOfLines below
+ *         editable={true}
+ *         maxLength={40}
+ *       />
+ *     );
+ *   }
+ * }
+ *
+ * export default class UselessTextInputMultiline extends Component {
+ *   constructor(props) {
+ *     super(props);
+ *     this.state = {
+ *       text: 'Useless Multiline Placeholder',
+ *     };
+ *   }
+ *
+ *   // If you type something in the text box that is a color, the background will change to that
+ *   // color.
+ *   render() {
+ *     return (
+ *      <View style={{
+ *        backgroundColor: this.state.text,
+ *        borderBottomColor: '#000000',
+ *        borderBottomWidth: 1 }}
+ *      >
+ *        <UselessTextInput
+ *          multiline={true}
+ *          numberOfLines={4}
+ *          onChangeText={(text) => this.setState({text})}
+ *          value={this.state.text}
+ *        />
+ *      </View>
+ *     );
+ *   }
+ * }
+ *
+ * // skip these lines if using Create React Native App
+ * AppRegistry.registerComponent(
+ *  'AwesomeProject',
+ *  () => UselessTextInputMultiline
+ * );
+ * ```
+ *
+ * `TextInput` has by default a border at the bottom of its view. This border
+ * has its padding set by the background image provided by the system, and it
+ * cannot be changed. Solutions to avoid this is to either not set height
+ * explicitly, case in which the system will take care of displaying the border
+ * in the correct position, or to not display the border by setting
+ * `underlineColorAndroid` to transparent.
+ *
+ * Note that on Android performing text selection in input can change
+ * app's activity `windowSoftInputMode` param to `adjustResize`.
+ * This may cause issues with components that have position: 'absolute'
+ * while keyboard is active. To avoid this behavior either specify `windowSoftInputMode`
+ * in AndroidManifest.xml ( https://developer.android.com/guide/topics/manifest/activity-element.html )
+ * or control this param programmatically with native code.
+ *
+ * @see https://reactnative.dev/docs/textinput
+ */
+declare const $$TextInput: TextInputType;
+declare type $$TextInput = typeof $$TextInput;
+export default $$TextInput;