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

package/types_generated/Libraries/Components/View/ViewAccessibility.d.ts

@@ -0,0 +1,426 @@
+/**
+ * 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<<e77931775062e476f4c32a701598f107>>
+ *
+ * This file was translated from Flow by scripts/js-api/build-types/index.js.
+ * Original file: packages/react-native/Libraries/Components/View/ViewAccessibility.js
+ */
+
+import type { NativeSyntheticEvent } from "../../Types/CoreEventTypes";
+export type AccessibilityRole = "none" | "button" | "dropdownlist" | "togglebutton" | "link" | "search" | "image" | "keyboardkey" | "text" | "adjustable" | "imagebutton" | "header" | "summary" | "alert" | "checkbox" | "combobox" | "menu" | "menubar" | "menuitem" | "progressbar" | "radio" | "radiogroup" | "scrollbar" | "spinbutton" | "switch" | "tab" | "tabbar" | "tablist" | "timer" | "list" | "toolbar" | "grid" | "pager" | "scrollview" | "horizontalscrollview" | "viewgroup" | "webview" | "drawerlayout" | "slidingdrawer" | "iconmenu" | string;
+export type Role = "alert" | "alertdialog" | "application" | "article" | "banner" | "button" | "cell" | "checkbox" | "columnheader" | "combobox" | "complementary" | "contentinfo" | "definition" | "dialog" | "directory" | "document" | "feed" | "figure" | "form" | "grid" | "group" | "heading" | "img" | "link" | "list" | "listitem" | "log" | "main" | "marquee" | "math" | "menu" | "menubar" | "menuitem" | "meter" | "navigation" | "none" | "note" | "option" | "presentation" | "progressbar" | "radio" | "radiogroup" | "region" | "row" | "rowgroup" | "rowheader" | "scrollbar" | "searchbox" | "separator" | "slider" | "spinbutton" | "status" | "summary" | "switch" | "tab" | "table" | "tablist" | "tabpanel" | "term" | "timer" | "toolbar" | "tooltip" | "tree" | "treegrid" | "treeitem";
+export type AccessibilityActionName =
+/**
+ * Generated when a screen reader user double taps the component.
+ */
+"activate"
+/**
+ * Generated when a screen reader user increments an adjustable component.
+ */ | "increment"
+/**
+ * Generated when a screen reader user decrements an adjustable component.
+ */ | "decrement"
+/**
+ * Generated when a TalkBack user places accessibility focus on the component and double taps and holds one finger on the screen.
+ * @platform android
+ */ | "longpress"
+/**
+ * Generated when a VoiceOver user places focus on or inside the component and double taps with two fingers.
+ * @platform ios
+ */ | "magicTap"
+/**
+ * Generated when a VoiceOver user places focus on or inside the component and performs a two finger scrub gesture (left, right, left).
+ * @platform ios
+ */ | "escape";
+export type AccessibilityActionInfo = Readonly<{
+  name: AccessibilityActionName | string;
+  label?: string | undefined;
+}>;
+export type AccessibilityActionEvent = NativeSyntheticEvent<Readonly<{
+  actionName: string;
+}>>;
+export type AccessibilityState = {
+  /**
+   * When true, informs accessible tools if the element is disabled
+   */
+  disabled?: boolean | undefined;
+  /**
+   * When true, informs accessible tools if the element is selected
+   */
+  selected?: boolean | undefined;
+  /**
+   * For items like Checkboxes and Toggle switches, reports their state to accessible tools
+   */
+  checked?: (boolean | undefined) | "mixed" | undefined;
+  /**
+   *  When present, informs accessible tools if the element is busy
+   */
+  busy?: boolean | undefined;
+  /**
+   *  When present, informs accessible tools the element is expanded or collapsed
+   */
+  expanded?: boolean | undefined;
+};
+export type AccessibilityValue = Readonly<{
+  /**
+   * The minimum value of this component's range. (should be an integer)
+   */
+  min?: number | undefined;
+  /**
+   * The maximum value of this component's range. (should be an integer)
+   */
+  max?: number | undefined;
+  /**
+   * The current value of this component's range. (should be an integer)
+   */
+  now?: number | undefined;
+  /**
+   * A textual description of this component's value. (will override minimum, current, and maximum if set)
+   */
+  text?: string | undefined;
+}>;
+export type AccessibilityPropsAndroid = Readonly<{
+  /**
+   * Identifies the element that labels the element it is applied to. When the assistive technology focuses on the component with this props,
+   * the text is read aloud. The value should should match the nativeID of the related element.
+   *
+   * @platform android
+   */
+  accessibilityLabelledBy?: (string | undefined) | (Array<string> | undefined) | undefined;
+  /**
+   * Identifies the element that labels the element it is applied to. When the assistive technology focuses on the component with this props,
+   * the text is read aloud. The value should should match the nativeID of the related element.
+   *
+   * @platform android
+   */
+  "aria-labelledby"?: string | undefined;
+  /**
+   * Indicates to accessibility services whether the user should be notified
+   * when this view changes. Works for Android API >= 19 only.
+   *
+   * @platform android
+   *
+   * See https://reactnative.dev/docs/view#accessibilityliveregion
+   */
+  accessibilityLiveRegion?: ("none" | "polite" | "assertive") | undefined;
+  /**
+   * Indicates to accessibility services whether the user should be notified
+   * when this view changes. Works for Android API >= 19 only.
+   *
+   * @platform android
+   *
+   * See https://reactnative.dev/docs/view#accessibilityliveregion
+   */
+  "aria-live"?: ("polite" | "assertive" | "off") | undefined;
+  /**
+   * 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.
+   *
+   * @platform android
+   *
+   * See https://reactnative.dev/docs/view#importantforaccessibility
+   */
+  importantForAccessibility?: ("auto" | "yes" | "no" | "no-hide-descendants") | undefined;
+  /**
+   * Enables the view to be screen reader focusable, not keyboard focusable. This has lower priority
+   * than focusable or accessible props.
+   *
+   * @platform android
+   */
+  screenReaderFocusable?: boolean | undefined;
+}>;
+export type AccessibilityPropsIOS = Readonly<{
+  /**
+   * Prevents view from being inverted if set to true and color inversion is turned on.
+   *
+   * @platform ios
+   */
+  accessibilityIgnoresInvertColors?: boolean | undefined;
+  /**
+   * A value indicating whether VoiceOver should ignore the elements
+   * within views that are siblings of the receiver.
+   * Default is `false`.
+   *
+   * @platform ios
+   *
+   * See https://reactnative.dev/docs/view#accessibilityviewismodal
+   */
+  accessibilityViewIsModal?: boolean | undefined;
+  /**
+   * A Boolean value that indicates whether or not to show the item in the large content viewer.
+   * Available on iOS 13.0+
+   *
+   * @platform ios
+   *
+   * See https://reactnative.dev/docs/view#accessibilityshowslargecontentviewer
+   */
+  accessibilityShowsLargeContentViewer?: boolean | undefined;
+  /**
+   * When `accessibilityShowsLargeContentViewer` is set, this string will be used as title for the large content viewer.
+   *
+   * @platform ios
+   *
+   * See https://reactnative.dev/docs/view#accessibilitylargecontenttitle
+   */
+  accessibilityLargeContentTitle?: string | undefined;
+  /**
+   * The aria-modal attribute indicates content contained within a modal with aria-modal="true"
+   * should be accessible to the user.
+   * Default is `false`.
+   *
+   *  @platform ios
+   */
+  "aria-modal"?: boolean | undefined;
+  /**
+   * A value indicating whether the accessibility elements contained within
+   * this accessibility element are hidden.
+   *
+   * @platform ios
+   *
+   * See https://reactnative.dev/docs/view#accessibilityElementsHidden
+   */
+  accessibilityElementsHidden?: boolean | undefined;
+  /**
+   * Indicates to the accessibility services that the UI component is in
+   * a specific language. The provided string should be formatted following
+   * the BCP 47 specification (https://www.rfc-editor.org/info/bcp47).
+   *
+   * @platform ios
+   */
+  accessibilityLanguage?: string | undefined;
+  /**
+   * Blocks the user from interacting with the component through keyboard while still allowing
+   * screen reader to interact with it if this View is still accessible.
+   *
+   * @platform ios
+   */
+  accessibilityRespondsToUserInteraction?: boolean | undefined;
+}>;
+export type AccessibilityProps = Readonly<Omit<AccessibilityPropsAndroid, keyof AccessibilityPropsIOS | keyof {
+  /**
+   * When `true`, indicates that the view is an accessibility element.
+   * By default, all the touchable elements are accessible.
+   *
+   * See https://reactnative.dev/docs/view#accessible
+   */
+  accessible?: boolean | undefined;
+  /**
+   * 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.
+   *
+   * See https://reactnative.dev/docs/view#accessibilitylabel
+   */
+  accessibilityLabel?: string | undefined;
+  /**
+   * An accessibility hint helps users understand what will happen when they perform
+   * an action on the accessibility element when that result is not obvious from the
+   * accessibility label.
+   *
+   *
+   * See https://reactnative.dev/docs/view#accessibilityHint
+   */
+  accessibilityHint?: string | undefined;
+  /**
+   * Alias for accessibilityLabel  https://reactnative.dev/docs/view#accessibilitylabel
+   * https://github.com/facebook/react-native/issues/34424
+   */
+  "aria-label"?: string | undefined;
+  /**
+   * Indicates to accessibility services to treat UI component like a specific role.
+   */
+  accessibilityRole?: AccessibilityRole | undefined;
+  /**
+   * Alias for accessibilityRole
+   */
+  role?: Role | undefined;
+  /**
+   * Indicates to accessibility services that UI Component is in a specific State.
+   */
+  accessibilityState?: AccessibilityState | undefined;
+  accessibilityValue?: AccessibilityValue | undefined;
+  /**
+   * alias for accessibilityState
+   * It represents textual description of a component's value, or for range-based components, such as sliders and progress bars.
+   */
+  "aria-valuemax"?: AccessibilityValue["max"] | undefined;
+  "aria-valuemin"?: AccessibilityValue["min"] | undefined;
+  "aria-valuenow"?: AccessibilityValue["now"] | undefined;
+  "aria-valuetext"?: AccessibilityValue["text"] | undefined;
+  /**
+   * Provides an array of custom actions available for accessibility.
+   *
+   */
+  accessibilityActions?: ReadonlyArray<AccessibilityActionInfo> | undefined;
+  /**
+   * alias for accessibilityState
+   *
+   * see https://reactnative.dev/docs/accessibility#accessibilitystate
+   */
+  "aria-busy"?: boolean | undefined;
+  "aria-checked"?: (boolean | undefined) | "mixed" | undefined;
+  "aria-disabled"?: boolean | undefined;
+  "aria-expanded"?: boolean | undefined;
+  "aria-selected"?: boolean | undefined;
+  /** A value indicating whether the accessibility elements contained within
+   * this accessibility element are hidden.
+   *
+   * See https://reactnative.dev/docs/view#aria-hidden
+   */
+  "aria-hidden"?: boolean | undefined;
+}> & Omit<AccessibilityPropsIOS, keyof {
+  /**
+   * When `true`, indicates that the view is an accessibility element.
+   * By default, all the touchable elements are accessible.
+   *
+   * See https://reactnative.dev/docs/view#accessible
+   */
+  accessible?: boolean | undefined;
+  /**
+   * 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.
+   *
+   * See https://reactnative.dev/docs/view#accessibilitylabel
+   */
+  accessibilityLabel?: string | undefined;
+  /**
+   * An accessibility hint helps users understand what will happen when they perform
+   * an action on the accessibility element when that result is not obvious from the
+   * accessibility label.
+   *
+   *
+   * See https://reactnative.dev/docs/view#accessibilityHint
+   */
+  accessibilityHint?: string | undefined;
+  /**
+   * Alias for accessibilityLabel  https://reactnative.dev/docs/view#accessibilitylabel
+   * https://github.com/facebook/react-native/issues/34424
+   */
+  "aria-label"?: string | undefined;
+  /**
+   * Indicates to accessibility services to treat UI component like a specific role.
+   */
+  accessibilityRole?: AccessibilityRole | undefined;
+  /**
+   * Alias for accessibilityRole
+   */
+  role?: Role | undefined;
+  /**
+   * Indicates to accessibility services that UI Component is in a specific State.
+   */
+  accessibilityState?: AccessibilityState | undefined;
+  accessibilityValue?: AccessibilityValue | undefined;
+  /**
+   * alias for accessibilityState
+   * It represents textual description of a component's value, or for range-based components, such as sliders and progress bars.
+   */
+  "aria-valuemax"?: AccessibilityValue["max"] | undefined;
+  "aria-valuemin"?: AccessibilityValue["min"] | undefined;
+  "aria-valuenow"?: AccessibilityValue["now"] | undefined;
+  "aria-valuetext"?: AccessibilityValue["text"] | undefined;
+  /**
+   * Provides an array of custom actions available for accessibility.
+   *
+   */
+  accessibilityActions?: ReadonlyArray<AccessibilityActionInfo> | undefined;
+  /**
+   * alias for accessibilityState
+   *
+   * see https://reactnative.dev/docs/accessibility#accessibilitystate
+   */
+  "aria-busy"?: boolean | undefined;
+  "aria-checked"?: (boolean | undefined) | "mixed" | undefined;
+  "aria-disabled"?: boolean | undefined;
+  "aria-expanded"?: boolean | undefined;
+  "aria-selected"?: boolean | undefined;
+  /** A value indicating whether the accessibility elements contained within
+   * this accessibility element are hidden.
+   *
+   * See https://reactnative.dev/docs/view#aria-hidden
+   */
+  "aria-hidden"?: boolean | undefined;
+}> & {
+  /**
+   * When `true`, indicates that the view is an accessibility element.
+   * By default, all the touchable elements are accessible.
+   *
+   * See https://reactnative.dev/docs/view#accessible
+   */
+  accessible?: boolean | undefined;
+  /**
+   * 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.
+   *
+   * See https://reactnative.dev/docs/view#accessibilitylabel
+   */
+  accessibilityLabel?: string | undefined;
+  /**
+   * An accessibility hint helps users understand what will happen when they perform
+   * an action on the accessibility element when that result is not obvious from the
+   * accessibility label.
+   *
+   *
+   * See https://reactnative.dev/docs/view#accessibilityHint
+   */
+  accessibilityHint?: string | undefined;
+  /**
+   * Alias for accessibilityLabel  https://reactnative.dev/docs/view#accessibilitylabel
+   * https://github.com/facebook/react-native/issues/34424
+   */
+  "aria-label"?: string | undefined;
+  /**
+   * Indicates to accessibility services to treat UI component like a specific role.
+   */
+  accessibilityRole?: AccessibilityRole | undefined;
+  /**
+   * Alias for accessibilityRole
+   */
+  role?: Role | undefined;
+  /**
+   * Indicates to accessibility services that UI Component is in a specific State.
+   */
+  accessibilityState?: AccessibilityState | undefined;
+  accessibilityValue?: AccessibilityValue | undefined;
+  /**
+   * alias for accessibilityState
+   * It represents textual description of a component's value, or for range-based components, such as sliders and progress bars.
+   */
+  "aria-valuemax"?: AccessibilityValue["max"] | undefined;
+  "aria-valuemin"?: AccessibilityValue["min"] | undefined;
+  "aria-valuenow"?: AccessibilityValue["now"] | undefined;
+  "aria-valuetext"?: AccessibilityValue["text"] | undefined;
+  /**
+   * Provides an array of custom actions available for accessibility.
+   *
+   */
+  accessibilityActions?: ReadonlyArray<AccessibilityActionInfo> | undefined;
+  /**
+   * alias for accessibilityState
+   *
+   * see https://reactnative.dev/docs/accessibility#accessibilitystate
+   */
+  "aria-busy"?: boolean | undefined;
+  "aria-checked"?: (boolean | undefined) | "mixed" | undefined;
+  "aria-disabled"?: boolean | undefined;
+  "aria-expanded"?: boolean | undefined;
+  "aria-selected"?: boolean | undefined;
+  /** A value indicating whether the accessibility elements contained within
+   * this accessibility element are hidden.
+   *
+   * See https://reactnative.dev/docs/view#aria-hidden
+   */
+  "aria-hidden"?: boolean | undefined;
+}>;

package/types_generated/Libraries/Components/View/ViewNativeComponent.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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<<dab8cbb7e40855b5de6080b289b33b15>>
+ *
+ * This file was translated from Flow by scripts/js-api/build-types/index.js.
+ * Original file: packages/react-native/Libraries/Components/View/ViewNativeComponent.js
+ */
+
+import * as React from "react";
+import type { HostComponent } from "../../../src/private/types/HostComponent";
+import type { HostInstance } from "../../../src/private/types/HostInstance";
+import { type ViewProps as Props } from "./ViewPropTypes";
+declare const ViewNativeComponent: HostComponent<Props>;
+interface NativeCommands {
+  readonly focus: (viewRef: HostInstance) => void;
+  readonly blur: (viewRef: HostInstance) => void;
+  readonly hotspotUpdate: (viewRef: HostInstance, x: number, y: number) => void;
+  readonly setPressed: (viewRef: HostInstance, pressed: boolean) => void;
+  readonly setDestinations: (viewRef: React.ComponentRef<HostComponent<unknown>>, destinations: Array<number>) => void;
+  readonly requestTVFocus: (viewRef: React.ComponentRef<HostComponent<unknown>>) => void;
+}
+export declare const Commands: NativeCommands;
+export declare type Commands = typeof Commands;
+/**
+ * `ViewNativeComponent` is an internal React Native host component, and is
+ * exported to provide lower-level access for libraries.
+ *
+ * @warning `<unstable_NativeView>` provides no semver guarantees and is not
+ *   intended to be used in app code. Please use
+ *   [`<View>`](https://reactnative.dev/docs/view) instead.
+ */
+declare const $$ViewNativeComponent: typeof ViewNativeComponent;
+declare type $$ViewNativeComponent = typeof $$ViewNativeComponent;
+export default $$ViewNativeComponent;