react-native/src/private/components/switch/specs/SwitchNativeComponent.js

A framework for building native apps using React

/**
 * 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.
 *
 * @flow strict-local
 * @format
 */

import type {ViewProps} from '../../../../../Libraries/Components/View/ViewPropTypes';
import type {ColorValue} from '../../../../../Libraries/StyleSheet/StyleSheet';
import type {
  BubblingEventHandler,
  Int32,
  WithDefault,
} from '../../../../../Libraries/Types/CodegenTypes';
import type {HostComponent} from '../../../types/HostComponent';

import codegenNativeCommands from '../../../../../Libraries/Utilities/codegenNativeCommands';
import codegenNativeComponent from '../../../../../Libraries/Utilities/codegenNativeComponent';
import * as React from 'react';

type NativeSwitchChangeEvent = Readonly<{
  value: boolean,
  target: Int32,
}>;

type SwitchNativeProps = Readonly<{
  ...ViewProps,

  // Props
  disabled?: WithDefault<boolean, false>,
  value?: WithDefault<boolean, false>,
  tintColor?: ?ColorValue,
  onTintColor?: ?ColorValue,
  thumbTintColor?: ?ColorValue,

  // Deprecated props
  thumbColor?: ?ColorValue,
  trackColorForFalse?: ?ColorValue,
  trackColorForTrue?: ?ColorValue,

  // Events
  onChange?: ?BubblingEventHandler<NativeSwitchChangeEvent>,
}>;

type ComponentType = HostComponent<SwitchNativeProps>;

interface NativeCommands {
  readonly setValue: (
    viewRef: React.ElementRef<ComponentType>,
    value: boolean,
  ) => void;
}

export const Commands: NativeCommands = codegenNativeCommands<NativeCommands>({
  supportedCommands: ['setValue'],
});

export default codegenNativeComponent<SwitchNativeProps>('Switch', {
  // @testing-library/react-native (as of 13.3.3) only recognizes a host
  // component named `RCTSwitch` as a switch, so renaming this breaks every
  // `*ByRole('switch')` query and `toBeChecked()` assertion in Jest.
  paperComponentName: 'RCTSwitch',
  excludedPlatforms: ['android'],
  interfaceOnly: true,
}) as ComponentType;