mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Nick Gerleman
8cdc9e7f04
Summary: React Native's TS definitions are currently mostly stored in one monolithic file. This change splits the definitions up to correspond to the source files they came from, and are placed next to the source files. I think this should help inform, and make it easy to update the TS declarations when touching the Flow file. I noticed as part of the change that the typings have not yet removed many APIs that were removed from RN. This is bad, since it means using the removed/non-functional API doesn't cause typechecker errors. Locating typings next to source should prevent that from being able to happen. The organization here means individual TS declarations can declare what will be in the RN entrypoint, which is a little confusing. Seems like a good potential next refactor, beyond the literal translation I did. Changelog: [General][Changed] - Place TS Declarations Alongside Source Files Reviewed By: lunaleaps, rshest Differential Revision: D39796598 fbshipit-source-id: b36366466fd1976bdd2d4c8f7a4104a33c457a07
112 lines
2.9 KiB
TypeScript
112 lines
2.9 KiB
TypeScript
/**
|
|
* 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.
|
|
*
|
|
* @format
|
|
*/
|
|
|
|
import type * as React from 'react';
|
|
import {Constructor} from 'Utilities';
|
|
import {NativeMethods} from '../../Renderer/shims/ReactNativeTypes';
|
|
import {ColorValue, StyleProp} from '../../StyleSheet/StyleSheet';
|
|
import {ViewStyle} from '../../StyleSheet/StyleSheetTypes';
|
|
import {ViewProps} from '../View/ViewPropTypes';
|
|
|
|
export interface SwitchPropsIOS extends ViewProps {
|
|
/**
|
|
* Background color when the switch is turned on.
|
|
*
|
|
* @deprecated use trackColor instead
|
|
*/
|
|
onTintColor?: ColorValue | undefined;
|
|
|
|
/**
|
|
* Color of the foreground switch grip.
|
|
*
|
|
* @deprecated use thumbColor instead
|
|
*/
|
|
thumbTintColor?: ColorValue | undefined;
|
|
|
|
/**
|
|
* Background color when the switch is turned off.
|
|
*
|
|
* @deprecated use trackColor instead
|
|
*/
|
|
tintColor?: ColorValue | undefined;
|
|
}
|
|
|
|
export interface SwitchChangeEvent extends React.SyntheticEvent {
|
|
value: boolean;
|
|
}
|
|
|
|
export interface SwitchProps extends SwitchPropsIOS {
|
|
/**
|
|
* Color of the foreground switch grip.
|
|
*/
|
|
thumbColor?: ColorValue | undefined;
|
|
|
|
/**
|
|
* Custom colors for the switch track
|
|
*
|
|
* Color when false and color when true
|
|
*/
|
|
trackColor?:
|
|
| {
|
|
false?: ColorValue | null | undefined;
|
|
true?: ColorValue | null | undefined;
|
|
}
|
|
| undefined;
|
|
|
|
/**
|
|
* If true the user won't be able to toggle the switch.
|
|
* Default value is false.
|
|
*/
|
|
disabled?: boolean | undefined;
|
|
|
|
/**
|
|
* Invoked with the the change event as an argument when the value changes.
|
|
*/
|
|
onChange?:
|
|
| ((event: SwitchChangeEvent) => Promise<void> | void)
|
|
| null
|
|
| undefined;
|
|
|
|
/**
|
|
* Invoked with the new value when the value changes.
|
|
*/
|
|
onValueChange?: ((value: boolean) => Promise<void> | void) | null | undefined;
|
|
|
|
/**
|
|
* Used to locate this view in end-to-end tests.
|
|
*/
|
|
testID?: string | undefined;
|
|
|
|
/**
|
|
* The value of the switch. If true the switch will be turned on.
|
|
* Default value is false.
|
|
*/
|
|
value?: boolean | undefined;
|
|
|
|
/**
|
|
* On iOS, custom color for the background.
|
|
* Can be seen when the switch value is false or when the switch is disabled.
|
|
*/
|
|
ios_backgroundColor?: ColorValue | undefined;
|
|
|
|
style?: StyleProp<ViewStyle> | undefined;
|
|
}
|
|
|
|
/**
|
|
* Renders a boolean input.
|
|
*
|
|
* This is a controlled component that requires an `onValueChange` callback that
|
|
* updates the `value` prop in order for the component to reflect user actions.
|
|
* If the `value` prop is not updated, the component will continue to render
|
|
* the supplied `value` prop instead of the expected result of any user actions.
|
|
*/
|
|
declare class SwitchComponent extends React.Component<SwitchProps> {}
|
|
declare const SwitchBase: Constructor<NativeMethods> & typeof SwitchComponent;
|
|
export class Switch extends SwitchBase {}
|